# SublimeLinter-contrib-iverilog [![Package Control](https://img.shields.io/packagecontrol/dt/SublimeLinter-contrib-iverilog?style=flat-square)](https://packagecontrol.io/packages/SublimeLinter-contrib-iverilog) [![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/jfcherng-sublime/SublimeLinter-contrib-iverilog?style=flat-square&logo=github)](https://github.com/jfcherng-sublime/SublimeLinter-contrib-iverilog/tags) [![Project license](https://img.shields.io/github/license/jfcherng-sublime/SublimeLinter-contrib-iverilog?style=flat-square&logo=github)](https://github.com/jfcherng-sublime/SublimeLinter-contrib-iverilog/blob/master/LICENSE) [![GitHub stars](https://img.shields.io/github/stars/jfcherng-sublime/SublimeLinter-contrib-iverilog?style=flat-square&logo=github)](https://github.com/jfcherng-sublime/SublimeLinter-contrib-iverilog/stargazers) [![Donate to this project using Paypal](https://img.shields.io/badge/paypal-donate-blue.svg?style=flat-square&logo=paypal)](https://www.paypal.me/jfcherng/5usd) This linter plugin for [SublimeLinter](https://sublimelinter.readthedocs.org) provides an interface to [iverilog](http://iverilog.wikia.com/wiki/Main_Page) into Sublime Text. To make this plugin work, you need to have `iverilog` installed. This plugin will be activated with files that have the `Verilog` syntax. By the way, you may also try - [LSP-VHDL-ls](https://packagecontrol.io/packages/LSP-VHDL-ls) - [Verilator Linter](https://packagecontrol.io/packages/SublimeLinter-contrib-verilator) These packages above should beat this one. 🙂 ## Installation SublimeLinter must be installed in order to use this plugin. If SublimeLinter is not installed, please follow the instructions [here](https://sublimelinter.readthedocs.org/en/latest/installation.html). Verilog/SystemVerilog syntax highlight is not natively supplied by Sublime Text. You may install [Sublime Text Verilog](https://packagecontrol.io/packages/Verilog) or [Sublime Text SystemVerilog](https://packagecontrol.io/packages/SystemVerilog) to do the job. ### Linter installation - iverilog >= 0.9 Before installing this plugin, you must ensure that `iverilog` is installed on your system. To install `iverilog`, please see [this](https://iverilog.wikia.com/wiki/Installation_Guide). ### Plugin installation Please use [Package Control](https://packagecontrol.io/installation) to install the linter plugin. This will ensure that the plugin will be updated when new versions are available. If you want to install from source so you can modify the source code, you probably know what you are doing so we won't cover that here. To install via Package Control, do the following: 1. Within Sublime Text, bring up the `Command Palette` by Ctrl + Shift + P and type `install`. Among the commands you should see `Package Control: Install Package`. If that command is not highlighted, use the keyboard or mouse to select it. There will be a pause of a few seconds while Package Control fetches the list of available plugins. 1. When the plugin list appears, type `iverilog`. Among the entries you should see `SublimeLinter-contrib-iverilog`. If that entry is not highlighted, use the keyboard or mouse to select it. ## Settings For general information on how SublimeLinter works with settings, please see [Settings](https://sublimelinter.readthedocs.org/en/latest/settings.html). For information on generic linter settings, please see [Linter Settings](https://sublimelinter.readthedocs.org/en/latest/linter_settings.html). ## Demo ![linting_example](https://raw.githubusercontent.com/jfcherng-sublime/SublimeLinter-contrib-iverilog/gh-pages/images/linting_example.png) ## Solving `Unknown module type: XXX` There is actually [`-i` flag](https://github.com/steveicarus/iverilog/pull/151) with the `master` branch of `iverilog` to ignore this kind of error messages. To test whether your `iverilog` supports it, use the `$ iverilog -i` command to see whether it says `iverilog: invalid option -- 'i'`. If your `iverilog` has no `-i` flag and you wish to use it, continue the following steps. - If you are on Windows, 1. Just download and install [the latest Windows v11 x64 dev build](http://bleyer.org/icarus/). - If you are on Ubuntu, 1. Download and execute the [ubuntu-compile-iverilog-mater.sh](https://raw.githubusercontent.com/jfcherng-sublime/SublimeLinter-contrib-iverilog/master/ubuntu-compile-iverilog-mater.sh) from this package. ```bash curl -sSL "https://raw.githubusercontent.com/jfcherng-sublime/SublimeLinter-contrib-iverilog/master/ubuntu-compile-iverilog-mater.sh" | bash ``` 1. If there is no error, the `master` branch `iverilog` should have been installed to `/usr/local/iverilog`. - If you use neither Windows nor Ubuntu, 1. It should be easy to modify `ubuntu-compile-iverilog-mater.sh` to fit your OS. After `iverilog` has been installed, 1. Update SublimeLinter's PATH in SublimeLinter's settings file. ```js "paths": { "linux": [ "/usr/local/iverilog/bin", ], "osx": [], "windows": [ "C:\\iverilog\\bin", ], }, ``` 1. Pass the `-i` flag to the linter by modifying SublimeLinter's settings file. ```js "linters": { "iverilog": { "disable": false, "args": ["-i"], // add the "-i" flag "excludes": [], }, }, ``` 1. The `Unknown module type: XXX` problem should have been solved (ignored). ## Contributing If you would like to contribute enhancements or fixes, please do the following: 1. Fork the plugin repository. 1. Hack on a separate topic branch created from the latest `master`. 1. Commit and push the topic branch. 1. Make a pull request. 1. Be patient. Please note that modifications should follow these coding guidelines: - Indent is 4 spaces. - Code should pass flake8 and pep257 linters. - Probably format codes with [black](https://github.com/psf/black) code formatter. - Vertical whitespace helps readability, don’t be afraid to use it. - Please use descriptive variable names, no abbreviations unless they are very well known. Thank you for helping out!