norcalli / Linter

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Linter

Lint your code with ease in Atom.

linter-jscs

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

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

Commons 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-ruby, for ruby, using ruby -wc.
  • linter-rst, for reStructuredText, using docutils.
  • linter-pyflakes, for python, using pyflakes.
  • linter-phplint, for PHP, using phplint.
  • linter-pep8, for python, using pep8.
  • linter-lua, for Lua, using luac -p.
  • linter-jsxhint, for JSX (React.js), using jsxhint.
  • linter-jsl, for JavaScript, using jsl.
  • linter-oclitnt, for C / C++ / Objective-C, using OCLint.
  • linter-clang, for C / C++, using clang.

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

Share the love! donate-paypal

About

License:MIT License