New CLI subcommand to create clang-compatible compilation database (compile_commands.json)

[baodrate]

Description

Updating @xton's PR #10264, which adds a CLI command to generate a Clang Compilation Database file, for use with language servers, linters, and other tooling. No major changes other than addressing merge conflicts.

I changed the subcommand name, as was requested in the review for the previous PR, but to generate-compilation-database instead of generate-compile-commands as @skullydazed suggested. This seems more aligned with how the file is referred to in compatible tools' documentation. But I can change this if needed.

Types of Changes

• Core
• Bugfix
• New feature
• Enhancement/optimization
• Keyboard (addition or update)
• Keymap/layout/userspace (addition or update)
• Documentation

Issues Fixed or Closed by This PR

• Fixes YouCompleteMe support for auto completion #4855

Checklist

• My code follows the code style of this project: C, Python
• I have read the PR Checklist document and have made the appropriate changes.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• I have tested the changes and verified that they work and don't break anything (as well as I can manage).

[tzarc]

Any time I try to execute it gives this error, regardless of the parameters:

☒ Could not determine keyboard!
☒ You must supply both `--keyboard` and `--keymap`, or be in a directory for a keyboard or keymap.

You'll also need to remove the debugging statements when printing out loading of modules.

[baodrate]

Any time I try to execute it gives this error, regardless of the parameters

Hmm, I have those settings saved to my config so I didn't notice that. I'll figure it out

You'll also need to remove the debugging statements when printing out loading of modules

agh I didn't realize I committed those print statements. that's embarrassing 😅

[baodrate]

Fixed the issue. I missed the config parameters when I renamed the subcommand, so they weren't being parsed correctly.

Also added error handling for the case where no commands were generated (e.g. you specified a non-existent keymap) and some minor improvements (instead of checking checking exit status or calling which ... ourselves, delegate it to Popen/shutil, respectively)

[baodrate]

Now using cli.run() instead of subprocess.Popen(). It now waits for the command to complete before parsing the output from make but there's relatively little output so the impact to overall run time is negligible.

We will still likely need to fix the system_libs() function to give reasonable output for windows environments. I literally never use windows so I'll have to do some research to figure out what that will look like.

[AWare]

Just a quick note of thanks, this PR has helped me make vscode a lot happier about qmk 👏

[Diaoul]

Trying to use this I still have a few issues in vscode in keymaps after generating the database:

Unknown type name 'uint16_t' (fix available) clang(unknown_typename)

and

Expected ';' after top level declarator (fix available) clang(invalid_token_after_toplevel_declarator)

Do I need specific clangd options or anything I am missing? Compiling an flashing work fine though 🤔

Example from keyboards/splitkb/kyria/keymaps/default: