ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

Sublime​Linter-contrib-iverilog

by jfcherng ST3

This linter plugin for SublimeLinter provides an interface to iverilog (verilog compiler).

Details

Installs

  • Total 2K
  • Win 1K
  • OS X 353
  • Linux 387
Dec 13 Dec 12 Dec 11 Dec 10 Dec 9 Dec 8 Dec 7 Dec 6 Dec 5 Dec 4 Dec 3 Dec 2 Dec 1 Nov 30 Nov 29 Nov 28 Nov 27 Nov 26 Nov 25 Nov 24 Nov 23 Nov 22 Nov 21 Nov 20 Nov 19 Nov 18 Nov 17 Nov 16 Nov 15 Nov 14 Nov 13 Nov 12 Nov 11 Nov 10 Nov 9 Nov 8 Nov 7 Nov 6 Nov 5 Nov 4 Nov 3 Nov 2 Nov 1 Oct 31 Oct 30 Oct 29
Windows 1 3 0 1 1 3 0 2 1 2 2 3 2 6 1 2 0 2 0 3 2 1 3 1 1 3 2 5 0 3 1 0 0 1 4 1 0 2 4 2 4 4 2 0 1 1
OS X 1 0 0 0 0 0 0 1 2 1 1 0 1 0 0 0 0 0 0 1 0 0 2 0 1 2 1 0 0 1 1 1 1 1 3 0 0 0 0 1 0 2 0 0 0 0
Linux 1 0 0 0 0 0 2 0 1 0 0 0 0 2 0 2 1 0 0 2 2 0 0 3 0 1 1 2 1 6 0 0 0 0 0 1 0 0 0 0 0 0 0 0 0 3

Readme

Source
raw.​githubusercontent.​com

SublimeLinter-contrib-iverilog

This linter plugin for SublimeLinter provides an interface to iverilog 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.

Installation

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

Verilog syntax highlight is not natively supplied by Sublime Text. You may install Sublime Text Verilog to do the job.

Linter installation

Before installing this plugin, you must ensure that iverilog is installed on your system. To install iverilog, please see this.

Plugin installation

Please use Package 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 the Command Palette 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.

  2. 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. For information on generic linter settings, please see Linter Settings.

Demo

linting_example

Constraints

If your module references design(s) from other .v file(s), you must use include "module.v" to include them for this linting plugin.

For example, one of ways to do a simulation is iverilog module.v module_t.v -o a.out where module_t.v is a testbench file. This way does not use the include syntax in module_t.v but lists files in the command line. Therefore, you will see Unknown module type: module in module_t.v since this plugin only check the current file. To avoid this, you have to modify module_t.v to include module.v and use iverilog module_t.v -o a.out instead.

include_module_file

You may use “include guard” to prevent from module redefinition.

`ifndef _MODULE_
`define _MODULE_
    // your module design here
`endif

But honestly, this is pretty annoying and iverilog module.v module_t.v -o a.out is more sweet for scripts…

Contributing

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 latest master.
  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.
  • Vertical whitespace helps readability, don't be afraid to use it.

Thank you for helping out!

License

The MIT License (MIT)

Copyright © 2017 Jack Cherng

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Supporters

Thank you guys for sending me some cups of coffee.