Skip to content

Commit cad15b5

Browse files
committed
Fix linting errors in readme
1 parent 70c77db commit cad15b5

File tree

1 file changed

+22
-11
lines changed

1 file changed

+22
-11
lines changed

README.md

Lines changed: 22 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,18 +10,21 @@
1010
[standard-url]: https://standardjs.com
1111

1212
## Overview
13+
1314
Wrap your own eslint rules in a easy-to-use command line tool and/or a JS module.
1415

1516
## Install
16-
```
17+
18+
```sh
1719
npm install standard-engine
1820
```
1921

2022
## Who is using `standard-engine`?
23+
2124
Here is a list of packages using `standard-engine`. Dive into them for ideas!
2225

2326
- [standard](https://standardjs.com) - JavaScript Standard Style.
24-
- [semistandard](https://github.com/Flet/semistandard) - Its `standard` with semicolons sprinkled on top.
27+
- [semistandard](https://github.com/Flet/semistandard) - Its `standard` with semicolons sprinkled on top.
2528
- [happiness](https://github.com/JedWatson/happiness) - JavaScript Happiness Style (semicolons and tabs)
2629
- [doublestandard](https://github.com/flet/doublestandard) - Require TWO semicolons at the end of every line!
2730
- [strict-standard](https://github.com/denis-sokolov/strict-standard) - Standard Style with strict error checking.
@@ -30,24 +33,29 @@ Here is a list of packages using `standard-engine`. Dive into them for ideas!
3033
Did you make your own? Create a pull request and we will add it to the README!
3134

3235
## Usage
36+
3337
Create the files below and fill in your own values for `options.js`.
3438

35-
**index.js**
39+
### `index.js`
40+
3641
```js
3742
// programmatic usage
3843
var Linter = require('standard-engine').linter
3944
var opts = require('./options.js')
4045
module.exports = new Linter(opts)
4146
```
4247

43-
**cli.js**
48+
### `cli.js`
49+
4450
```js
4551
#!/usr/bin/env node
4652

4753
var opts = require('../options.js')
4854
require('standard-engine').cli(opts)
4955
```
50-
**options.js**
56+
57+
### `options.js`
58+
5159
```js
5260
var eslint = require('eslint')
5361
var path = require('path')
@@ -70,14 +78,17 @@ module.exports = {
7078

7179
Additionally an optional `parseOpts()` function can be provided. See below for details.
7280

73-
**eslintrc.json**
74-
Put all your .eslintrc rules in this file. A good practice is to create an [ESLint Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) and extend it, but its not required:
81+
### `eslintrc.json`
82+
83+
Put all your .eslintrc rules in this file. A good practice is to create an [ESLint Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) and extend it, but its not required:
84+
7585
```js
7686
{
7787
// pretend that the package eslint-config-pocketlint exists!
7888
"extends": ["pocketlint"]
7989
}
8090
```
91+
8192
Take a look at [eslint-config-standard](https://github.com/feross/eslint-config-standard) as an example, or if you want to extend/mutate `standard`, see [eslint-config-semistandard](https://github.com/flet/eslint-config-semistandard).
8293

8394
## Editor Integrations
@@ -282,10 +293,10 @@ Modify and return `opts`, or return a new object with the options that are to be
282293

283294
The following options are provided in the `opts` object, and must be on the returned object:
284295

285-
* `ignore`: array of file globs to ignore
286-
* `cwd`: string, the current working directory
287-
* `fix`: boolean, whether to automatically fix problems
288-
* `eslintConfig`: object, the options passed to [ESLint's `CLIEngine`](http://eslint.org/docs/developer-guide/nodejs-api#cliengine)
296+
- `ignore`: array of file globs to ignore
297+
- `cwd`: string, the current working directory
298+
- `fix`: boolean, whether to automatically fix problems
299+
- `eslintConfig`: object, the options passed to [ESLint's `CLIEngine`](http://eslint.org/docs/developer-guide/nodejs-api#cliengine)
289300

290301
## API Usage
291302

0 commit comments

Comments
 (0)