Merge pull request #17 from climatiq/v2

V2

Author: igmoweb

index.js

@@ -1,10 +1,52 @@
 module.exports = {
-  extends: ['next/core-web-vitals', 'plugin:@typescript-eslint/recommended', 'prettier'],
+  extends: ['next/core-web-vitals', 'plugin:@typescript-eslint/recommended-type-checked', 'prettier'],
+  plugins: [
+    // This plugin automatically removes unused imports
+    "unused-imports"
+  ],
   rules: {
     'curly': 'error',
     'no-console': 2,
-    '@typescript-eslint/ban-ts-comment': 1,
-    '@typescript-eslint/no-unused-vars': 2,
-    "@typescript-eslint/no-empty-function": "off"
-  }
-}
+    // Sometimes ts-ignore is handy if we justify it
+    '@typescript-eslint/ban-ts-comment': [
+      'warn',
+      {
+        'ts-check': 'allow-with-description',
+        'ts-expect-error': 'allow-with-description',
+        'ts-ignore': 'allow-with-description',
+        'ts-nocheck': 'allow-with-description',
+      },
+    ],
+    "@typescript-eslint/no-empty-function": "off",
+    '@typescript-eslint/no-unused-vars': 'off', // delegate to plugin below that handles both vars and imports
+    'unused-imports/no-unused-imports': 'error',
+    'unused-imports/no-unused-vars': [
+      'warn',
+      { vars: 'all', varsIgnorePattern: '^_', args: 'after-used', argsIgnorePattern: '^_' },
+    ],
+  },
+
+  parserOptions: {
+    project: true,
+    tsconfigRootDir: "./tsconfig.json",
+  },
+  overrides: [
+    {
+      files: ['**/*.test.ts', '**/*/test-stubs.ts', '**/*/test-helpers.ts'],
+      rules: {
+        // Handy to have all tests be async even if we don't use it in them
+        '@typescript-eslint/require-await': 'off',
+        // No need to be super strict with anys in test code
+        // Also these don't seem to work well with snapshot matchers
+        '@typescript-eslint/no-unsafe-argument': 'off',
+        '@typescript-eslint/no-unsafe-assignment': 'off',
+      },
+    },
+    {
+      //see https://typescript-eslint.io/troubleshooting/#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file
+      // This is to avoid errors about this not being in the TSConfig
+      extends: ['plugin:@typescript-eslint/disable-type-checked'],
+      files: ['./**/*.js'],
+    }
+  ],
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@climatiq/eslint-config",
-  "version": "1.0.10",
+  "version": "2.0.0",
   "description": "ESlint configuration for Climatiq projects",
   "main": "index.js",
   "repository": {
@@ -15,7 +15,7 @@
     "eslint"
   ],
   "author": "Climatiq",
-  "license": "GPL-2.0-or-later",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/climatiq/eslint-config-climatiq/issues"
   },
@@ -26,22 +26,18 @@
   "peerDependencies": {
     "@next/eslint-plugin-next": "^13.4.6",
     "@typescript-eslint/eslint-plugin": ">=5.3.1",
-    "@typescript-eslint/parser": ">=5.3.1",
     "eslint-config-prettier": ">=8.3.0",
     "eslint-plugin-prettier": ">=4.0.0",
     "eslint-webpack-plugin": "^4.0.1",
-    "prettier": "^3.0.1"
+    "prettier": "^>=3",
+    "typescript": ">5"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": ">=5.3.1",
     "@typescript-eslint/parser": ">=5.3.1",
-    "eslint": "^8.42.0",
+    "eslint": "^8",
     "eslint-config-next": "^13.4.6",
     "eslint-config-prettier": ">=8.3.0",
-    "eslint-plugin-prettier": ">=4.0.0",
-    "prettier": "^3.0.1",
-    "semver": "^7.5.3",
-    "typescript": "^5.1.3"
+    "eslint-plugin-prettier": ">=4.0.0"
   },
   "publishConfig": {
     "access": "public"