eslint-config-qx
ESLint shareable config for Qooxdoo
This depends on eslint-plugins-qx-rules
Install
$ npm install --save-dev eslint-config-qx
For the esnext
version you'll also need Babel's ESLint parser and plugin:
$ npm install --save-dev babel-eslint eslint-plugin-babel
This will let you use ES2016 features like async
/await
and decorators. For a full list of features see Babel's experimental features and their Learn ES2015.
Install in a existing Qooxdoo Project
package.json
If you don't have a Create a new file package.json
with the following contents in your project:
Replace name, description and author ofc.
package.json
If you have a Add these lines to it:
Adjust your .gitingore
Add .eslintcache
to it.
eslint
and eslint-config-qx
Now install $ npm install
And finaly lint your files
$ npm run eslint -- .
Or lint AND fix:
$ npm run eslint -- --fix .
Handling globals
Normaly your app has its own globals, like qxl
for Qooxdoo Contribs,
for that you need to extend qx/browser
with your own config.
Create a file .eslintrc-qx
:
This file tells eslint to ignore qxl
but don't allow writes to it.
Now you need to tell eslint about it in package.json
:
Thats all.
.eslintignore
Ignore compiled stuff in ESLint has its own .eslintignore
file, when you run npm run eslint .
it will lint
all JS files found including generated ones, to exclude them you can create a
.eslintignore
and files/directories to it like in .gitignore
.
This is mine:
build/
gh-pages/
node_modules/
source/script/
source/resource/
# No need for lint
Gruntfile.js
Usage
Supports parsing ES2015, but doesn't enforce it by default.
This package also exposes qx/esnext
if you want ES2015+ rules:
And qx/browser
if you're in the browser:
If you want only check for safety-errors then extend qx/safety:
Authors
- Original XO Author: Sindre Sorhus
- Changes for Qooxdoo by: René Jochum
License
MIT