From 3aceaa91f4c735101883af4d80e3d6a3f0d2c62a Mon Sep 17 00:00:00 2001 From: Koen Lageveen Date: Wed, 27 Dec 2017 16:34:55 +0100 Subject: [PATCH] prep for SL4 --- README.md | 65 ++++++++-------------------------------------- messages.json | 3 ++- messages/1.0.1.txt | 7 +++++ 3 files changed, 20 insertions(+), 55 deletions(-) create mode 100644 messages/1.0.1.txt diff --git a/README.md b/README.md index 2e40e0d..cccd417 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,14 @@ SublimeLinter-bandit ==================== -[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-bandit.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-bandit) - -This linter plugin for [SublimeLinter][docs] provides an interface to [bandit](https://wiki.openstack.org/wiki/Security/Projects/Bandit). It will be used with files that have the “python” syntax. +This linter plugin for [SublimeLinter](http://sublimelinter.readthedocs.org) provides an interface to [bandit](https://wiki.openstack.org/wiki/Security/Projects/Bandit). It will be used with files that have the “python” syntax. ## Installation -SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][installation]. +SublimeLinter 3 must be installed in order to use this plugin. + +Please use [Package Control](https://packagecontrol.io) to install the linter plugin. -### Linter installation -Before using this plugin, you must ensure that `bandit` is installed on your system. To install `bandit`, do the following: +Before using this plugin, you must ensure that `bandit` (1.3.0 or later) is installed on your system: 1. Install [Python](http://python.org/download/) and [pip](http://www.pip-installer.org/en/latest/installing.html). @@ -19,56 +18,14 @@ Before using this plugin, you must ensure that `bandit` is installed on your sys ``` -**Note:** This plugin requires `bandit` 1.3.0 or later. - -### Linter configuration -In order for `bandit` 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”](http://sublimelinter.readthedocs.org/en/latest/troubleshooting.html#finding-a-linter-executable) through “Validating your PATH” in the documentation. - -Once you have installed and configured `bandit`, you can proceed to install the SublimeLinter-bandit plugin if it is not yet installed. - -### Plugin installation -Please use [Package Control][pc] 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][cmd] 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. +In order for `bandit` to be executed by SublimeLinter, you must ensure that its path is available to SublimeLinter. The docs cover [troubleshooting PATH configuration](http://sublimelinter.readthedocs.io/en/latest/troubleshooting.html#finding-a-linter-executable). -1. When the plugin list appears, type `bandit`. Among the entries you should see `SublimeLinter-bandit`. 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][settings]. For information on generic linter settings, please see [Linter Settings][linter-settings]. - -In addition to the standard SublimeLinter settings, SublimeLinter-bandit provides its own settings. Those marked as “Inline Setting” or “Inline Override” may also be [used inline][inline-settings]. - -|Setting|Description|Inline Setting|Inline Override| -|:------|:----------|:------------:|:-------------:| -|@python|A meta setting that indicates the python version of your source files. Use this inline or at the global level, not within the linter’s settings.|✓| | -|tests|comma-separated list of test IDs to run| |✓| -|skips|comma-separated list of test IDs to skip| |✓| - -## 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. -- Vertical whitespace helps readability, don’t be afraid to use it. -- Please use descriptive variable names, no abbreviations unless they are very well known. +- SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html +- Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html -Thank you for helping out! +Additional settings for `bandit`: -[docs]: http://sublimelinter.readthedocs.org -[installation]: http://sublimelinter.readthedocs.org/en/latest/installation.html -[locating-executables]: http://sublimelinter.readthedocs.org/en/latest/usage.html#how-linter-executables-are-located -[pc]: https://sublime.wbond.net/installation -[cmd]: http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html -[settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html -[linter-settings]: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html -[inline-settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-settings +- `tests`: comma-separated list of test IDs to run +- `skips`: comma-separated list of test IDs to skip diff --git a/messages.json b/messages.json index ef56f9e..51a2c2c 100644 --- a/messages.json +++ b/messages.json @@ -1,3 +1,4 @@ { - "install": "messages/install.txt" + "install": "messages/install.txt", + "1.0.1": "messages/1.0.1.txt" } diff --git a/messages/1.0.1.txt b/messages/1.0.1.txt new file mode 100644 index 0000000..3827567 --- /dev/null +++ b/messages/1.0.1.txt @@ -0,0 +1,7 @@ +SublimeLinter-bandit +-------------------- + +Inline settings will be deprecated in SublimeLinter 4. Please use bandit's +configuration features of instead. + +https://github.com/SublimeLinter/SublimeLinter3/blob/next/messages/4.0.0-rc.1.txt