replace vera++ with clang-tidy as our linter

rock-core / vscode-rock

VSCode extension for Rock integration

MIT License

1 stars 1 forks source link

replace vera++ with clang-tidy as our linter #74

Closed g-arjones closed 4 years ago

g-arjones commented 4 years ago

So, this is a proof-of-concept of what I am proposing... @doudou Could you please test and let me know what you think? You need clang-tidy AND clang (the compiler itself) installed.

TODO:

[ ] Tune default linter checks (i.e: naming conventions)
[ ] Ignore build tree while looking for source files
[ ] Load clang-tidy config from a file specified in an env var or through a setting
[ ] Fix/write unit tests
[ ] Remove vera++ and add clang-tidy in rock.vscode-package_set

coveralls commented 4 years ago

Pull Request Test Coverage Report for Build 136

10 of 43 (23.26%) changed or added relevant lines in 1 file are covered.
31 unchanged lines in 2 files lost coverage.
Overall coverage decreased (-4.0%) to 75.404%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/linter.ts	10	43	23.26%
<!--	Total:	10	43	23.26%	-->

Files with Coverage Reduction	New Missed Lines	%
src/watcher.ts	1	97.06%
src/linter.ts	30	30.16%
<!--	Total:	31	-->

Totals
Change from base Build 132:	-4.0%
Covered Lines:	1098
Relevant Lines:	1444

💛 - Coveralls

g-arjones commented 4 years ago

Writing custom checks: https://blog.audio-tk.com/2018/03/20/writing-custom-checks-for-clang-tidy/ Examples (with tests): https://github.com/microsoft/clang-tools-extra/tree/master/clang-tidy Official docs about custom checks: https://clang.llvm.org/extra/clang-tidy/Contributing.html

doudou commented 4 years ago

Will do. Thanks for this.

I won't have time to do it this week unfortunately, big deadline and my (unforeseen) migration to 20.04 destroyed whatever extra time I had budgeted.

For the config file, I quite like the way it works with rubocop, which allows to fine-tune style in specific legacy packages. A.k.a. looking for config files recursively.

g-arjones commented 4 years ago

No problem... Just let me know once you do

g-arjones commented 4 years ago

@doudou Feel free to reopen if there's still interest and you have the time to finish the work. I am a bit overwhelmed so I'm closing stuff I'm unlikely to finish myself. Sorry.