Linter

Lint your code with ease in Atom.

The idea is to stop the linter plugins war, by providing a top level API for linters to parse and display errors in the Atom editor.

Available linters

• linter-php, for PHP using php -l
• linter-phpcs, for PHP, using phpc
• linter-phpmd, for PHP, using phpmd
• linter-pylint, for Python, using pylint
• linter-pyflakes, for python, using pyflakes.
• linter-pep8, for python, using pep8.
• linter-javac, for Java, using javac
• linter-jshint, for JavaScript and JSON, using jshint
• linter-jscs, for JavaScript, using jscs
• linter-scss-lint, for SASS/SCSS, using scss-lint
• linter-coffeelint, for CoffeeScript, using coffeelint
• linter-csslint, for CSS, using csslint
• linter-rubocop, for Ruby and Ruby on Rails, using rubocop
• linter-tslint, for Typescript, using tslint
• linter-xmllint, for XML, using xmllint
• linter-shellcheck, for Bash, using shellcheck.
• linter-scalac, for Scala, using scalac.
• linter-clang, for C / C++, using clang.
• linter-ruby, for ruby, using ruby -wc.
• linter-lua, for Lua, using luac -p.

Features

• Lint on edit – Instant error reporting for you! (And it's fast!)
• Modular – You install only the linters you need.
• Active – New linters are out every week.

Installation

1. $ apm install linter – Install the main package.
2. $ apm install linter-jshint – Install the linter you need, here jshint.

Configuration

• Lint on save [On / Off] - Lint the file when you save it
• Lint on change [On / Off] - Lint the file as you type
• Show hightlighting [On / Off] - Highlight the range of wrong code
• Show gutters: [On / Off] - Show dot in the gutter on line error
• Show messages around cursor [On / Off] - Show error description in the status bar
• Show status bar when cursor is in error range [On / Off] - Either show status bar when the cursor is on the error line, or show it when the cursor is focus the range of wrong code
• Lint on change interval [in ms] - Interval between two lints while you are writing code

Common errors

• env: node: No such file or directory – There's a problem with your node path – check this.

Documentation

http://atomlinter.github.io/Linter/

Coming soon

• linter-pep257, for python, using pep257.
• linter-rst, for reStructuredText, using docutils.
• linter-phplint, for PHP, using phplint.
• linter-jsxhint, for JSX (React.js), using jsxhint.
• linter-jsl, for JavaScript, using jsl.
• linter-oclitnt, for C / C++ / Objective-C, using OCLint.

Contributing

If you're going to submit a pull request, please try to follow the official contribution guidelines of Atom.

You need nodejs and grunt-cli installed before contributing. Run bower install node then npm install -g grunt-cli.

Also, run $ grunt dev before any submission and while developing, it will achieves severals tasks:

• Compile and lint the CoffeeScript files
• Lint the stylesheets
• Lint any trailing spaces and ensure new line at end of file

You can generate the doc with $ grunt doc, it will open in your default browser.

Donation