waltervargas / xo

❤️ JavaScript happiness style linter

JavaScript happiness style linter

Opinionated but configurable ESLint wrapper with lots of goodies included. Enforces strict and readable code. Never discuss code style on a pull request again! No decision-making. No .eslintrc or .jshintrc to manage. It just works!

Uses ESLint underneath, so issues regarding rules should be opened over there.

JSX is supported by default, but you'll need eslint-config-xo-react for React specific linting.

Highlights

• Beautiful output.
• Zero-config, but configurable when needed.
• Enforces readable code, because you read more code than you write.
• No need to specify file paths to lint as it lints all JS files except for commonly ignored paths.
• Config overrides per files/globs. (ESLint doesn't support this)
• Includes many useful ESLint plugins, like unicorn, import, ava, and more.
• Caches results between runs for much better performance.
• Super simple to add XO to a project with $ xo --init.
• Fix many issues automagically with $ xo --fix.
• Open all files with errors at the correct line in your editor with $ xo --open.
• Specify indent and semicolon preferences easily without messing with the rule config.
• Great editor plugins.

Install

$ npm install --global xo

Usage

$ xo --help

  Usage
    $ xo [<file|glob> ...]

  Options
    --init          Add XO to your project
    --fix           Automagically fix issues
    --reporter      Reporter to use
    --stdin         Validate/fix code from stdin
    --esnext        Enforce ES2015+ rules
    --env           Environment preset  [Can be set multiple times]
    --global        Global variable  [Can be set multiple times]
    --ignore        Additional paths to ignore  [Can be set multiple times]
    --space         Use space indent instead of tabs  [Default: 2]
    --no-semicolon  Prevent use of semicolons
    --plugin        Include third-party plugins  [Can be set multiple times]
    --extend        Extend defaults with a custom config  [Can be set multiple times]
    --open          Open files with issues in your editor
    --quiet         Show only errors and no warnings
    --extension     Additional extension to lint [Can be set multiple times]

  Examples
    $ xo
    $ xo index.js
    $ xo *.js !foo.js
    $ xo --esnext --space
    $ xo --env=node --env=mocha
    $ xo --init --esnext
    $ xo --plugin=react
    $ xo --plugin=html --extension=html
    $ echo 'const x=true' | xo --stdin --fix

  Tips
    Put options in package.json instead of using flags so other tools can read it.

Note that the CLI will use your local install of XO when available, even when run globally.

Default code style

Any of these can be overridden if necessary.

• Tab indentation (or space)
• Semicolons (or not)
• Single-quotes
• No unused variables
• Space after keyword if (condition) {}
• Always === instead of ==

Check out an example and the ESLint rules.

Workflow

The recommended workflow is to add XO locally to your project and run it with the tests.

Simply run $ xo --init (with any options) to add XO to your package.json or create one.

Before

{
  "name": "awesome-package",
  "scripts": {
    "test": "ava"
  },
  "devDependencies": {
    "ava": "^0.16.0"
  }
}

After

{
  "name": "awesome-package",
  "scripts": {
    "test": "xo && ava"
  },
  "devDependencies": {
    "ava": "^0.16.0",
    "xo": "^0.17.0"
  }
}

Then just run $ npm test and XO will be run before your tests.

Config

You can configure some options in XO by putting it in package.json:

{
  "name": "awesome-package",
  "xo": {
    "esnext": true
  }
}

Globals and rules can be configured inline in files.

esnext

Type: boolean
Default: false

Enforce ES2015+ rules. Enabling this will prefer ES2015+ syntax and conventions.

*ES2015+ is parsed even without this option. You can already use ES2017 features like async/await.

envs

Type: Array
Default: ['node']

Which environments your code is designed to run in. Each environment brings with it a certain set of predefined global variables.

globals

Type: Array

Additional global variables your code accesses during execution.

ignores

Type: Array

Some paths are ignored by default, including paths in .gitignore. Additional ignores can be added here.

space

Type: boolean, number
Default: false (tab indentation)

Set it to true to get 2-space indentation or specify the number of spaces.

This option exists for pragmatic reasons, but I would strongly recommend you read "Why tabs are superior".

rules

Type: Object

Override any of the default rules. See the ESLint docs for more info on each rule.

Please take a moment to consider if you really need to use this option.

semicolon

Type: boolean
Default: true (semicolons required)

Set it to false to enforce no-semicolon style.

plugins

Type: Array

Include third-party plugins.

extends

Type: Array, string

Use one or more shareable configs or plugin configs to override any of the default rules (like rules above).

extensions

Type: Array

Allow more extensions to be linted besides .js and .jsx. Make sure they're supported by ESLint or an ESLint plugin.

settings

Type: Object

Shared ESLint settings exposed to rules. For example, to configure the import plugin to use your webpack configuration for determining search paths, you can put {"import/resolver": "webpack"} here.

parser

Type: string

ESLint parser. For example, babel-eslint if you're using language features that ESLint doesn't yet support.

Config Overrides

XO makes it easy to override configs for specific files. The overrides property must be an array of override objects. Each override object must contain a files property which is a glob string, or an array of glob strings. The remaining properties are identical to those described above, and will override the settings of the base config. If multiple override configs match the same file, each matching override is applied in the order it appears in the array. This means the last override in the array takes precedence over earlier ones. Consider the following example:

{
  "xo": {
    "semicolon": false,
    "space": 2,
    "overrides": [
      {
        "files": "test/*.js",
        "esnext": true,
        "space": 3
      },
      {
         "files": "test/foo.js",
         "esnext": false
      }
    ]
  }
}

• The base configuration is simply space: 2, semicolon: false. These settings are used for every file unless otherwise noted below.

• For every file in test/*.js, the base config is used, but space is overridden with 3, and the esnext option is set to true. The resulting config is:

{
  "esnext": true,
  "semicolon": false,
  "space": 3
}

• For test/foo.js, the base config is first applied, followed the first overrides config (its glob pattern also matches test/foo.js), finally the second override config is applied. The resulting config is:

{
  "esnext": false,
  "semicolon": false,
  "space": 3
}

Tips

Using a parent's config

If you have a directory structure with nested package.json files and you want one of the child manifests to be skipped, you can do so by setting "xo": false. For example, when you have separate app and dev package.json files with electron-builder.

FAQ

What does XO mean?

It means hugs and kisses.

Why not Standard?

The Standard style is a really cool idea. I too wish we could have one style to rule them all! But the reality is that the JS community is just too diverse and opinionated to create one code style. They also made the mistake of pushing their own style instead of the most popular one. In contrast, XO is more pragmatic and has no aspiration of being the style. My goal with XO is to make it simple to enforce consistent code style with close to no config. XO comes with my code style preference by default, as I mainly made it for myself, but everything is configurable.

Why not ESLint?

XO is based on ESLint. This project started out as just a shareable ESLint config, but it quickly grew out of that. I wanted something even simpler. Just typing xo and be done. No decision-making. No config. I also have some exciting future plans for it. However, you can still get most of the XO benefits while using ESLint directly with the ESLint shareable config.

Editor plugins

• Sublime Text
• Atom
• TextMate 2
• VSCode
• Emacs

Vim

You can use Syntastic's ESLint checker with the following settings in your .vimrc file:

let g:syntastic_javascript_eslint_generic = 1
let g:syntastic_javascript_eslint_exec = 'xo'
let g:syntastic_javascript_eslint_args = '--reporter=compact'
let g:syntastic_javascript_checkers = ['eslint']

You can also use vim-autoformat to format your code with XO, using the following settings in your .vimrc file:

let g:formatdef_xo = '"xo --fix --stdin"'
let g:formatters_javascript = ['xo']

Build-system plugins

• Gulp
• Grunt
• webpack
• Metalsmith
• Fly

Configs

• eslint-config-xo - ESLint shareable config for XO
• eslint-config-xo-space - ESLint shareable config for XO with 2-space indent
• eslint-config-xo-react - ESLint shareable config for React to be used with the above

Support

• Gitter chat
• Twitter

Related

• eslint-plugin-unicorn - Various awesome ESLint rules (Bundled in XO)

Badge

Show the world you're using XO →

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

Team

Sindre Sorhus	James Talmage	Mario Nebl

License

MIT © Sindre Sorhus