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

baodrate · 2021-09-10T04:12:18Z

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

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).

…t large

tzarc · 2021-09-10T05:08:35Z

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 · 2021-09-10T13:55:20Z

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 · 2021-09-10T16:02:30Z

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)

lib/python/qmk/cli/generate/compilation_database.py

baodrate · 2021-09-10T21:27:46Z

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 · 2021-09-14T19:56:59Z

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

…compile_commands.json`) (qmk#14370) * pulled source from dev branch * missed a file from origin * formatting * revised argument names. relaxed matching rules to work for avr too * add docstrings * added docs. tightened up regex * remove unused imports * cleaning up command file. use existing qmk dir constant * rename parser library file * move lib functions into command file. there are only 2 and they aren't large * currently debugging... * more robustly find config * updated docs * remove unused imports * reuse make executable from the main make command * pulled source from dev branch * missed a file from origin * formatting * revised argument names. relaxed matching rules to work for avr too * add docstrings * added docs. tightened up regex * remove unused imports * cleaning up command file. use existing qmk dir constant * rename parser library file * move lib functions into command file. there are only 2 and they aren't large * currently debugging... * more robustly find config * updated docs * remove unused imports * reuse make executable from the main make command * remove MAKEFLAGS from environment for better control over process management * Update .gitignore Co-authored-by: Michael Forster <forster@google.com> * add a usage line to docs * doc change as suggested Co-authored-by: Nick Brassel <nick@tzarc.org> * rename command * remove debug print statements * generate-compilation-database: fix arg handling * generate-comilation-db: improve error handling * use cli.run() instead of Popen() Co-authored-by: Xton <cdewan@apple.com> Co-authored-by: Christon DeWan <cmdpix@mac.com> Co-authored-by: Michael Forster <forster@google.com> Co-authored-by: Nick Brassel <nick@tzarc.org>

Diaoul · 2024-01-01T12:23:27Z

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:

…compile_commands.json`) (qmk#14370) * pulled source from dev branch * missed a file from origin * formatting * revised argument names. relaxed matching rules to work for avr too * add docstrings * added docs. tightened up regex * remove unused imports * cleaning up command file. use existing qmk dir constant * rename parser library file * move lib functions into command file. there are only 2 and they aren't large * currently debugging... * more robustly find config * updated docs * remove unused imports * reuse make executable from the main make command * pulled source from dev branch * missed a file from origin * formatting * revised argument names. relaxed matching rules to work for avr too * add docstrings * added docs. tightened up regex * remove unused imports * cleaning up command file. use existing qmk dir constant * rename parser library file * move lib functions into command file. there are only 2 and they aren't large * currently debugging... * more robustly find config * updated docs * remove unused imports * reuse make executable from the main make command * remove MAKEFLAGS from environment for better control over process management * Update .gitignore Co-authored-by: Michael Forster <forster@google.com> * add a usage line to docs * doc change as suggested Co-authored-by: Nick Brassel <nick@tzarc.org> * rename command * remove debug print statements * generate-compilation-database: fix arg handling * generate-comilation-db: improve error handling * use cli.run() instead of Popen() Co-authored-by: Xton <cdewan@apple.com> Co-authored-by: Christon DeWan <cmdpix@mac.com> Co-authored-by: Michael Forster <forster@google.com> Co-authored-by: Nick Brassel <nick@tzarc.org>

user78552 · 2024-11-24T16:49:20Z

@Diaoul Hi, did you manage to solve this problem?

Diaoul · 2025-03-24T09:26:15Z

No, I gave up.

Xton added 30 commits May 9, 2020 13:51

pulled source from dev branch

47365ae

missed a file from origin

e0bff4d

formatting

5a51eaa

revised argument names. relaxed matching rules to work for avr too

d817b7d

add docstrings

30b564f

added docs. tightened up regex

849a12f

remove unused imports

b671c40

cleaning up command file. use existing qmk dir constant

f42cadc

rename parser library file

e768fac

move lib functions into command file. there are only 2 and they aren'…

21c5b63

…t large

currently debugging...

3fe7817

more robustly find config

ec3739b

updated docs

bf2aef2

remove unused imports

10171f8

reuse make executable from the main make command

697ca67

pulled source from dev branch

82a8be3

missed a file from origin

3a95195

formatting

3ed55aa

revised argument names. relaxed matching rules to work for avr too

c9a4d97

add docstrings

9226ba5

added docs. tightened up regex

764f35d

remove unused imports

b0a5e1a

cleaning up command file. use existing qmk dir constant

67c08c6

rename parser library file

c0fc66e

move lib functions into command file. there are only 2 and they aren'…

2f103f5

…t large

currently debugging...

c03da56

more robustly find config

8db4e13

updated docs

67ae7d8

remove unused imports

976b0b1

reuse make executable from the main make command

7ab3465

github-actions bot added keyboard keymap python translation labels Sep 10, 2021

zvecr changed the base branch from master to develop September 10, 2021 04:35

Merge branch 'develop' into compile_commands

ecffaa4

github-actions bot removed keyboard core translation CI keymap labels Sep 10, 2021

baodrate added 3 commits September 10, 2021 09:18

remove debug print statements

42014f0

generate-compilation-database: fix arg handling

d8d0f25

generate-comilation-db: improve error handling

7df7b9e

skullydazed reviewed Sep 10, 2021

View reviewed changes

lib/python/qmk/cli/generate/compilation_database.py Outdated Show resolved Hide resolved

use cli.run() instead of Popen()

66e090d

drashna requested a review from a team September 16, 2021 03:28

tzarc approved these changes Sep 16, 2021

View reviewed changes

tzarc requested a review from skullydazed September 16, 2021 04:59

tzarc merged commit 590b405 into qmk:develop Sep 16, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

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

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

Uh oh!

baodrate commented Sep 10, 2021

Uh oh!

tzarc commented Sep 10, 2021 •

edited

Loading

Uh oh!

baodrate commented Sep 10, 2021

Uh oh!

baodrate commented Sep 10, 2021

Uh oh!

Uh oh!

baodrate commented Sep 10, 2021

Uh oh!

AWare commented Sep 14, 2021

Uh oh!

Diaoul commented Jan 1, 2024 •

edited

Loading

Uh oh!

user78552 commented Nov 24, 2024

Uh oh!

Diaoul commented Mar 24, 2025

Uh oh!

Uh oh!

Uh oh!

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

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

Uh oh!

Conversation

baodrate commented Sep 10, 2021

Description

Types of Changes

Issues Fixed or Closed by This PR

Checklist

Uh oh!

tzarc commented Sep 10, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

baodrate commented Sep 10, 2021

Uh oh!

baodrate commented Sep 10, 2021

Uh oh!

Uh oh!

baodrate commented Sep 10, 2021

Uh oh!

AWare commented Sep 14, 2021

Uh oh!

Diaoul commented Jan 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

user78552 commented Nov 24, 2024

Uh oh!

Diaoul commented Mar 24, 2025

Uh oh!

Uh oh!

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

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

tzarc commented Sep 10, 2021 •

edited

Loading

Diaoul commented Jan 1, 2024 •

edited

Loading