@paratco/eslint-config 1.0.16 → 2.1.0

package/dist/rules/typescript.js

@@ -0,0 +1,254 @@
+export default {
+    // Enforce that class methods utilize this.
+    // https://typescript-eslint.io/rules/class-methods-use-this
+    // Note: you must disable the base rule as it can report incorrect errors
+    "class-methods-use-this": "off",
+    "@typescript-eslint/class-methods-use-this": [
+        "error",
+        {
+            ignoreOverrideMethods: true,
+            ignoreClassesThatImplementAnInterface: true
+        }
+    ],
+    // Require return statements to either always or never specify values
+    // https://typescript-eslint.io/rules/consistent-return/
+    // Note: you must disable the base rule as it can report incorrect errors
+    "consistent-return": "off",
+    "@typescript-eslint/consistent-return": "off",
+    // Enforce consistent usage of type exports.
+    // https://typescript-eslint.io/rules/consistent-type-exports
+    "@typescript-eslint/consistent-type-exports": [
+        "error",
+        {
+            fixMixedExportsWithInlineTypeSpecifier: true
+        }
+    ],
+    // Enforce consistent usage of type imports.
+    // https://typescript-eslint.io/rules/consistent-type-imports
+    "@typescript-eslint/consistent-type-imports": ["error"],
+    // Enforce default parameters to be last.
+    // https://typescript-eslint.io/rules/default-param-last
+    // Note: you must disable the base rule as it can report incorrect errors
+    "default-param-last": "off",
+    "@typescript-eslint/default-param-last": ["error"],
+    // Require explicit return types on functions and class methods.
+    // https://typescript-eslint.io/rules/explicit-function-return-type
+    "@typescript-eslint/explicit-function-return-type": [
+        "error",
+        {
+            allowExpressions: true
+        }
+    ],
+    // Require explicit accessibility modifiers on class properties and methods.
+    // https://typescript-eslint.io/rules/explicit-member-accessibility
+    "@typescript-eslint/explicit-member-accessibility": [
+        "error",
+        {
+            accessibility: "no-public",
+            overrides: {
+                constructors: "off"
+            }
+        }
+    ],
+    // Require explicit return and argument types on exported functions' and classes' public class methods.
+    // https://typescript-eslint.io/rules/explicit-module-boundary-types
+    "@typescript-eslint/explicit-module-boundary-types": ["error"],
+    // Require or disallow initialization in variable declarations.
+    // https://typescript-eslint.io/rules/init-declarations
+    // Note: you must disable the base rule as it can report incorrect errors
+    "init-declarations": "off",
+    "@typescript-eslint/init-declarations": ["off"],
+    // Enforce a maximum number of parameters in function definitions.
+    // https://typescript-eslint.io/rules/max-params
+    // Note: you must disable the base rule as it can report incorrect errors
+    "max-params": "off",
+    "@typescript-eslint/max-params": ["off"],
+    // Require a consistent member declaration order.
+    // https://typescript-eslint.io/rules/member-ordering
+    "@typescript-eslint/member-ordering": [
+        "error",
+        { default: ["constructor", "field", "static-method", "method", "signature"] }
+    ],
+    // Enforce using a particular method signature syntax.
+    // https://typescript-eslint.io/rules/method-signature-style
+    "@typescript-eslint/method-signature-style": ["error"],
+    // Enforce naming conventions for everything across a codebase.
+    // https://typescript-eslint.io/rules/naming-convention
+    // TODO: We can split this rule. for components it enforces PascalCase and functions camelCase
+    "@typescript-eslint/naming-convention": [
+        "error",
+        {
+            selector: "function",
+            format: ["PascalCase", "camelCase"]
+        }
+    ],
+    // Disallow duplicate class members.
+    // https://typescript-eslint.io/rules/no-dupe-class-members
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-dupe-class-members": "off",
+    "@typescript-eslint/no-dupe-class-members": ["off"],
+    // Enforce the use of top-level import type qualifier when an import only has specifiers with inline type qualifiers.
+    // https://typescript-eslint.io/rules/no-import-type-side-effects
+    "@typescript-eslint/no-import-type-side-effects": ["error"],
+    // Disallow this keywords outside of classes or class-like objects.
+    // https://typescript-eslint.io/rules/no-invalid-this
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-invalid-this": "off",
+    "@typescript-eslint/no-invalid-this": ["error"],
+    // Disallow function declarations that contain unsafe references inside loop statements.
+    // https://typescript-eslint.io/rules/no-loop-func
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-loop-func": "off",
+    "@typescript-eslint/no-loop-func": ["error"],
+    // Disallow magic numbers.
+    // https://typescript-eslint.io/rules/no-magic-numbers
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-magic-numbers": "off",
+    "@typescript-eslint/no-magic-numbers": ["off"],
+    // Disallow variable redeclaration.
+    // https://typescript-eslint.io/rules/no-redeclare
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-redeclare": "off",
+    "@typescript-eslint/no-redeclare": ["off"],
+    // Disallow invocation of require().
+    // https://typescript-eslint.io/rules/no-require-imports
+    // Added to recommended
+    // "@typescript-eslint/no-require-imports": ["error"],
+    // Disallow specified modules when loaded by import.
+    // https://typescript-eslint.io/rules/no-restricted-imports
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-restricted-imports": "off",
+    "@typescript-eslint/no-restricted-imports": [
+        "error",
+        {
+            patterns: [
+                {
+                    regex: "^(node:)?process$",
+                    message: "Please dont import node:process."
+                }
+            ]
+        }
+    ],
+    // Disallow certain types
+    // https://typescript-eslint.io/rules/no-restricted-types/
+    // "@typescript-eslint/no-restricted-types": ["off"],
+    // Disallow variable declarations from shadowing variables declared in the outer scope.
+    // https://typescript-eslint.io/rules/no-shadow
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-shadow": "off",
+    "@typescript-eslint/no-shadow": ["error"],
+    // https://typescript-eslint.io/rules/no-unnecessary-parameter-property-assignment/
+    // Disallow unnecessary assignment of constructor property parameter
+    "@typescript-eslint/no-unnecessary-parameter-property-assignment": ["off"],
+    // Disallow unnecessary namespace qualifiers.
+    // https://typescript-eslint.io/rules/no-unnecessary-qualifier
+    "@typescript-eslint/no-unnecessary-qualifier": ["warn"],
+    // Disallow type assertions that narrow a type
+    // https://typescript-eslint.io/rules/no-unsafe-type-assertion/
+    "@typescript-eslint/no-unsafe-type-assertion": ["error"],
+    // Require unary negation to take a number.
+    // https://typescript-eslint.io/rules/no-unsafe-unary-minus
+    // Added to recommended
+    // "@typescript-eslint/no-unsafe-unary-minus": ["error"],
+    // Disallow unused expressions.
+    // https://typescript-eslint.io/rules/no-unused-expressions
+    // Note: you must disable the base rule as it can report incorrect errors
+    // Added to recommended
+    // "no-unused-expressions": "off",
+    // "@typescript-eslint/no-unused-expressions": ["off"],
+    // Disallow the use of variables before they are defined.
+    // https://typescript-eslint.io/rules/no-use-before-define
+    // Note: you must disable the base rule as it can report incorrect errors
+    "no-use-before-define": "off",
+    "@typescript-eslint/no-use-before-define": ["error"],
+    // Disallow empty exports that don't change anything in a module file.
+    // https://typescript-eslint.io/rules/no-useless-empty-export
+    "@typescript-eslint/no-useless-empty-export": ["warn"],
+    // Require or disallow parameter properties in class constructors.
+    // https://typescript-eslint.io/rules/parameter-properties
+    "@typescript-eslint/parameter-properties": ["error"],
+    // Require destructuring from arrays and/or objects.
+    // https://typescript-eslint.io/rules/prefer-destructuring
+    // Note: you must disable the base rule as it can report incorrect errors
+    "prefer-destructuring": "off",
+    "@typescript-eslint/prefer-destructuring": ["off"],
+    // Require each enum member value to be explicitly initialized.
+    // https://typescript-eslint.io/rules/prefer-enum-initializers
+    "@typescript-eslint/prefer-enum-initializers": ["off"],
+    // Enforce the use of Array.prototype.find() over Array.prototype.filter() followed by [0] when looking for a single result.
+    // https://typescript-eslint.io/rules/prefer-find
+    // Added to stylistic
+    // "@typescript-eslint/prefer-find": ["warn"],
+    // Require private members to be marked as readonly if they're never modified outside the constructor.
+    // https://typescript-eslint.io/rules/prefer-readonly
+    "@typescript-eslint/prefer-readonly": ["warn"],
+    // Require function parameters to be typed as readonly to prevent accidental mutation of inputs.
+    // https://typescript-eslint.io/rules/prefer-readonly-parameter-types
+    "@typescript-eslint/prefer-readonly-parameter-types": ["off"],
+    // Enforce RegExp#exec over String#match if no global flag is provided.
+    // https://typescript-eslint.io/rules/prefer-regexp-exec
+    // Added to stylistic
+    // "@typescript-eslint/prefer-regexp-exec": ["warn"],
+    // Require any function or method that returns a Promise to be marked async.
+    // https://typescript-eslint.io/rules/promise-function-async
+    "@typescript-eslint/promise-function-async": ["error"],
+    // Require Array#sort and Array#toSorted calls to always provide a compareFunction.
+    // https://typescript-eslint.io/rules/require-array-sort-compare
+    "@typescript-eslint/require-array-sort-compare": ["error"],
+    // Enforce consistent returning of awaited values.
+    // https://typescript-eslint.io/rules/return-await
+    // Note: you must disable the base rule as it can report incorrect errors
+    // Added to recommended
+    // "no-return-await": "off",
+    // "@typescript-eslint/return-await": ["off"],
+    // Disallow certain types in boolean expressions.
+    // https://typescript-eslint.io/rules/strict-boolean-expressions
+    "@typescript-eslint/strict-boolean-expressions": [
+        "error",
+        {
+            allowString: false,
+            allowNumber: false,
+            allowNullableObject: false
+        }
+    ],
+    // Require switch-case statements to be exhaustive.
+    // https://typescript-eslint.io/rules/switch-exhaustiveness-check
+    "@typescript-eslint/switch-exhaustiveness-check": ["error"],
+    // Require type annotations in certain places.
+    // https://typescript-eslint.io/rules/typedef
+    "@typescript-eslint/typedef": ["off"],
+    // Additional rules (Customize rules that are not in predefined configs)
+    // Enforce template literal expressions to be of string type.
+    // https://typescript-eslint.io/rules/restrict-template-expressions
+    "@typescript-eslint/restrict-template-expressions": [
+        "error",
+        {
+            allowBoolean: true,
+            allowNumber: true,
+            allowRegExp: true
+        }
+    ],
+    // Disallow type parameters that aren't used multiple times
+    // https://typescript-eslint.io/rules/no-unnecessary-type-parameters
+    // Note: This rule is in the strict rules. But we decided to disable this rule.
+    "@typescript-eslint/no-unnecessary-type-parameters": ["off"],
+    // Disallow unused variables.
+    // https://typescript-eslint.io/rules/no-unused-vars
+    // Note: This rule is in the recommended rules. But we modify it.
+    "no-unused-vars": ["off"],
+    "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+            args: "all",
+            argsIgnorePattern: "^_",
+            caughtErrors: "all",
+            caughtErrorsIgnorePattern: "^_",
+            destructuredArrayIgnorePattern: "^_",
+            ignoreRestSiblings: true
+        }
+    ],
+    // Enforce using concise optional chain expressions instead of chained logical ands, negated logical ors, or empty objects
+    // https://typescript-eslint.io/rules/prefer-optional-chain
+    // Note: This rule is in the recommended rules. But we remove it.
+    "@typescript-eslint/prefer-optional-chain": ["off"]
+};

