Skip to content

Commit 3aceaa9

Browse files
committed
prep for SL4
1 parent 778bbce commit 3aceaa9

File tree

3 files changed

+20
-55
lines changed

3 files changed

+20
-55
lines changed

README.md

Lines changed: 11 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
11
SublimeLinter-bandit
22
====================
33

4-
[![Build Status](https://travis-ci.org/SublimeLinter/SublimeLinter-bandit.svg?branch=master)](https://travis-ci.org/SublimeLinter/SublimeLinter-bandit)
5-
6-
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.
4+
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.
75

86
## Installation
9-
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here][installation].
7+
SublimeLinter 3 must be installed in order to use this plugin.
8+
9+
Please use [Package Control](https://packagecontrol.io) to install the linter plugin.
1010

11-
### Linter installation
12-
Before using this plugin, you must ensure that `bandit` is installed on your system. To install `bandit`, do the following:
11+
Before using this plugin, you must ensure that `bandit` (1.3.0 or later) is installed on your system:
1312

1413
1. Install [Python](http://python.org/download/) and [pip](http://www.pip-installer.org/en/latest/installing.html).
1514

@@ -19,56 +18,14 @@ Before using this plugin, you must ensure that `bandit` is installed on your sys
1918
```
2019

2120

22-
**Note:** This plugin requires `bandit` 1.3.0 or later.
23-
24-
### Linter configuration
25-
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.
26-
27-
Once you have installed and configured `bandit`, you can proceed to install the SublimeLinter-bandit plugin if it is not yet installed.
28-
29-
### Plugin installation
30-
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.
31-
32-
To install via Package Control, do the following:
33-
34-
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.
21+
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).
3522

36-
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.
3723

3824
## Settings
39-
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].
40-
41-
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].
42-
43-
|Setting|Description|Inline Setting|Inline Override|
44-
|:------|:----------|:------------:|:-------------:|
45-
|@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.|✓| |
46-
|tests|comma-separated list of test IDs to run| |✓|
47-
|skips|comma-separated list of test IDs to skip| |✓|
48-
49-
## Contributing
50-
If you would like to contribute enhancements or fixes, please do the following:
51-
52-
1. Fork the plugin repository.
53-
1. Hack on a separate topic branch created from the latest `master`.
54-
1. Commit and push the topic branch.
55-
1. Make a pull request.
56-
1. Be patient. ;-)
57-
58-
Please note that modifications should follow these coding guidelines:
59-
60-
- Indent is 4 spaces.
61-
- Code should pass flake8 and pep257 linters.
62-
- Vertical whitespace helps readability, don’t be afraid to use it.
63-
- Please use descriptive variable names, no abbreviations unless they are very well known.
25+
- SublimeLinter settings: http://sublimelinter.readthedocs.org/en/latest/settings.html
26+
- Linter settings: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html
6427

65-
Thank you for helping out!
28+
Additional settings for `bandit`:
6629

67-
[docs]: http://sublimelinter.readthedocs.org
68-
[installation]: http://sublimelinter.readthedocs.org/en/latest/installation.html
69-
[locating-executables]: http://sublimelinter.readthedocs.org/en/latest/usage.html#how-linter-executables-are-located
70-
[pc]: https://sublime.wbond.net/installation
71-
[cmd]: http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html
72-
[settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html
73-
[linter-settings]: http://sublimelinter.readthedocs.org/en/latest/linter_settings.html
74-
[inline-settings]: http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-settings
30+
- `tests`: comma-separated list of test IDs to run
31+
- `skips`: comma-separated list of test IDs to skip

messages.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
{
2-
"install": "messages/install.txt"
2+
"install": "messages/install.txt",
3+
"1.0.1": "messages/1.0.1.txt"
34
}

messages/1.0.1.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
SublimeLinter-bandit
2+
--------------------
3+
4+
Inline settings will be deprecated in SublimeLinter 4. Please use bandit's
5+
configuration features of instead.
6+
7+
https://github.com/SublimeLinter/SublimeLinter3/blob/next/messages/4.0.0-rc.1.txt

0 commit comments

Comments
 (0)