SublimeLinter plugin for Dockerfile, using dockerfilelint.
- Total 8K
- Win 3K
- Mac 3K
- Linux 2K
|May 28||May 27||May 26||May 25||May 24||May 23||May 22||May 21||May 20||May 19||May 18||May 17||May 16||May 15||May 14||May 13||May 12||May 11||May 10||May 9||May 8||May 7||May 6||May 5||May 4||May 3||May 2||May 1||Apr 30||Apr 29||Apr 28||Apr 27||Apr 26||Apr 25||Apr 24||Apr 23||Apr 22||Apr 21||Apr 20||Apr 19||Apr 18||Apr 17||Apr 16||Apr 15||Apr 14||Apr 13|
This linter plugin for SublimeLinter provides an interface to dockerfilelint. It will be used with files that have the “Dockerfile” syntax.
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.
Before installing this plugin, you must ensure that
dockerfilelint is installed on your system. To install
dockerfilelint, do the following:
npm install -g dockerfilelint@">=1.4.0"
- If you are using
zsh, ensure that the line to load
.zshrc.(reason: here and here)
Note: This plugin requires
dockerfilelint 1.4.0 or later.
In order for
dockerfilelint 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.
dockerfilelint is installed and configured, you can proceed to install the SublimeLinter-contrib-dockerfilelint 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
dockerfilelint. Among the entries you should see
SublimeLinter-contrib-dockerfilelint. If that entry is not highlighted, use the keyboard or mouse to select it.
For general information on how SublimeLinter works with settings, please see Settings. For information on generic linter settings, please see Linter Settings.
You can configure
dockerfilelint options in the way you would from the command line, with
.dockerfilelintrc file. For more information, see the dockerfilelint configuring section. The linter plugin does this by searching for a
.dockerfilelintrc file itself, just as
dockerfilelint does from the command line.
The path to the
.dockerfilelintrc file is cached, meaning if you create a new
.dockerfilelintrc that should have precedence over the previous one. You need to clear the cache for the linter to use the new
.dockerfilelintrc. 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 modications 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!