package/package.json

@@ -1,11 +1,21 @@
 {
   "name": "@paratco/eslint-config",
-  "version": "1.0.16",
+  "version": "2.1.0",
   "type": "module",
-  "main": "index.js",
   "author": "Paratco",
   "license": "ISC",
   "description": "Paratco ESLint Config",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/Paratco/javascript.git"
@@ -23,28 +33,31 @@
   },
   "scripts": {
     "lint": "eslint . --report-unused-disable-directives-severity error --max-warnings 0",
-    "format": "prettier --write src/"
+    "format": "prettier --write src/",
+    "build": "tsc"
   },
   "peerDependencies": {
-    "eslint": "^9.22.0",
-    "typescript-eslint": "^8.26.0"
+    "eslint": "^9.24.0",
+    "typescript-eslint": "^8.29.0"
   },
   "optionalDependencies": {
     "prettier": "^3.5.3"
   },
   "dependencies": {
-    "@eslint/js": "^9.22.0",
+    "@eslint/js": "^9.24.0",
     "@stylistic/eslint-plugin": "^4.2.0",
-    "eslint": "^9.22.0",
+    "eslint": "^9.24.0",
     "eslint-config-prettier": "^10.1.1",
-    "eslint-import-resolver-typescript": "^3.8.3",
-    "eslint-plugin-import-x": "^4.6.1",
-    "eslint-plugin-react": "^7.37.4",
+    "eslint-import-resolver-typescript": "^4.3.1",
+    "eslint-plugin-import-x": "^4.10.1",
+    "eslint-plugin-react": "^7.37.5",
     "eslint-plugin-react-hooks": "5.2.0",
     "eslint-plugin-react-refresh": "^0.4.19",
     "eslint-plugin-unused-imports": "^4.1.4",
     "globals": "^16.0.0",
-    "typescript-eslint": "^8.26.0"
+    "typescript-eslint": "^8.29.0"
   },
