SublimeLinter plugin for Pug (formerly Jade), using pug-lint
- Total 25K
- Win 18K
- Mac 5K
- Linux 3K
|Sep 19||Sep 18||Sep 17||Sep 16||Sep 15||Sep 14||Sep 13||Sep 12||Sep 11||Sep 10||Sep 9||Sep 8||Sep 7||Sep 6||Sep 5||Sep 4||Sep 3||Sep 2||Sep 1||Aug 31||Aug 30||Aug 29||Aug 28||Aug 27||Aug 26||Aug 25||Aug 24||Aug 23||Aug 22||Aug 21||Aug 20||Aug 19||Aug 18||Aug 17||Aug 16||Aug 15||Aug 14||Aug 13||Aug 12||Aug 11||Aug 10||Aug 9||Aug 8||Aug 7||Aug 6||Aug 5|
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before using this plugin, you must ensure that
pug-lint is installed on your system. To install
pug-lint, do the following:
npm install -g pug-lint
Note: This plugin requires
pug-lint 2.1.1 or later.
In order for
pug-lint to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. Before going any further, please read and follow the steps in “Finding a linter executable” through “Validating your PATH” in the documentation.
Once you have installed and configured
pug-lint, you can proceed to install the SublimeLinter-contrib-pug-lint plugin if it is not yet installed.
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:
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.
When the plugin list appears, type
pug-lint. Among the entries you should see
SublimeLinter-contrib-pug-lint. If that entry is not highlighted, use the keyboard or mouse to select it.
You can configure pug-lint options in the way you would from the command line, with
.pug-lintrc files. For more information, see the pug-lint docs. The linter plugin does this by searching for a
.pug-lintrc file in your stylus file’s current directory tree. If you are an OSX / Linux user, you can also set a global
.pug-lintrc in your User (
You may provide a custom config file by setting the linter’s
"args" setting to
["--config", "/path/to/file"]. On Windows, be sure to double the backslashes in the path, for example
The path to the
.pug-lintrc file is cached, meaning if you create a new .pug-lintrc that should have precedence over the previous one (meaning it is closer to the .pug file) you need to clear the cache for the linter to use the new
.pug-lintrc You can clear the cache by going to: Tools > SublimeLinter > Clear Caches.
If you would like to contribute enhancements or fixes, please do the following:
- Fork the plugin repository.
- Hack on a separate topic branch created from the latest
- Commit and push the topic branch.
- Make a pull request.
- 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.
- Please use descriptive variable names, no abbreviations unless they are very well known.
Thank you for helping out!