idanpa / vscode-checkpatch

Visual Studio Code extension for using linux kernel checkpatch tool to lint code.

Checkpatch Lint

Visual Studio Code extension for using linux kernel checkpatch tool to lint code.

Installation

checkpatch.pl script should be either exposed through $PATH or pointed out by the checkpatch.checkpatchPath configuration.

Linux / WSL Remote Development

sudo wget -O /usr/bin/checkpatch.pl "https://raw.githubusercontent.com/torvalds/linux/master/scripts/checkpatch.pl"
sudo wget -O /usr/bin/spelling.txt "https://raw.githubusercontent.com/torvalds/linux/master/scripts/spelling.txt"
sudo chmod 755 /usr/bin/checkpatch.pl

Windows

cmd as administrator:

curl -o %WINDIR%/System32/checkpatch.pl "https://raw.githubusercontent.com/torvalds/linux/master/scripts/checkpatch.pl"
curl -o %WINDIR%/System32/spelling.txt "https://raw.githubusercontent.com/torvalds/linux/master/scripts/spelling.txt"

On windows, a perl interpreter should also be installed - tested with ActivePerl Community Edition.
*.pl files should be configured to be opened by the interpreter by default (double click on any *.pl file and choose ActivePerl as the default program). GNU 'diff' executable should also be available (can be done by installing git-for-windows and adding it to PATH).

Commands

• checkpatch.checkFile Check selected file (if the run mode is manual)
• checkpatch.checkCommit Select specific commit to be tested
• checkpatch.toggleAutoRun Toggle automatic checkpatch for the current workspace

Settings

• checkpatch.checkpatchPath Path to the checkpatch.pl script
• checkpatch.checkpatchArgs checkpatch arguments to use
• checkpatch.run Control whether the linting is automatic on save or manually triggered using the checkpatch.checkFile command.
• checkpatch.exclude Glob patterns for excluding files and folders from automatic checks.
• checkpatch.diagnosticLevel Diagnostic level of checkpatch errors.

vscode-checkpatch's Issues

No output from checkpatch plugin on problems pane

Hi @idanpa ,

Thank you for making this plugin available for us.

After finishing the installation and invoking the plugin on a open C source file, no output seen on the editor (problems pane).

I got it working after disabling/enabling it several times.

Closing and opening again vscode causes the same issue again.

I'm not sure if there is a specific requirement to get it working.

Thanks
Maro

.checkpatch.conf support

Hi,

Can you please add ".checkpatch.conf" support?

.checkpatch.conf is placed at the root directory of a project and checkpatch.pl detects it for various configurations.
Example: https://github.com/openil/u-boot/blob/master/.checkpatch.conf

Basically it requires the checkpatch.pl to be executed when CWD is the project directory.

Is it still alive? Some advantages are needed.

Hi, @idanpa and thank you for the extension!

So, long story short, I need this to have some additional features:

• support log parsing when there --showfile option is passed to the checkpatch
• support a possibility to define a particular cwd for multiroot workspaces to make checkpatch use a config from specific workspace

I'm not a person who familiar with js, ts or vscode-extensions creation. But I can provide a pull-request where I'll try to do my best to implement these features. It may violate typical codestyle or common sense for ts, though.

Now, some details.

The idea behind the first feature is to implement an alternative parseCheckpatchLog() function (or addition to it) which may handle a different output from checkpatch. For comparison:

WARNING:LINUX_VERSION_CODE: LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged
#124: FILE: mac.c:124:
+#if KERNEL_VERSION(5, 8, 1) <= LINUX_VERSION_CODE

- this style of logs is supported for now.

mac.c:124: WARNING:LINUX_VERSION_CODE: LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged
+#if KERNEL_VERSION(5, 8, 1) <= LINUX_VERSION_CODE

- This style I want to be supported (here --showfile option was passed to checkpatch).

About second feature. I think it would be good to define some option that a user can define inside settings.json of a particular workspace, and then extension should use this workspace as cwd, but not the root. I don't know if this possible or some other approach should be choosen. Of course this related to the Checkpatch Selected File feature.

I need some feedback for it from you,
Cheers.

Please consider publishing to https://open-vsx.org/

Hi,

While large parts of VS Code are developed as open source, the actual product is not open source.
There are many actual open source projects that support VS Code extensions, but only Microsoft products can use and connect to Microsoft’s Extension Marketplace. The terms of use for the Marketplace prevent any non-Visual Studio products from accessing it.

It would be great if this project were to be published at https://open-vsx.org/, an open source extension registry at the Eclipse Foundation, a vendor-neutral organization.

You can read more at https://www.eclipse.org/community/eclipse_newsletter/2020/march/1.php

Thanks for the extension!