@stanlemon/eslint-config 0.1.112 → 0.1.113

package/README.md

@@ -1,5 +1,7 @@
 # ESLint Config
 
+[![npm version](https://badge.fury.io/js/%40stanlemon%2Feslint-config.svg)](https://badge.fury.io/js/%40stanlemon%2Feslint-config)
+
 ESLint is great, but it takes a lot to setup! This is my attempt to create a package that contains all of the dependencies I need, plus a simple config to use.
 
 To use this, simply create the following file:

package/index.js

@@ -1,3 +1,12 @@
+const fs = require("fs");
+
+// A package can define a custom tsconfig just for eslint, and if they do we should use it
+const tsconfigPath = fs.existsSync("./tsconfig.eslint.json")
+  ? "./tsconfig.eslint.json"
+  : "./tsconfig.json";
+// Does the desired tsconfig exist?
+const tsconfigExists = fs.existsSync(tsconfigPath);
+
 module.exports = {
   env: {
     es2022: true,
@@ -5,8 +14,10 @@ module.exports = {
     node: true,
     jest: true,
   },
+  ...(tsconfigExists && { parser: "@typescript-eslint/parser" }),
   parserOptions: {
     sourceType: "module",
+    ...(tsconfigExists && { project: tsconfigPath }),
   },
   extends: [
     "eslint:recommended",
@@ -18,7 +29,7 @@ module.exports = {
     "typescript",
     "typescript/react",
   ],
-  plugins: ["import"],
+  plugins: ["import", ...(tsconfigExists ? ["deprecation"] : [])],
   settings: {
     react: {
       version: "detect",
@@ -37,12 +48,13 @@ module.exports = {
       },
     ],
     // Linting shouldn't break on this, but we also want to discourage using console logging
-    "no-console": "warn",
+    "no-console": ["warn", { allow: ["warn", "error"] }],
     // Requires the displayName property to be set, not ideal for stateless components
     "react/display-name": "off",
     "react/react-in-jsx-scope": "off",
     "react/jsx-uses-react": "off",
     "react/prop-types": "off",
+    "react/no-unescaped-entities": ["error", { forbid: [">", "}"] }],
     // Allow exporting of unnamed objects as a default
     "import/no-anonymous-default-export": [
       "error",
@@ -60,8 +72,12 @@ module.exports = {
         trailingComma: "es5",
       },
     ],
-    "no-unused-vars": "warn",
-    "@typescript-eslint/no-unused-vars": "warn",
+    "no-unused-vars": ["warn", { ignoreRestSiblings: true, args: "none" }],
+    "@typescript-eslint/no-unused-vars": [
+      "warn",
+      { ignoreRestSiblings: true, args: "none" },
+    ],
+    ...(tsconfigExists && { "deprecation/deprecation": "warn" }),
   },
   overrides: [
     {
@@ -75,12 +91,12 @@ module.exports = {
       },
     },
     {
-      files: ["**/*.jsx", "**/.tsx"],
+      files: ["**/*.jsx", "**/*.tsx"],
       rules: {
         "max-lines-per-function": [
           "error",
           {
-            max: 160,
+            max: 160, // Twice as long as normal
             skipBlankLines: true,
             skipComments: true,
           },
@@ -88,10 +104,11 @@ module.exports = {
       },
     },
     {
-      files: ["**/*.test.*"],
+      files: ["**/*.test.js", "**/*.test.ts", "**/*.test.tsx"],
       rules: {
         "max-lines-per-function": "off",
       },
     },
   ],
+  ignorePatterns: [".eslintrc.js", "dist/", "node_modules/"],
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stanlemon/eslint-config",
-  "version": "0.1.112",
+  "version": "0.1.113",
   "description": "My typical eslint setup, but without all the copy and paste.",
   "keywords": [
     "eslint"
@@ -13,18 +13,19 @@
   "type": "commonjs",
   "scripts": {
     "lint": "eslint --ext js,jsx,ts,tsx ./",
-    "lint:format": "eslint --fix --ext js,jsx,ts,tsx ./"
+    "lint:fix": "eslint --fix --ext js,jsx,ts,tsx ./"
   },
   "dependencies": {
     "@babel/eslint-parser": "^7.23.3",
-    "@typescript-eslint/eslint-plugin": "^6.16.0",
-    "@typescript-eslint/parser": "^6.16.0",
+    "@typescript-eslint/eslint-plugin": "^6.18.0",
+    "@typescript-eslint/parser": "^6.18.0",
     "eslint": "^8.56.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-config-react": "^1.1.7",
     "eslint-config-typescript": "^3.0.0",
+    "eslint-plugin-deprecation": "^2.0.0",
     "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-jest": "^27.6.0",
+    "eslint-plugin-jest": "^27.6.1",
     "eslint-plugin-jest-dom": "^5.1.0",
     "eslint-plugin-jsx-a11y": "^6.8.0",
     "eslint-plugin-prettier": "^5.1.2",
@@ -32,4 +33,4 @@
     "eslint-plugin-react-hooks": "^4.6.0",
     "prettier": "^3.1.1"
   }
-}
+}