If you write React code, consider including eslint-config-onelint-react
As of eslint version 3 node versions prior to 4.0.0 are no longer supported.
of this package still supports eslint v2.
Later branches require eslint 3.
To start using the linter in a project start by installing eslint and this module:
$ npm install --save-dev eslint eslint-config-onelint
Then add a eslint config file to your project, named
Now you can lint your files by running the following command in the root of your project.
$ eslint .
... or if eslint is not on your path:
$ ./node_modules/.bin/eslint .
For convenience, you can add it as a script in package.json's scripts section,
to make it available as
npm run lint.
Code like the following will break in es6 parser mode, but work just fine in es5:
It can be handled by setting the following options in
moduleexports =extends:'onelint'env:es6: falseparserOptions: null;
It's not always that it causes problems, so I'll not make the default es5 now. If it turns out to be a major problem, we could release an es5 version of this package too, with the above configuration extended on top.
The above fix is also necessary when you're code will not work in mode. ES6 modules are enabled in the parsing options, which implicitly enables strict mode. That will cause, among other things, cause octals to be considered invalid:
var someOctalValue = 0200;
Obviously, the goal is to deviate as little as possible from the presets given in this configuration. But sometimes your projects may have global variables that are specific to that particular project, or maybe large parts of legacy code that you don't want to rewrite.
Because onelint is shipping as a sharable eslint configuration, you can extend
it by adding new rules, overwriting rules or defining new globals in the
.eslintrc.js just as you would, if you used eslint exclusively.
See Configuring ESLint in the eslint docs.
Setting up eslint integration in your editor is all that is needed. You can find a guide most editor in the integrations section of the eslint user guide. Recommended settings for common editors can be found below.
The Atom editor plugin is called linter-eslint and is built on the AtomLinter framework. It is available directly in your editor, or in the package archives on atom.io.
Eslint is supported out of the box in Syntastic. Add this in your .vimrc to let Syntastic pick the right configuration for your project.
(Probably works for Sublime Text 2 as well...)