Repository files navigation

This linter plugin forSublimeLinterprovides an interface toiverilog into Sublime Text.To make this plugin work, you need to haveiverilog installed.This plugin will be activated with files that have theVerilog syntax.

By the way, you may also try

• LSP-VHDL-ls
• Verilator Linter

These packages above should beat this one. 🙂

SublimeLinter must be installed in order to use this plugin.If SublimeLinter is not installed, please follow the instructionshere.

Verilog/SystemVerilog syntax highlight is not natively supplied by Sublime Text.You may installSublime Text VerilogorSublime Text SystemVerilog to do the job.

• iverilog >= 0.9

Before installing this plugin, you must ensure thativerilog is installed on your system.To installiverilog, please seethis.

Please usePackage Control 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 theCommand Palette byCtrl + Shift + P and typeinstall.Among the commands you should seePackage 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.

2. When the plugin list appears, typeiverilog. Among the entries you should seeSublimeLinter-contrib-iverilog.If that entry is not highlighted, use the keyboard or mouse to select it.

For general information on how SublimeLinter works with settings, please seeSettings.For information on generic linter settings, please seeLinter Settings.

There is actually-i flagwith themaster branch ofiverilog to ignore this kind of error messages.

To test whether youriverilog supports it,use the$ iverilog -i command to see whether it saysiverilog: invalid option -- 'i'.If youriverilog has no-i flag and you wish to use it, continue the following steps.

• If you are on Windows,

  1. Just download and installthe latest Windows v11 x64 dev build.

• If you are on Ubuntu,

  1. Download and execute theubuntu-compile-iverilog-mater.sh from this package.

     curl -sSL"https://raw.githubusercontent.com/jfcherng-sublime/SublimeLinter-contrib-iverilog/master/ubuntu-compile-iverilog-mater.sh"| bash

  2. If there is no error, themaster branchiverilog should have been installed to/usr/local/iverilog.

• If you use neither Windows nor Ubuntu,

  1. It should be easy to modifyubuntu-compile-iverilog-mater.sh to fit your OS.

Afteriverilog has been installed,

1. Update SublimeLinter's PATH in SublimeLinter's settings file.

   "paths":{"linux":["/usr/local/iverilog/bin",],"osx":[],"windows":["C:\\iverilog\\bin",],},

2. Pass the-i flag to the linter by modifying SublimeLinter's settings file.

   "linters":{"iverilog":{"disable":false,"args":["-i"],// add the "-i" flag"excludes":[],},},

3. TheUnknown module type: XXX problem should have been solved (ignored).

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latestmaster.
3. Commit and push the topic branch.
4. Make a pull request.
5. 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 withblack 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!