-  "packageManager": "yarn@4.7.0"
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  }
 }

package/.github/dependabot.yml

@@ -1,14 +0,0 @@
-version: 2
-
-updates:
-  - package-ecosystem: "npm"
-    open-pull-requests-limit: 25
-    directory: "/"
-    schedule:
-      interval: "daily"
-      time: "04:00"
-      timezone: "Asia/Tehran"
-    reviewers:
-      - "Nik96i"
-    assignees:
-      - "Nik96i"

package/.github/workflows/publish.yml

@@ -1,52 +0,0 @@
-name: Publish Package To NPM
-
-on:
-  release:
-    types: [published]
-
-jobs:
-  build:
-    runs-on:
-      - ubuntu-latest
-
-    permissions:
-      packages: write
-      contents: read
-      id-token: write
-
-    steps:
-      - name: Check out the repo
-        uses: actions/checkout@v4
-
-      - name: Check build version
-        uses: actions/github-script@v7
-        with:
-          script: |
-            try {
-              const fs = require("fs")
-              const jsonString = fs.readFileSync("package.json")
-              const package = JSON.parse(jsonString)
-              if (package.version !== "${{ github.ref_name }}") {
-                 core.setFailed(`package.json version (${package.version}) not match version of release (${{ github.ref_name }})`) 
-              }
-            } catch(err) {
-              core.setFailed(err)
-            }
-
-      - name: Setup Node
-        uses: actions/setup-node@v4
-        with:
-          node-version: 22
-          check-latest: 'true'
-          registry-url: https://registry.npmjs.org/
-
-      - name: Enable Yarn
-        run: corepack enable
-
-      - name: Install dependencies
-        run: yarn install
-
-      - name: Publish
-        run: npm publish --provenance --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_WRITE_TOKEN }}

