SublimeLinter-contrib-tslint

This linter plugin for SublimeLinter provides an interface to tslint. It will be used with files that have the “typescript” syntax.

Installation

SublimeLinter 3 must be installed in order to use this plugin. If SublimeLinter 3 is not installed, please follow the instructions here.

Linter installation

Before installing this plugin, you must ensure that tslint is installed on your system. To install tslint, do the following:

1. Install Node.js (and npm on Linux).

2. Install tslint by typing the following in a terminal:

   npm install -g tslint
   

3. If you are using nvm and zsh, ensure that the line to load nvm is in .zshenv and not .zshrc.

Note: This plugin requires tslint 2.4.0 or later.

Linter configuration

In order for tslint 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.

Once you have installed and configured tslint, you can proceed to install the SublimeLinter-contrib-tslint plugin if it is not yet installed.

Plugin installation

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:

1. 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.

2. When the plugin list appears, type tslint. Among the entries you should see SublimeLinter-contrib-tslint. 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. For information on generic linter settings, please see Linter Settings. Also you should provide tslint.json file somewhere in your project directory.

You can configure tslint options in the way you would from the command line, with tslint.json files. For more information, see the tslint docs. The linter plugin does this by searching for a tslint.json file itself, just as tslint does from the command line. You may provide a custom config file by setting the linter’s "args" setting to ["--config", "/path/to/file"]. On Windows, be sure to double the backslashes in the path, for example ["--config", "C:\\Users\\Aparajita\\tslint.json"].

Alternatively, you can set the config_filename option to just the name of the configuration file in order to avoid defining absolute paths.

    "linters": {
        "tslint": {
            "@disable": false,
            "args": [],
            "excludes": [
                "**/node_modules/**"
            ],
            "config_filename": "tslint.json"
        }
    }

Also, remember to set your project tsconfig.json accordingly, so that it includes paths used by SublimeLinter working copies. For example:

    "include": [
        "/var/folders/**/*.tsx",
        "/var/folders/**/*.ts",
        "./src/**/*.tsx",
        "./src/**/*.ts"
    ],

Contributing

If you would like to contribute enhancements or fixes, please do the following:

1. Fork the plugin repository.
2. Hack on a separate topic branch created from the latest master.
3. Commit and push the topic branch.
4. Make a pull request.
5. 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.
• Please use descriptive variable names, no abbrevations unless they are very well known.

Thank you for helping out!