https://github.com/zhutmost/vscode-svlint

https://github.com/zhutmost/vscode-svlint

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zhutmost/vscode-svlint
• Owner: zhutmost
• License: mit
• Created: 2023-07-18T08:27:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-07-18T13:23:40.000Z (over 1 year ago)
• Last Synced: 2024-04-29T02:18:35.318Z (7 months ago)
• Language: TypeScript
• Size: 312 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
 SystemVerilog Linter in VSCode 



**Lint your SystemVerilog on the fly!**





## Installation & Setup

### Requirements

- [svlint](https://github.com/dalance/svlint), an open-sourced linter for SystemVerilog, must be installed in your `PATH` environment variable.

- Custom your linting rule file `.svlint.toml`, and put it to the repository root or set a environment variable `SVLINT_CONFIG`.

*Important:* If no configuration is found, the default behavior is to enable all rules, which is certain to show failures because some rules conflict, e.g. `keyword_forbidden_generate` and `keyword_required_generate`.

An example rule file is provided on my GitHub Gist ([link](https://gist.githubusercontent.com/zhutmost/ee489d0a0b9322743bcfbfd5d85662a4/raw/.svlint.toml)). You can save this file as `/path/to/your/repo/.svlint.toml`.

### Configurations

By default, the linter `svlint` is invoked as follows:

```shell

svlint -1 $file

```

where `$file` is the RTL file currently opened in the editor.

You can edit `svlint.linters.svlint.command` in your VSCode setting file `settings.json`:

```js

"svlint.linters": {

    "svlint": {

        "command": [ "svlint", "-1", "$file" ],

        ...

    }

}

```

For example, if you want to force `svlint` to use `abc.toml` as its configuration file, you can:

```js

"svlint.linters": {

    "svlint": {

        "command": [ "svlint", "-1", "--config", "/path/to/abc.toml", "$file" ],

        ...

    }

}

```

For more `svlint` usage, please `svlint --help` in your command line, or read [its maunal](https://github.com/dalance/svlint/blob/master/MANUAL.md).

Note that not all the `svlint` options are supported by this extension. Only the options listed below are allowed.

```log

svlint v0.8.0 rev:b9010664 rustc:1.70.0 built:2023-06-26T09:53:23

USAGE:

    svlint [OPTIONS] [--] [FILES]...

OPTIONS:

    -c, --config 

            TOML configuration file [default: .svlint.toml]

    -d, --define 

            Define

    -f, --filelist 

            File list

    -i, --include 

            Include directory path

        --ignore-include

            Ignore any include

    -p, --plugin 

            Plugin file

```

## Inspiration & Contribution

If you find any bugs or have any ideas, please feel free to [open an issue](https://github.com/zhutmost/vscode-svlint/issues).

This extension is powered by [@dalance/svlint](https://github.com/dalance/svlint), [@fnando/vscode-linter](https://github.com/fnando/vscode-linter) and many other open-source projects.

Thanks for their excellent jobs.