Can we export `compile_commands.json`?

[tan-wei]

It is convenient for me to use cquery with compile_commands.json. It works quiet well for most of the c++ projects.

• For CMake project, we can easily use CMAKE_EXPORT_COMPILE_COMMANDS option to export compile_commands.json
• For Makefile project, compiledb can be used to generate a compile_commands.json

So can we export compile_commands.json when using SCons? Thank you very much!

[acmorrow]

Hey -

Yes, this would be a great feature to have in mainline SCons. Meanwhile, In the MongoDB source code, we implemented our own site_tool to do it. It is (unlike most of the rest of that codebase) Apache 2 licensed:

• Py3 version: https://github.com/mongodb/mongo/blob/master/site_scons/site_tools/compilation_db.py
• Py2 version: https://github.com/mongodb/mongo/blob/v4.0/site_scons/site_tools/compilation_db.py

Relevant snippets to demonstrate usage:

• Installing the tool: https://github.com/mongodb/mongo/blob/master/SConstruct#L3628-L3630
• Invoking the tool: https://github.com/mongodb/mongo/blob/master/SConstruct#L3768-L3769

The implementation could probably use some cleanup, but maybe it is close enough that we could work on getting it upstreamed someday?

[tan-wei]

Great!
Looking forward to using this feature in the future.

[mwichmann]

If you close this, how does it get taken care of? Instead maybe rebrand it as a feature request?

[tan-wei]

If you close this, how does it get taken care of? Instead maybe rebrand it as a feature request?

OK. I reopen this issue. After the feature is finished, then I close it. :-P
Thanks for your advice.

[mwichmann]

Bill doesn't favor bugs which did not have discussion on the mailing list, you might want to post a note there. Personally I have never heard of this compilation-database stuff, so it might be good to explain the benefits (and how they might fit into scons).

[tan-wei]

I'm sorry I haven't read the mailing list yet. Next time before I ask a question, I should search what I want in mailing list first.

For the background about compilation database, this page describes in detail. It comes from clang. So the cquery, which is based on clang, uses compile_commands.json to generate compilation database. It's a C/C++ language server, which can be used on many platforms and editors.
As this page describes, most of the build system can generate compile_commands.json, so it's convenience for editors which installed cquery if we can easily get the file.
For build system itself, it is not hard to export the file. If SCons can do this, I think it will benefit many people who use cquery.

[bdbaddog]

I'm sorry I haven't read the mailing list yet. Next time before I ask a question, I should search what I want in mailing list first.

For the background about compilation database, this page describes in detail. It comes from clang. So the cquery, which is based on clang, uses compile_commands.json to generate compilation database. It's a C/C++ language server, which can be used on many platforms and editors.
As this page describes, most of the build system can generate compile_commands.json, so it's convenience for editors which installed cquery if we can easily get the file.
For build system itself, it is not hard to export the file. If SCons can do this, I think it will benefit many people who use cquery.

Did you not see the request in the bug template that you bring your issue there first? (Or is that not working?)

[tan-wei]

I'm sorry I haven't read the mailing list yet. Next time before I ask a question, I should search what I want in mailing list first.
For the background about compilation database, this page describes in detail. It comes from clang. So the cquery, which is based on clang, uses compile_commands.json to generate compilation database. It's a C/C++ language server, which can be used on many platforms and editors.
As this page describes, most of the build system can generate compile_commands.json, so it's convenience for editors which installed cquery if we can easily get the file.
For build system itself, it is not hard to export the file. If SCons can do this, I think it will benefit many people who use cquery.

Did you not see the request in the bug template that you bring your issue there first? (Or is that not working?)

I'm sorry, but I didn't see the contents because I accidentally erased them when I entered the issue on my mobile phone. So how should we deal with this issue? Sorry again for the trouble.
Hope you have a nice day.

[bdbaddog]

I'll mark it an enhancement.
If you need it now, I'd suggest you try the code @acmorrow pointed to.

[tan-wei]

I'll mark it an enhancement.
If you need it now, I'd suggest you try the code @acmorrow pointed to.

Thanks very much. Hope you have a good day.

[RevoluPowered]

We are working on Godot and are interested in getting this supported.

We're speaking about scons at GodotCon and would really appreciate a discussion to implement this in the future.

Can you please let us know if someone at scons could assist us?

Thanks