You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+9-37
Original file line number
Diff line number
Diff line change
@@ -6,10 +6,12 @@ SublimeLinter-csslint
6
6
This linter plugin for [SublimeLinter](http://sublimelinter.readthedocs.org) provides an interface to [csslint](https://github.com/stubbornella/csslint/wiki). It will be used with files that have the “CSS” syntax, or within `<style>` tags in HTML files.
7
7
8
8
## Installation
9
-
SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions [here](http://sublimelinter.readthedocs.org/en/latest/installation.html).
10
9
11
-
### Linter installation
12
-
Before installing this plugin, you must ensure that `csslint` is installed on your system. To install `csslint`, do the following:
10
+
SublimeLinter must be installed in order to use this plugin.
11
+
12
+
Please use [Package Control](https://packagecontrol.io) to install the linter plugin.
13
+
14
+
Before installing this plugin, you must ensure that `csslint` (version 0.10.0 or later) is installed on your system. To install `csslint`, do the following:
13
15
14
16
1. Install [Node.js](http://nodejs.org) (and [npm](https://github.com/joyent/node/wiki/Installing-Node.js-via-package-manager) on Linux).
15
17
@@ -20,26 +22,13 @@ Before installing this plugin, you must ensure that `csslint` is installed on yo
20
22
21
23
1. If you are using `nvm` and `zsh`, ensure that the line to load `nvm` is in `.zshenv` and not `.zshrc`.
22
24
23
-
**Note:** This plugin requires `csslint` 0.10.0 or later.
24
-
25
-
### Linter configuration
26
-
In order for `csslint` 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.
27
-
28
-
Once `csslint` is installed and configured, you can proceed to install the SublimeLinter-csslint plugin if it is not yet installed.
29
-
30
-
### Plugin installation
31
-
Please use [Package Control](https://sublime.wbond.net/installation) 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.
32
-
33
-
To install via Package Control, do the following:
34
-
35
-
1. Within Sublime Text, bring up the [Command Palette](http://docs.sublimetext.info/en/sublime-text-3/extensibility/command_palette.html) 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.
36
-
37
-
1. When the plugin list appears, type `csslint`. Among the entries you should see `SublimeLinter-csslint`. If that entry is not highlighted, use the keyboard or mouse to select it.
25
+
In order for `csslint` 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).
38
26
39
27
## Settings
40
-
For general information on how SublimeLinter works with settings, please see [Settings](http://sublimelinter.readthedocs.org/en/latest/settings.html). For information on generic linter settings, please see [Linter Settings](http://sublimelinter.readthedocs.org/en/latest/linter_settings.html).
In addition to the standard SublimeLinter settings, SublimeLinter-csslint provides its own settings which correspond to the command line options of the same name. All of them may be used as [inline overrides](http://sublimelinter.readthedocs.org/en/latest/settings.html#inline-overrides).
31
+
Additional SublimeLinter-csslint settings:
43
32
44
33
|Setting|Description|
45
34
|:------|:----------|
@@ -50,20 +39,3 @@ In addition to the standard SublimeLinter settings, SublimeLinter-csslint provid
50
39
To get a list of the available rule names, execute `csslint --list-rules` from a terminal.
51
40
52
41
You may also use any of the `csslint` configuration options, including `.csslintrc` files and embedded rules. Please see the [csslint documentation](https://github.com/stubbornella/csslint/wiki/Command-line-interface#configuration-files) for more information.
53
-
54
-
## Contributing
55
-
If you would like to contribute enhancements or fixes, please do the following:
56
-
57
-
1. Fork the plugin repository.
58
-
1. Hack on a separate topic branch created from the latest `master`.
59
-
1. Commit and push the topic branch.
60
-
1. Make a pull request.
61
-
1. Be patient. ;-)
62
-
63
-
Please note that modications should follow these coding guidelines:
64
-
65
-
- Indent is 4 spaces.
66
-
- Code should pass csslint and pep257 linters.
67
-
- Vertical whitespace helps readability, don’t be afraid to use it.
0 commit comments