Skip to content

Commit 517cd3c

Browse files
sindresorhussindresorhus
committed
add Highlights section
1 parent 9bf80fa commit 517cd3c

1 file changed

Lines changed: 24 additions & 9 deletions

File tree

‎readme.md‎

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,32 @@
66
<br>
77
</h1>
88

9-
> JavaScript happiness style linter ❤️
9+
> JavaScript happiness style linter
1010
1111
[![Build Status: Linux](https://travis-ci.org/sindresorhus/xo.svg?branch=master)](https://travis-ci.org/sindresorhus/xo) [![Build status: Windows](https://ci.appveyor.com/api/projects/status/mydb56kve054n2h5/branch/master?svg=true)](https://ci.appveyor.com/project/sindresorhus/xo/branch/master) [![Coverage Status](https://coveralls.io/repos/github/sindresorhus/xo/badge.svg?branch=master)](https://coveralls.io/github/sindresorhus/xo?branch=master) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)
1212

13-
Enforce strict code style. Never discuss code style on a pull request again!
14-
15-
No decision-making. No `.eslintrc` or `.jshintrc` to manage. It just works!
13+
Opionated 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!
1614

1715
Uses [ESLint](http://eslint.org) underneath, so issues regarding rules should be opened over [there](https://github.com/eslint/eslint/issues).
1816

19-
JSX is supported by default, but you'll need [eslint-config-xo-react](https://github.com/sindresorhus/eslint-config-xo-react#use-with-xo) for React specific linting.
17+
*JSX is supported by default, but you'll need [eslint-config-xo-react](https://github.com/sindresorhus/eslint-config-xo-react#use-with-xo) for React specific linting.*
18+
19+
![](https://raw.githubusercontent.com/sindresorhus/eslint-formatter-pretty/master/screenshot.png)
20+
21+
22+
## Highlights
23+
24+
- Beautiful output.
25+
- Zero-config, but [configurable when needed](#config).
26+
- Enforces readable code, because you read more code than you write.
27+
- No need to specify file paths to lint as it lints all JS files except for [commonly ignored paths](#ignores).
28+
- [Config overrides per files/globs.](#config-overrides) *(ESLint doesn't support this)*
29+
- Includes many useful ESLint plugins, like [`unicorn`](https://github.com/sindresorhus/eslint-plugin-unicorn), [`import`](https://github.com/benmosher/eslint-plugin-import), [`ava`](https://github.com/avajs/eslint-plugin-ava), and more.
30+
- Super simple to add XO to a project with `$ xo --init`.
31+
- Fix many issues automagically with `$ xo --fix`.
32+
- Open all files with errors at the correct line in your editor with `$ xo --open`.
33+
- Specify [indent](#indent) and [semicolon](#semicolon) preferences easily without messing with the rule config.
34+
- Great [editor plugins](#editor-plugins).
2035

2136

2237
## Install
@@ -73,7 +88,7 @@ $ xo --help
7388
*Any of these can be [overridden](#rules) if necessary.*
7489

7590
- Tab indentation *[(or space)](#space)*
76-
- Semicolons
91+
- Semicolons *[(or not)](#semicolon)*
7792
- Single-quotes
7893
- No unused variables
7994
- Space after keyword `if (condition) {}`
@@ -97,7 +112,7 @@ Simply run `$ xo --init` (with any options) to add XO to your package.json or cr
97112
"test": "ava"
98113
},
99114
"devDependencies": {
100-
"ava": "^0.11.0"
115+
"ava": "^0.16.0"
101116
}
102117
}
103118
```
@@ -111,8 +126,8 @@ Simply run `$ xo --init` (with any options) to add XO to your package.json or cr
111126
"test": "xo && ava"
112127
},
113128
"devDependencies": {
114-
"ava": "^0.11.0",
115-
"xo": "^0.12.0"
129+
"ava": "^0.16.0",
130+
"xo": "^0.17.0"
116131
}
117132
}
118133
```

0 commit comments

Comments
 (0)