eslint-config-standard-kit
Advanced tools
Comparing version 0.14.2 to 0.14.3
# eslint-config-standard-kit | ||
## 0.14.3 (2019-10-17) | ||
- Add a web page to help generate configurations for new projects. | ||
- Add a set of `standard-kit/prettier` rules with Prettier pre-integrated. | ||
- Deprecate the `standard-kit/lint` rules. | ||
## 0.14.2 (2019-10-07) | ||
@@ -4,0 +10,0 @@ |
{ | ||
"name": "eslint-config-standard-kit", | ||
"version": "0.14.2", | ||
"version": "0.14.3", | ||
"private": false, | ||
@@ -22,7 +22,8 @@ "description": "Standard.js linting rules - broken into modular pieces", | ||
"scripts": { | ||
"lint": "eslint scripts", | ||
"lint:fix": "eslint --fix scripts", | ||
"precommit": "npm run lint; npm test", | ||
"prepare": "node ./scripts/generate-configs.js", | ||
"test": "tsc --noEmit -p examples/typescript && tsc --noEmit -p examples/typescript-jsx && node ./scripts/test.js" | ||
"fix": "npm run lint -- --fix", | ||
"lint": "eslint .", | ||
"precommit": "npm run lint && npm test", | ||
"prepare": "rollup -c && node ./src/rules/build.js", | ||
"test": "mocha -r esm ./test/**/*.test.js && tsc", | ||
"test-update": "rm test/snapshots/*; UPDATE=1 npm test" | ||
}, | ||
@@ -59,7 +60,11 @@ "husky": { | ||
"eslint-plugin-react": "^7.14.3", | ||
"eslint-plugin-simple-import-sort": "^4.0.0", | ||
"eslint-plugin-standard": "^4.0.1", | ||
"esm": "^3.2.25", | ||
"husky": "^3.0.5", | ||
"mocha": "^6.2.1", | ||
"prettier": "^1.18.2", | ||
"rollup": "^1.23.1", | ||
"typescript": "3.5.3" | ||
} | ||
} |
# eslint-config-standard-kit | ||
[Standard.js](https://standardjs.com) is a _fantastic_ collection of linter rules, but it difficult to integrate with other code-quality tools like [Prettier](https://prettier.io/), [TypeScript](https://typescriptlang.org), or [Flow](https://flow.org/). | ||
[Standard.js](https://standardjs.com) is a _fantastic_ collection of linter rules, but it can be difficult to integrate with other code-quality tools like Prettier, TypeScript, or Flow. | ||
@@ -13,20 +13,9 @@ This package makes it easy to integrate Standard.js with these other tools by breaking its configuration into modular pieces. Just mix & match the bits you need for your particular setup: | ||
If you use a tool like Prettier to format your source code, just prefix the rule names with `standard-kit/lint` instead of `standard-kit`. This will remove all formatting rules, leaving just the code-quality rules. | ||
If you would like to use [Prettier](https://prettier.io/) to format your source code instead of Standard.js, just prefix the configuration names with `standard-kit/prettier` instead of `standard-kit`. | ||
For example, here is an `.eslintrc.json` that supports Prettier, JSX, and Typescript: | ||
## Easy Setup | ||
```json | ||
{ | ||
"extends": [ | ||
"standard-kit/lint", | ||
"standard-kit/lint/jsx", | ||
"standard-kit/lint/typescript" | ||
], | ||
"parserOptions": { | ||
"project": "./tsconfig.json" | ||
} | ||
} | ||
``` | ||
Use the [configuration web page](https://www.swansontec.com/eslint-config-standard-kit/) to generate your`.eslintrc.json` file and list of dependencies for `package.json`. | ||
## Usage | ||
## Manual Setup | ||
@@ -55,5 +44,21 @@ First, add `eslint-plugin-standard-kit` as one of your project's `devDependencies`: | ||
- `eslint-plugin-flowtype` | ||
- prettier: | ||
- `eslint-plugin-prettier` | ||
- `prettier` | ||
Finally, edit your ESLint configuration file to enable your selected rules, as shown in the example above. | ||
Finally, edit your ESLint configuration file to enable your selected rules, as shown in the example below: | ||
```json | ||
{ | ||
"extends": [ | ||
"standard-kit", | ||
"standard-kit/jsx", | ||
"standard-kit/typescript" | ||
], | ||
"parserOptions": { | ||
"project": "tsconfig.json" | ||
} | ||
} | ||
``` | ||
If you are using JSX or Typescript, you may want to pass the [`--ext`](https://eslint.org/docs/user-guide/command-line-interface#--ext) option to ESlint to tell it about the `.jsx` or `.ts` file extensions: | ||
@@ -60,0 +65,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
48883
15
1893
75
28