@qooxdoo/eslint-config-qx/README.md

ESLint shareable config for Qooxdoo

# eslint-config-qx

> ESLint [shareable config](http://eslint.org/docs/developer-guide/shareable-configs.html) for [Qooxdoo](http://www.qooxdoo.org)

This depends on [@qooxdoo/eslint-plugins-qx](https://github.com/qooxdoo/eslint-qx-plugins)


## Install

```
$ npm install --save-dev @qooxdoo/eslint-config-qx
```

For the `esnext` version you'll also need Babel's ESLint [parser](https://github.com/babel/babel-eslint) and [plugin](https://github.com/babel/eslint-plugin-babel):

```
$ npm install --save-dev babel-eslint eslint-plugin-babel
```

This will let you use ES2016 features like [`async`/`await`](https://github.com/lukehoban/ecmascript-asyncawait) and [decorators](https://github.com/wycats/javascript-decorators). For a full list of features see [Babel's experimental features](https://babeljs.io/docs/usage/experimental/) and their [Learn ES2015](https://babeljs.io/docs/learn-es2015/).


## Install in a existing Qooxdoo Project


### If you don't have a `package.json`

Create a new file `package.json` with the following contents in your project:

```json
{
  "name": "<appname>",
  "description": "<appdesc>",
  "author": "Your Name <your@email.com>",
  "version": "0.0.1",
  "license": "MIT",
  "dependencies": {},
  "devDependencies": {
    "@qooxdoo/eslint-config-qx": "^0.0.7"
  },
  "engine": "node >= 4.5",
  "eslintConfig": {
    "extends": [
      "qx"
    ]
  },
  "scripts": {
    "eslint": "eslint --cache"
  }
}
```

Replace name, description and author ofc.


### If you have a `package.json`

Add these lines to it:

```json
{
	"devDependencies": {
		"@qooxdoo/eslint-config-qx": "^0.0.7"
	},
	"eslintConfig": {
		"extends": [
			"@qooxdoo/eslint-config-qx/browser"
		]
	},
	"scripts": {
		"eslint": "eslint --cache"
	}
}
```


### Adjust your .gitingore

Add `.eslintcache` to it.


### Now install `eslint` and `eslint-config-qx`

```bash
$ npm install
```

### And finaly lint your files

```bash
$ 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 `@qooxdoo/eslint-config-qx/browser` with your own config.

Create a file `.eslintrc-qx`:

```json
{
  "globals": {
    "qxl": false
  }
}
```

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

```json
{
	"eslintConfig": {
		"extends": [
			"@qooxdoo/eslint-config-qx/browser"
			".eslintrc-qx"
		]
	}
}
```

Thats all.


### Ignore compiled stuff in `.eslintignore`

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`](esnext.js) if you want ES2015+ rules:

```json
{
	"extends": "@qooxdoo/eslint-plugins-qx/esnext"
}
```

And [`qx/browser`](browser.js) if you're in the browser:

```json
{
	"extends": "@qooxdoo/eslint-config-qx/browser"
}
```

If you want only check for safety-errors then extend [qx/safety](safety.js):

```json
{
	"extends": "@qooxdoo/eslint-config-qx/safety"
}
```


## Authors

- Original XO Author: [Sindre Sorhus](https://sindresorhus.com)
- Changes for Qooxdoo by: [René Jochum](https://rene.jochums.at)


## License

MIT