@will-stone/eslint-config 6.11.0 → 7.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2023 Will Stone
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,3 +1,77 @@
-# ESLint Config
+# @will-stone/eslint-config
 
-See parent [README](../../README.md)
+My personal [ESLint](https://eslint.org/) config.
+
+## Usage
+
+### Install
+
+```bash
+npm i -D eslint @will-stone/eslint-config
+```
+
+### Create config file
+
+```js
+// eslint.config.js
+import config from '@will-stone/eslint-config'
+
+export default config()
+```
+
+### Add script for package.json
+
+For example:
+
+```json
+{
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  }
+}
+```
+
+### VS Code support (auto fix)
+
+Install
+[VS Code ESLint extension](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint).
+
+Add the following settings to your `.vscode/settings.json`:
+
+```jsonc
+{
+  // Enable the ESlint flat config support
+  "eslint.experimental.useFlatConfig": true
+}
+```
+
+### Lint Staged
+
+If you would like to apply lint and auto-fix before every commit, you can add
+the following to your `package.json`:
+
+```json
+{
+  "scripts": {
+    "prepare": "husky install"
+  },
+  "lint-staged": {
+    "*.{js,jsx,ts,tsx}": ["eslint --fix"]
+  }
+}
+```
+
+and then
+
+```bash
+npm i -D husky lint-staged
+npx husky install
+npx husky add .husky/pre-commit "npx --no lint-staged"
+```
+
+## Credits
+
+Inspired by the excellent
+[Flat eslint-config](https://github.com/antfu/eslint-config) by
+[Anthony Fu](https://github.com/antfu).