package/.prettierrc.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/prettierrc",
-  "printWidth": 120,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": true,
-  "singleQuote": false,
-  "quoteProps": "as-needed",
-  "jsxSingleQuote": false,
-  "trailingComma": "none",
-  "bracketSpacing": true,
-  "bracketSameLine": false,
-  "arrowParens": "always",
-  "requirePragma": false,
-  "insertPragma": false,
-  "proseWrap": "preserve",
-  "htmlWhitespaceSensitivity": "css",
-  "vueIndentScriptAndStyle": false,
-  "endOfLine": "lf",
-  "embeddedLanguageFormatting": "auto",
-  "singleAttributePerLine": false
-}

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules

package/index.js

@@ -1,15 +0,0 @@
-import baseConfig from "./src/configs/base.js";
-import reactConfig from "./src/configs/react.js";
-import nodeConfig from "./src/configs/node.js";
-import importConfig from "./src/configs/import.js";
-import prettierFormatter from "./src/configs/prettierFormatter.js";
-import stylisticFormatter from "./src/configs/stylisticFormatter.js";
-
-export default {
-  base: baseConfig,
-  react: reactConfig,
-  node: nodeConfig,
-  import: importConfig,
-  prettierFormatter,
-  stylisticFormatter
-};

package/prettier/README.md

