Skip to content

Commit

Permalink
Prepare 2.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
bstoutenburgh committed Jul 29, 2018
1 parent 8f6efe8 commit 85fa488
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 2 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ SublimeLinter must be installed in order to use this plugin.

Please use [Package Control](https://packagecontrol.io) to install the linter plugin.

Before using this plugin, you must ensure that `bashate` is installed on your system. To install `bashate`, do the following:
Before using this plugin, you must ensure that `bashate` is installed on your system, and it is at least version 0.6.0. To install `bashate`, do the following:

1. For best performance, install [Python 3](http://python.org) and [pip](http://www.pip-installer.org/en/latest/installing.html).

Expand All @@ -32,3 +32,8 @@ Additional SublimeLinter-contrib-bashate settings:
|ignore|A comma-separated list of rules to ignore|
|warn|A comma-separated list of rules to always warn (rather than error)|
|error|A comma-separated list of rules to always error (rather than warn)|

## Known Issues
- As of release 2.0.0, version 0.6.0 of `bashate` is required. If you need to use a version prior to that release, use the 1.1.1 release of this linter.
- `bashate` 0.6.0 does not distinguish warnings from errors, so all hits will report as errors in SublimeLinter. This does in fact make the _warn_ setting useless. Follow the upstream problem at https://bugs.launchpad.net/bash8/+bug/1782960.
- `bashate` 0.6.0 reports all errors at column 1 and does not provide the offending line, so SublimeLinter will now highlight the first character or word of the offending line. Unless the upstream tool changes this behavior the options are to have that highlight or set the user setting _no_column_highlights_line_. Still persuing hacks but do not expect any.
3 changes: 2 additions & 1 deletion messages.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"install": "messages/install.txt",
"1.0.1": "messages/1.0.1.txt"
"1.0.1": "messages/1.0.1.txt",
"2.0.0": "messages/2.0.0.txt"
}
10 changes: 10 additions & 0 deletions messages/2.0.0.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
SublimeLinter-contrib-bashate 2.0.0
-----------------------------------

bashate 0.6.0 or above is now required as the output format has changed. Be sure to update your installations.


Known issues:
- bashate 0.6.0 does not distinguish warnings from errors, so all hits will report as errors in SublimeLinter. This does in fact make the warn setting useless. Follow the upstream problem at https://bugs.launchpad.net/bash8/+bug/1782960.

- bashate 0.6.0 reports all errors at column 1 and does not provide the offending line, so SublimeLinter will now highlight the first character or word of the offending line. Unless the upstream tool changes this behavior the options are to have that highlight or set the user setting "no_column_highlights_line". Still persuing hacks but do not expect any.

0 comments on commit 85fa488

Please sign in to comment.