@etchteam/eslint-config 0.0.1 → 1.0.3

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+## [1.0.3](https://github.com/etchteam/eslint/compare/v1.0.2...v1.0.3) (2022-12-19)
+
+
+### Bug Fixes
+
+* add peer deps ([641e7be](https://github.com/etchteam/eslint/commit/641e7be83810b4c8946bb421b1b2950937a1ad5e))
+* eslint requires a specific config name ([0bffcee](https://github.com/etchteam/eslint/commit/0bffcee865455d339b296da15875d851d2e45ea7))
+* keep config in single file ([8d707e2](https://github.com/etchteam/eslint/commit/8d707e220929861f31795497447366a7bb2f92a5))

package/README.md

@@ -5,11 +5,70 @@ The eslint config that we use at [Etch](https://etch.co)
 ## Install
 
 ```bash
-npm install eslint @etchteam/eslint
+npm install eslint prettier @etchteam/eslint-config
 ```
 
-## Use
+## Usage
 
 ```bash
-echo "module.exports = { extends: ['@etchteam/eslint'] }" > .eslintrc.js
+echo "module.exports = { extends: ['@etchteam'] }" > .eslintrc.js
+```
+
+### With lint-staged
+
+#### New project
+
+Run the following:
+
+```bash
+npm install husky lint-staged
+
+echo "module.exports = { '*.{ts,tsx,js,jsx}': 'eslint --fix' };" > lint-staged.config.js
+
+npx husky install
+
+npx husky set .husky/pre-commit "npx --no-install -- lint-staged"
+
+```
+
+#### Existing project with husky and lint staged
+
+Add the following to your lint-staged config:
+
+`'*.{ts,tsx,js,jsx}': 'eslint --fix'`
+
+## Usage with VSCode
+
+### New project with no VSCode config
+
+Run the following:
+
+```bash
+mkdir .vscode
+
+echo "{ "editor.formatOnSave": false, "editor.codeActionsOnSave": { "source.fixAll.eslint": true } }" > .vscode/settings.json
+
+# The VSCode prettier extension doesn't read the eslint config, so specific
+# prettier overrides need to go in a prettier config for format on save
+echo "module.exports = { singleQuote: true };" > prettier.config.js
+
+```
+
+### Exisiting project with VSCode config
+
+Add the following to `.vscode/settings.json`:
+
+```json
+"editor.formatOnSave": false,
+"editor.codeActionsOnSave": {
+  "source.fixAll.eslint": true
+}
+```
+
+Run the following:
+
+```bash
+# The VSCode prettier extension doesn't read the eslint config, so specific
+# prettier overrides need to go in a prettier config for format on save
+echo "module.exports = { singleQuote: true };" > prettier.config.js
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etchteam/eslint-config",
-  "version": "0.0.1",
+  "version": "1.0.3",
   "description": "Etch's standard eslint config",
   "main": "src/index.js",
   "scripts": {
@@ -30,6 +30,8 @@
     "lint-staged": "^13.1.0"
   },
   "dependencies": {
+    "@typescript-eslint/eslint-plugin": "^5.46.1",
+    "@typescript-eslint/parser": "^5.46.1",
     "eslint": "^8.29.0",
     "eslint-config-next": "^13.0.7",
     "eslint-config-prettier": "^8.5.0",
@@ -39,5 +41,9 @@
     "eslint-plugin-storybook": "^0.6.8",
     "eslint-plugin-unused-imports": "^2.0.0",
     "prettier": "^2.8.1"
+  },
+  "peerDependencies": {
+    "eslint": "^8.29.0",
+    "prettier": "^2.8.1"
   }
 }

package/src/index.js

@@ -1,3 +1,34 @@
-import config from './.eslintrc.js';
-
-export default config;
+module.exports = {
+  extends: [
+    'next/core-web-vitals',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:storybook/recommended',
+    'plugin:security/recommended',
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+    'plugin:prettier/recommended',
+  ],
+  plugins: ['unused-imports'],
+  parser: '@typescript-eslint/parser',
+  rules: {
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': 'error',
+    'unused-imports/no-unused-imports': 'error',
+    'unused-imports/no-unused-vars': 'off',
+    'import/order': ['error', {
+      'newlines-between': 'always',
+      alphabetize: {
+        order: 'asc'
+      },
+    }],
+  },
+  settings: {
+    'import/resolver': {
+      typescript: true,
+      node: true
+    },
+    'prettier/prettier': {
+      singleQuote: true,
+    },
+  }
+};