@@ -1,22 +0,0 @@
-# `@paratco/prettier-config`
-
-Paratco Prettier configs
-
-### Installation
-
-NPM:
-```bash
-npm install --save-dev @paratco/prettier-config prettier
-```
-
-Yarn:
-```bash
-yarn add -D @paratco/prettier-config prettier
-```
-
-### Usage:
-
-In your `.prettierrc.json` file:
-```json
-"@paratco/prettier-config"
-```

package/prettier/index.json

@@ -1,22 +0,0 @@
-{
-  "$schema": "https://json.schemastore.org/prettierrc",
-  "printWidth": 120,
-  "tabWidth": 2,
-  "useTabs": false,
-  "semi": true,
-  "singleQuote": false,
-  "quoteProps": "as-needed",
-  "jsxSingleQuote": false,
-  "trailingComma": "none",
-  "bracketSpacing": true,
-  "bracketSameLine": false,
-  "arrowParens": "always",
-  "requirePragma": false,
-  "insertPragma": false,
-  "proseWrap": "preserve",
-  "htmlWhitespaceSensitivity": "css",
-  "vueIndentScriptAndStyle": false,
-  "endOfLine": "lf",
-  "embeddedLanguageFormatting": "auto",
-  "singleAttributePerLine": false
-}

package/prettier/package.json

@@ -1,20 +0,0 @@
-{
-  "name": "@paratco/prettier-config",
-  "version": "0.1.1",
-  "type": "module",
-  "main": "index.json",
-  "author": "Paratco",
-  "license": "ISC",
-  "description": "Paratco Prettier Config",
-  "repository": "git@github.com/Paratco/javascript.git",
-  "keywords": [
-    "prettier",
-    "prettier-config"
-  ],
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "peerDependencies": {
-    "prettier": "^3.3.2"
-  }
-}

package/src/configs/base.js

@@ -1,25 +0,0 @@
-import eslint from "@eslint/js";
-import tsEslint from "typescript-eslint";
-
-// Custom Rules
-import javascriptRules from "../lints/javascript/index.js";
-import typescriptRules from "../lints/typescript/index.js";
-
-export default [
-  // Set predefined configs
-  eslint.configs.recommended,
-  ...tsEslint.configs.strictTypeChecked,
-  ...tsEslint.configs.stylisticTypeChecked,
-
-  // JavaScript Rules
-  {
-    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
-    rules: javascriptRules
-  },
-
-  // TypeScript Rules
-  {
-    files: ["**/*.{ts,tsx}"],
-    rules: typescriptRules
-  }
-];

