Skip to content

Latest commit

 

History

History
173 lines (122 loc) · 8.34 KB

README.md

File metadata and controls

173 lines (122 loc) · 8.34 KB

Linter

Gitter Build Status

Lint your code with ease in Atom.

atom-inline-messages

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

for JavaScript

for CoffeeScript

for Typescript

for Dart

for LiveScript

for Ruby and Ruby on Rails

for PHP

for Python

for Java

for CSS / SASS / SCSS / LESS

for XML

for Bash

for Scala

for C / C++

for Lua

for Clojure

for Puppet

for Yaml

for Haskell

for HTML / Bootstrap

for Squirrel

for CoDScript

for harbour

for Rust

for Elixir

for Erlang

for ActionScript/Flash/Flex/AIR

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 highlighting [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
  • Show error inline [On / Off] - Shows the error or warning message next to the code as opposed to in the status bar.
  • Lint on change interval [in ms] - Interval between two lints while you are writing code

Common errors

  • npm ERR! code ENOGIT - You need to install git before installing linter. See #114.
  • env: node: No such file or directory – There's a problem with your node path – check this.
  • spawn ENOENT or spawn ENOTDIR - A linter can't find a path to the executable. Try starting Atom from a shell via atom to make sure it gets your PATH. See also #102, #150.

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

Share the love!

donate-paypal

Donate Bitcoins<script src="https://www.coinbase.com/assets/button.js" type="text/javascript"></script>