Skip to content
This repository has been archived by the owner on Aug 7, 2023. It is now read-only.

Latest commit

 

History

History
52 lines (37 loc) · 1.75 KB

README.md

File metadata and controls

52 lines (37 loc) · 1.75 KB
Raw

linter-tslint

This linter plugin for AtomLinter provides an interface to tslint. It will be used with files that have the "TypeScript" syntax.

Installation

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

tslint installation

Before using 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 0.4.8 or later.

Now you can proceed to install the linter-tslint plugin.

Plugin installation

$ apm install linter-tslint

Settings

You can configure linter-tslint by editing ~/.atom/config.cson (choose Open Your Config in Atom menu):

'linter-tslint':
  'tslintExecutablePath': null #tslint path. run 'which tslint' to find the path

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. welcome to the club

Please note that modications should follow these coding guidelines:

  • Indent is 2 spaces.
  • Code should pass coffeelint linter.
  • Vertical whitespace helps readability, don’t be afraid to use it.

Thank you for helping out!