package/src/configs/import.js

@@ -1,43 +0,0 @@
-import eslintPluginImportX from "eslint-plugin-import-x";
-import unusedImports from "eslint-plugin-unused-imports";
-
-// Custom Rules
-import importXRules from "../lints/import/index.js";
-
-export default [
-  // ESLint Plugin Import
-  {
-    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
-    plugins: {
-      "import-x": eslintPluginImportX,
-      "unused-imports": unusedImports
-    },
-    settings: {
-      "import-x/resolver": {
-        typescript: {
-          alwaysTryTypes: true
-        }
-      }
-    },
-    rules: {
-      ...eslintPluginImportX.configs.recommended.rules,
-      ...importXRules,
-
-      // unused-imports
-      "no-unused-vars": ["off"],
-      "@typescript-eslint/no-unused-vars": ["off"],
-      "unused-imports/no-unused-imports": ["error"],
-      "unused-imports/no-unused-vars": [
-        "error",
-        {
-          args: "all",
-          argsIgnorePattern: "^_",
-          caughtErrors: "all",
-          caughtErrorsIgnorePattern: "^_",
-          destructuredArrayIgnorePattern: "^_",
-          ignoreRestSiblings: true
-        }
-      ]
-    }
-  }
-];

package/src/configs/react.js

@@ -1,58 +0,0 @@
-import globals from "globals";
-import baseConfig from "./base.js";
-
-// Plugins
-import react from "eslint-plugin-react";
-import reactHooks from "eslint-plugin-react-hooks";
-import reactRefresh from "eslint-plugin-react-refresh";
-
-// Custom Rules
-import reactRules from "../lints/react/index.js";
-
-export default [
-  ...baseConfig,
-
-  // Browser Only
-  { languageOptions: { globals: globals.browser } },
-
-  // Enable JSX
-  { files: ["**/*.tsx"], languageOptions: { parserOptions: { ecmaFeatures: { jsx: true } } } },
-
-  // React Plugin
-  {
-    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
-    plugins: {
-      react: react,
-      "react-hooks": reactHooks,
-      "react-refresh": reactRefresh
-    },
-    settings: {
-      react: {
-        version: "detect"
-      }
-    },
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true
-        }
-      },
-      globals: {
-        ...globals.browser
-      }
-    },
-    rules: {
-      ...reactRules,
-      // ...react.configs.recommended.rules,
-      ...reactHooks.configs.recommended.rules,
-
-      // Enforce Rules of Hooks
-      "react-hooks/rules-of-hooks": ["error"],
-      // Verify the list of the dependencies for Hooks like useEffect and similar
-      "react-hooks/exhaustive-deps": ["error"],
-
-      // React Refresh
-      "react-refresh/only-export-components": ["warn", { allowConstantExport: true }]
-    }
-  }
-];

package/src/configs/stylisticFormatter.js

@@ -1,33 +0,0 @@
-import stylistic from "@stylistic/eslint-plugin";
-
-// Custom Rules
-import stylisticRules from "../lints/stylistic/index.js";
-
-export default [
-  // Stylistic Configs
-  stylistic.configs.customize({
-    jsx: true,
-    arrowParens: true,
-    flat: true,
-    blockSpacing: true,
-    braceStyle: "stroustrup",
-    commaDangle: "never",
-    indent: 2,
-    semi: true,
-    quotes: "double",
-    quoteProps: "always"
-  }),
-
-  // Stylistic Rules
-  {
-    files: ["**/*.{js,jsx,mjs,cjs,ts,tsx}"],
-    languageOptions: {
-      parserOptions: {
-        ecmaFeatures: {
-          jsx: true
-        }
-      }
-    },
-    rules: stylisticRules
-  }
-];