Skip to content

Commit 64c7a6e

Browse files
authored
Merge pull request #220 from standard/update
Cleanup & small fixes
2 parents 086c801 + cad15b5 commit 64c7a6e

File tree

4 files changed

+52
-44
lines changed

4 files changed

+52
-44
lines changed

.npmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
package-lock=false

.travis.yml

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,8 @@ cache:
22
npm: false
33
language: node_js
44
node_js:
5-
- lts/*
5+
- 8.10
6+
- 8
7+
- 10
8+
- 12
9+
- 14

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.
@@ -31,24 +34,29 @@ Here is a list of packages using `standard-engine`. Dive into them for ideas!
3134
Did you make your own? Create a pull request and we will add it to the README!
3235

3336
## Usage
37+
3438
Create the files below and fill in your own values for `options.js`.
3539

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

44-
**cli.js**
49+
### `cli.js`
50+
4551
```js
4652
#!/usr/bin/env node
4753

4854
var opts = require('../options.js')
4955
require('standard-engine').cli(opts)
5056
```
51-
**options.js**
57+
58+
### `options.js`
59+
5260
```js
5361
var eslint = require('eslint')
5462
var path = require('path')
@@ -71,14 +79,17 @@ module.exports = {
7179

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

74-
**eslintrc.json**
75-
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:
82+
### `eslintrc.json`
83+
84+
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:
85+
7686
```js
7787
{
7888
// pretend that the package eslint-config-pocketlint exists!
7989
"extends": ["pocketlint"]
8090
}
8191
```
92+
8293
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).
8394

8495
## Editor Integrations
@@ -283,10 +294,10 @@ Modify and return `opts`, or return a new object with the options that are to be
283294

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

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

291302
## API Usage
292303

package.json

Lines changed: 24 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,7 @@
11
{
22
"name": "standard-engine",
3-
"description": "Wrap your standards in a tortilla and cover it in special sauce.",
43
"version": "12.0.0",
5-
"author": "Dan Flettre <flettre@gmail.com> (http://twitter.com/flettre/)",
6-
"bugs": {
7-
"url": "https://github.com/flet/standard-engine/issues"
8-
},
9-
"dependencies": {
10-
"deglob": "^4.0.0",
11-
"get-stdin": "^7.0.0",
12-
"minimist": "^1.1.0",
13-
"pkg-conf": "^3.1.0"
14-
},
15-
"devDependencies": {
16-
"babel-eslint": "^10.0.2",
17-
"cross-spawn": "^7.0.0",
18-
"eslint": "*",
19-
"eslint-config-standard": "*",
20-
"eslint-config-standard-jsx": "*",
21-
"eslint-plugin-import": "*",
22-
"eslint-plugin-node": "*",
23-
"eslint-plugin-promise": "*",
24-
"eslint-plugin-react": "*",
25-
"eslint-plugin-standard": "*",
26-
"mkdirp": "^0.5.0",
27-
"standard": "*",
28-
"tape": "^4.0.0"
29-
},
30-
"homepage": "https://github.com/flet/standard-engine",
4+
"description": "Wrap your standards in a tortilla and cover it in special sauce.",
315
"keywords": [
326
"JavaScript Standard Style",
337
"check",
@@ -53,15 +27,33 @@
5327
"style linter",
5428
"verify"
5529
],
30+
"repository": "standard/standard-engine",
5631
"license": "MIT",
57-
"main": "index.js",
58-
"repository": {
59-
"type": "git",
60-
"url": "git://github.com/flet/standard-engine.git"
61-
},
32+
"author": "Dan Flettre <flettre@gmail.com> (http://twitter.com/flettre/)",
6233
"scripts": {
6334
"test": "standard && tape test/clone.js test/api.js"
6435
},
36+
"dependencies": {
37+
"deglob": "^4.0.1",
38+
"get-stdin": "^7.0.0",
39+
"minimist": "^1.2.5",
40+
"pkg-conf": "^3.1.0"
41+
},
42+
"devDependencies": {
43+
"babel-eslint": "^10.1.0",
44+
"cross-spawn": "^7.0.2",
45+
"eslint": "^6.8.0",
46+
"eslint-config-standard": "^14.1.1",
47+
"eslint-config-standard-jsx": "^8.1.0",
48+
"eslint-plugin-import": "^2.20.2",
49+
"eslint-plugin-node": "^11.1.0",
50+
"eslint-plugin-promise": "^4.2.1",
51+
"eslint-plugin-react": "^7.19.0",
52+
"eslint-plugin-standard": "^4.0.1",
53+
"mkdirp": "^0.5.5",
54+
"standard": "^14.3.3",
55+
"tape": "^5.0.0"
56+
},
6557
"engines": {
6658
"node": ">=8.10"
6759
}

0 commit comments

Comments
 (0)