@peerigon/configs 1.0.0-beta.1

package/eslint/rules/typescript.js

@@ -0,0 +1,198 @@
+import preferArrow from "eslint-plugin-prefer-arrow";
+import tsEslint from "typescript-eslint";
+import { globPatterns } from "../lib/glob-patterns.js";
+import { ruleOptions } from "../lib/rule-options.js";
+
+// Type annotation doesn't work here because of type inconsistencies
+// between eslint and typescript-eslint.
+/*
+ * @type {Array<import("eslint").Linter.Config>}
+ */
+export const typescript = tsEslint.config(
+  ...tsEslint.configs.strictTypeChecked,
+  ...tsEslint.configs.stylisticTypeChecked,
+  /** @type {import("eslint").Linter.Config} */
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+      },
+    },
+  },
+  /** @type {import("eslint").Linter.Config} */
+  {
+    files: [
+      globPatterns.typescript,
+      globPatterns.typescriptAmbient,
+      globPatterns.typescriptJsx,
+    ],
+    plugins: {
+      ["prefer-arrow"]: preferArrow,
+    },
+    rules: {
+      "@typescript-eslint/array-type": ["warn", { default: "generic" }],
+      "@typescript-eslint/ban-ts-comment": [
+        // https://typescript-eslint.io/rules/ban-ts-comment
+        "warn",
+        {
+          "ts-expect-error": "allow-with-description",
+        },
+      ],
+      "@typescript-eslint/class-literal-property-style": "off", // https://typescript-eslint.io/rules/class-literal-property-style
+      "@typescript-eslint/consistent-type-definitions": ["warn", "type"], // https://typescript-eslint.io/rules/consistent-type-definitions
+      "@typescript-eslint/explicit-member-accessibility": [
+        // https://typescript-eslint.io/rules/explicit-member-accessibility
+        "warn",
+        {
+          accessibility: "no-public",
+          overrides: {
+            parameterProperties: "explicit",
+          },
+        },
+      ],
+      "@typescript-eslint/method-signature-style": ["warn", "property"], // https://typescript-eslint.io/rules/method-signature-style
+      "@typescript-eslint/naming-convention": [
+        // https://typescript-eslint.io/rules/naming-convention
+        "warn",
+        ...ruleOptions["@typescript-eslint/naming-convention"].defaultRules,
+      ],
+      "@typescript-eslint/no-base-to-string": "off", // https://typescript-eslint.io/rules/no-base-to-string
+      "@typescript-eslint/no-confusing-void-expression": [
+        // https://typescript-eslint.io/rules/no-confusing-void-expression
+        "off",
+        {
+          ignoreArrowShorthand: true,
+          ignoreVoidOperator: true,
+        },
+      ],
+      "@typescript-eslint/no-empty-function": "off", // https://typescript-eslint.io/rules/no-empty-function
+      "@typescript-eslint/no-empty-interface": "off", // https://typescript-eslint.io/rules/no-empty-interface
+      // `any` is sometimes useful for small and abstract functions.
+      // Should only be used in isolated parts of the codebase.
+      // Appropriate usage can only be checked in a PR review.
+      "@typescript-eslint/no-explicit-any": [
+        // https://typescript-eslint.io/rules/no-explicit-any
+        "off",
+        {
+          fixToUnknown: false,
+          ignoreRestArgs: true,
+        },
+      ],
+      "@typescript-eslint/no-non-null-assertion": "off", // https://typescript-eslint.io/rules/no-non-null-assertion
+      "@typescript-eslint/no-unnecessary-boolean-literal-compare": "off", // https://typescript-eslint.io/rules/no-unnecessary-boolean-literal-compare
+      "@typescript-eslint/no-unnecessary-condition": [
+        "warn",
+        {
+          allowConstantLoopConditions: true,
+        },
+      ], // https://typescript-eslint.io/rules/no-unnecessary-condition
+      "@typescript-eslint/no-unnecessary-qualifier": "warn", // https://typescript-eslint.io/rules/no-unnecessary-qualifier
+      "@typescript-eslint/no-unsafe-argument": "off", // https://typescript-eslint.io/rules/no-unsafe-argument
+      "@typescript-eslint/no-unsafe-assignment": "off", // https://typescript-eslint.io/rules/no-unsafe-assignment
+      "@typescript-eslint/no-unsafe-call": "off", // https://typescript-eslint.io/rules/no-unsafe-call
+      "@typescript-eslint/no-unsafe-member-access": "off", // https://typescript-eslint.io/rules/no-unsafe-member-access
+      "@typescript-eslint/no-unused-expressions": [
+        // https://typescript-eslint.io/rules/no-unused-expressions
+        "warn",
+        {
+          allowShortCircuit: true,
+          allowTernary: true,
+        },
+      ],
+      "@typescript-eslint/no-unused-vars": [
+        // https://typescript-eslint.io/rules/no-unused-vars
+        "error",
+        ruleOptions["no-unused-vars"],
+      ],
+      "@typescript-eslint/promise-function-async": [
+        // https://typescript-eslint.io/rules/promise-function-async
+        "warn",
+        {
+          allowAny: true,
+          allowedPromiseNames: [],
+          checkArrowFunctions: true,
+          checkFunctionDeclarations: true,
+          checkFunctionExpressions: true,
+          checkMethodDeclarations: true,
+        },
+      ],
+      "@typescript-eslint/require-await": "off", // https://typescript-eslint.io/rules/require-await
+      "@typescript-eslint/restrict-plus-operands": "off", // https://typescript-eslint.io/rules/restrict-plus-operands
+      "@typescript-eslint/restrict-template-expressions": [
+        // https://typescript-eslint.io/rules/restrict-template-expressions
+        "off",
+        {
+          allowBoolean: false,
+          allowNullable: false,
+          allowNumber: true,
+        },
+      ],
+      "no-return-await": "off",
+      "@typescript-eslint/return-await": ["warn", "in-try-catch"], // https://typescript-eslint.io/rules/return-await
+      "@typescript-eslint/switch-exhaustiveness-check": "warn", // https://typescript-eslint.io/rules/switch-exhaustiveness-check
+      camelcase: "off",
+      "max-lines": [
+        "warn",
+        {
+          max: 1400,
+          skipBlankLines: true,
+          skipComments: true,
+        },
+      ],
+      "func-style": ["warn", "expression"], // https://eslint.org/docs/latest/rules/func-style
+      "prefer-arrow/prefer-arrow-functions": [
+        // https://github.com/TristonJ/eslint-plugin-prefer-arrow
+        "warn",
+        {
+          disallowPrototype: false,
+          singleReturnOnly: false,
+          // We used to enforce arrow functions also for class methods (as class properties)
+          // but arrow functions in sub-classes can't call their overridden counterpart
+          // in their super-class, see https://stackoverflow.com/a/52823577
+          classPropertiesAllowed: false,
+        },
+      ],
+      "@typescript-eslint/use-unknown-in-catch-callback-variable": "off", // https://typescript-eslint.io/rules/use-unknown-in-catch-callback-variable
+    },
+  },
+  /** @type {import("eslint").Linter.Config} */
+  {
+    files: globPatterns.typescriptAmbient,
+    rules: {
+      // In d.ts files it might be necessary to merge an existing interface
+      "@typescript-eslint/consistent-type-definitions": "off", // https://typescript-eslint.io/rules/consistent-type-definitions
+      // In d.ts files it's sometimes necessary to overload existing methods
+      "@typescript-eslint/method-signature-style": "off", // https://typescript-eslint.io/rules/method-signature-style
+      "@typescript-eslint/naming-convention": "off", // https://typescript-eslint.io/rules/naming-convention
+      // Unused vars can be common in d.ts files when declaration merging is used
+      "@typescript-eslint/no-unused-vars": "off", // https://typescript-eslint.io/rules/no-unused-vars
+      // Since d.ts files are used to type external modules, we can't control the coding style
+      "import/no-default-export": "off",
+      // When someone wants to extend the typings of a third-party module, it might
+      // be necessary to import the module so that TypeScript finds the typings that should be extended.
+      // This is a better alternative to the triple-slash directive
+      "import/no-unassigned-import": "off",
+    },
+  },
+  /** @type {import("eslint").Linter.Config} */
+  {
+    files: globPatterns.tests,
+    rules: {
+      // Type assertions are quite common in tests
+      "@typescript-eslint/consistent-type-assertions": "off", // https://typescript-eslint.io/rules/consistent-type-assertions
+      // Mocking often requires to mock objects with a different naming convention
+      "@typescript-eslint/naming-convention": "off", // https://typescript-eslint.io/rules/naming-convention
+      // We allow any to be used in tests, so returning it is ok
+      "@typescript-eslint/no-unsafe-return": "off", // https://typescript-eslint.io/rules/no-unsafe-return
+      // chai uses these as assertions
+      "@typescript-eslint/no-unused-expressions": "off", // https://typescript-eslint.io/rules/no-unused-expressions
+      // It's uncommon to use async/await in Cypress tests
+      // https://docs.cypress.io/guides/core-concepts/introduction-to-cypress.html#Commands-Are-Asynchronous
+      "@typescript-eslint/promise-function-async": "off", // https://typescript-eslint.io/rules/promise-function-async
+      // Passing functions around like this can be common with mocking
+      "@typescript-eslint/unbound-method": "off", // https://typescript-eslint.io/rules/unbound-method
+    },
+  },
+);
+
+export default typescript;

package/eslint/styles/jsx-no-literals.js

@@ -0,0 +1,31 @@
+import { globPatterns } from "../lib/glob-patterns.js";
+
+/** @type {import("eslint").Linter.Config[]} */
+export const jsxNoLiterals = [
+  {
+    files: [globPatterns.jsx, globPatterns.typescriptJsx],
+    rules: {
+      // If we don't adjust this rule, it would autofix the escape hatch
+      // {"some string"} allowed by "jsx-no-literals"
+      "react/jsx-curly-brace-presence": [
+        // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-curly-brace-presence.md
+        "warn",
+        {
+          children: "always",
+          props: "never",
+        },
+      ],
+      "react/jsx-no-literals": "warn", // https://github.com/jsx-eslint/eslint-plugin-react/blob/master/docs/rules/jsx-no-literals.md
+    },
+  },
+  {
+    files: globPatterns.tests,
+    rules: {
+      // It's quite common in tests to use example strings
+      "react/jsx-curly-brace-presence": ["warn", "never"],
+      "react/jsx-no-literals": "off",
+    },
+  },
+];
+
+export default jsxNoLiterals;

package/eslint/styles/jsx-no-literals.test/eslint.config.js

@@ -0,0 +1,4 @@
+import typescriptReact from "../../presets/typescript-react.js";
+import { jsxNoLiterals } from "../jsx-no-literals.js";
+
+export default [...typescriptReact, ...jsxNoLiterals];

package/eslint/styles/jsx-no-literals.test/main.tsx

@@ -0,0 +1,4 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+// eslint-disable-next-line react/jsx-no-literals, react/jsx-curly-brace-presence
+const shouldError = <div>test</div>;
+const shouldBeOk = <div>{"test"}</div>;

package/eslint/styles/jsx-no-literals.test/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["../../../typescript/base.json"],
+  "compilerOptions": {
+    "jsx": "react-jsx"
+  },
+  "include": ["**/*"]
+}

package/eslint/styles/no-default-export.js

@@ -0,0 +1,19 @@
+/** @type {import("eslint").Linter.Config[]} */
+export const noDefaultExport = [
+  {
+    // Config files often have a single default export
+    ignores: ["*.config.js"],
+    rules: {
+      "no-restricted-syntax": [
+        "error",
+        {
+          selector: "ExportDefaultDeclaration",
+          message: "Prefer named exports",
+        },
+      ],
+    },
+  },
+];
+
+// Such irony... 🙃
+export default noDefaultExport;

package/eslint/styles/no-default-export.test/eslint.config.js

@@ -0,0 +1,4 @@
+import typescriptReact from "../../presets/typescript-react.js";
+import { noDefaultExport } from "../no-default-export.js";
+
+export default [...typescriptReact, ...noDefaultExport];

package/eslint/styles/no-default-export.test/main.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line no-restricted-syntax
+export default "Should not work";

package/eslint/styles/no-default-export.test/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../../typescript/base.json"],
+  "include": ["**/*"]
+}

package/eslint/styles/no-null.js

@@ -0,0 +1,10 @@
+/** @type {import("eslint").Linter.Config[]} */
+export const noNull = [
+  {
+    rules: {
+      "unicorn/no-null": "error",
+    },
+  },
+];
+
+export default noNull;

package/eslint/styles/no-null.test/eslint.config.js

@@ -0,0 +1,4 @@
+import typescriptReact from "../../presets/typescript-react.js";
+import { noNull } from "../no-null.js";
+
+export default [...typescriptReact, ...noNull];

package/eslint/styles/no-null.test/main.ts

@@ -0,0 +1,2 @@
+// eslint-disable-next-line unicorn/no-null
+export const shouldError = null;

package/eslint/styles/no-null.test/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../../typescript/base.json"],
+  "include": ["**/*"]
+}

package/eslint/styles/prefer-array-shorthand.js

@@ -0,0 +1,15 @@
+/** @type {import("eslint").Linter.Config[]} */
+export const preferArrayShorthand = [
+  {
+    rules: {
+      "@typescript-eslint/array-type": [
+        "warn",
+        {
+          default: "array",
+        },
+      ],
+    },
+  },
+];
+
+export default preferArrayShorthand;

package/eslint/styles/prefer-array-shorthand.test/eslint.config.js

@@ -0,0 +1,4 @@
+import typescriptReact from "../../presets/typescript-react.js";
+import { preferArrayShorthand } from "../prefer-array-shorthand.js";
+
+export default [...typescriptReact, ...preferArrayShorthand];

package/eslint/styles/prefer-array-shorthand.test/main.ts

@@ -0,0 +1,4 @@
+// eslint-disable-next-line @typescript-eslint/array-type
+export type ShouldError1 = Array<string>;
+// eslint-disable-next-line @typescript-eslint/array-type
+export type ShouldError2 = Array<string | number>;

package/eslint/styles/prefer-array-shorthand.test/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../../typescript/base.json"],
+  "include": ["**/*"]
+}

package/eslint/styles/prefer-interface.js

@@ -0,0 +1,10 @@
+/** @type {import("eslint").Linter.Config[]} */
+export const preferInterface = [
+  {
+    rules: {
+      "@typescript-eslint/consistent-type-definitions": ["warn", "interface"], // https://typescript-eslint.io/rules/consistent-type-definitions
+    },
+  },
+];
+
+export default preferInterface;

package/eslint/styles/prefer-interface.test/eslint.config.js

@@ -0,0 +1,4 @@
+import typescriptReact from "../../presets/typescript-react.js";
+import { preferInterface } from "../prefer-interface.js";
+
+export default [...typescriptReact, ...preferInterface];

package/eslint/styles/prefer-interface.test/main.ts

@@ -0,0 +1,8 @@
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+export type ShouldError = {
+  name: string;
+};
+
+export interface ShouldWork {
+  name: string;
+}

package/eslint/styles/prefer-interface.test/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["../../../typescript/base.json"],
+  "include": ["**/*"]
+}

package/eslint/types.d.ts

@@ -0,0 +1,48 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+declare module "eslint-plugin-react" {
+  const config: {
+    rules: { [name: string]: any };
+    languageOptions: { [name: string]: any };
+  };
+
+  export default {
+    configs: {
+      flat: {
+        recommended: config,
+        ["jsx-runtime"]: config,
+      },
+    },
+  };
+}
+
+declare module "eslint-plugin-prefer-arrow" {
+  const config: {
+    rules: { [name: string]: any };
+  };
+
+  export default config;
+}
+
+declare module "eslint-plugin-react-compiler" {
+  const config: {
+    rules: { [name: string]: any };
+  };
+
+  export default config;
+}
+
+declare module "eslint-plugin-react-hooks" {
+  const config: {
+    rules: { [name: string]: any };
+  };
+
+  export default config;
+}
+
+declare module "eslint-plugin-react-refresh" {
+  const config: {
+    rules: { [name: string]: any };
+  };
+
+  export default config;
+}

package/package.json

@@ -0,0 +1,108 @@
+{
+  "name": "@peerigon/configs",
+  "version": "1.0.0-beta.1",
+  "description": "Configs for ESLint, Prettier, TypeScript & friends",
+  "keywords": [
+    "eslint",
+    "peerigon",
+    "configs",
+    "typescript",
+    "prettier"
+  ],
+  "homepage": "https://github.com/peerigon/configs#readme",
+  "bugs": {
+    "url": "https://github.com/peerigon/configs/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/peerigon/configs.git"
+  },
+  "license": "MIT",
+  "author": "Peerigon GmbH <hello@peerigon.com>",
+  "type": "module",
+  "exports": {
+    "./eslint/presets/javascript-browser": "./eslint/presets/javascript-browser.js",
+    "./eslint/presets/javascript-node": "./eslint/presets/javascript-node.js",
+    "./eslint/presets/javascript": "./eslint/presets/javascript.js",
+    "./eslint/presets/typescript-node": "./eslint/presets/typescript-node.js",
+    "./eslint/presets/typescript-react": "./eslint/presets/typescript-react.js",
+    "./eslint/presets/typescript": "./eslint/presets/typescript.js",
+    "./eslint/styles/jsx-no-literals": "./eslint/styles/jsx-no-literals.js",
+    "./eslint/styles/no-default-export": "./eslint/styles/no-default-export.js",
+    "./eslint/styles/no-null": "./eslint/styles/no-null.js",
+    "./eslint/styles/prefer-array-shorthand": "./eslint/styles/prefer-array-shorthand.js",
+    "./eslint/styles/prefer-interface": "./eslint/styles/prefer-interface.js",
+    "./prettier": "./prettier/base.js",
+    "./typescript": "./typescript/base.js"
+  },
+  "files": [
+    "eslint",
+    "prettier",
+    "typescript"
+  ],
+  "scripts": {
+    "test": "run-p test:presets:* test:styles:*",
+    "test:presets:javascript": "cd eslint/presets/javascript.test; eslint --max-warnings 0 .",
+    "test:presets:typescript": "cd eslint/presets/typescript.test; eslint --max-warnings 0 .",
+    "test:presets:typescript-react": "cd eslint/presets/typescript-react.test; eslint --max-warnings 0 .",
+    "test:styles:jsx-no-literals": "cd eslint/styles/jsx-no-literals.test; eslint --max-warnings 0 .",
+    "test:styles:no-default-export": "cd eslint/styles/no-default-export.test; eslint --max-warnings 0 .",
+    "test:styles:no-null": "cd eslint/styles/no-null.test; eslint --max-warnings 0 .",
+    "test:styles:prefer-array-shorthand": "cd eslint/styles/prefer-array-shorthand.test; eslint --max-warnings 0 .",
+    "test:styles:prefer-interface": "cd eslint/styles/prefer-interface.test; eslint --max-warnings 0 .",
+    "test:types": "tsc",
+    "test:prettier": "prettier --check .",
+    "prepare": "husky",
+    "release": "semantic-release"
+  },
+  "lint-staged": {
+    ".github/workflows/*.{yml,yaml}": [
+      "pin-github-action --allow-empty"
+    ],
+    "*.{js,jsx,ts,tsx,css,md,yml,yaml}": "prettier --write"
+  },
+  "dependencies": {
+    "@eslint-react/eslint-plugin": "^1.15.2",
+    "@eslint/compat": "^1.2.2",
+    "@eslint/js": "^9.14.0",
+    "@ianvs/prettier-plugin-sort-imports": "^4.3.1",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jsx-a11y": "^6.10.2",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react-compiler": "^19.0.0-beta-63b359f-20241101",
+    "eslint-plugin-react-hooks": "^5.0.0",
+    "eslint-plugin-react-refresh": "^0.4.14",
+    "eslint-plugin-unicorn": "^56.0.0",
+    "globals": "^15.12.0",
+    "prettier-plugin-css-order": "^2.1.2",
+    "prettier-plugin-jsdoc": "^1.3.0",
+    "prettier-plugin-packagejson": "^2.5.3",
+    "prettier-plugin-tailwindcss": "^0.6.8",
+    "typescript-eslint": "^8.13.0"
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
+    "@types/eslint-config-prettier": "^6.11.3",
+    "@types/eslint-plugin-jsx-a11y": "^6.9.0",
+    "@types/eslint__js": "^8.42.3",
+    "@types/node": "^22.9.0",
+    "@types/react": "^18.3.12",
+    "eslint": "^9.14.0",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
+    "npm-run-all": "^4.1.5",
+    "pin-github-action": "^1.9.1",
+    "prettier": "^3.3.3",
+    "react": "^18.3.1",
+    "semantic-release": "^24.2.0",
+    "typescript": "5.6.3"
+  },
+  "peerDependencies": {
+    "eslint": "^9.10.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}

package/prettier/base.js

@@ -0,0 +1,30 @@
+/**
+ * @param {string} id
+ * @returns {string}
+ */
+const safeResolve = (id) => {
+  return "resolve" in import.meta
+    ? import.meta.resolve(id).slice("file://".length)
+    : id;
+};
+
+// Using safeResolve() here because the plugins might not be installed in the parent app/module
+// and we don't want to rely on the package manager to hoist the dependencies.
+const plugins = await Promise.all([
+  safeResolve("@ianvs/prettier-plugin-sort-imports"),
+  safeResolve("prettier-plugin-jsdoc"),
+  safeResolve("prettier-plugin-packagejson"),
+  safeResolve("prettier-plugin-css-order"),
+  safeResolve("prettier-plugin-tailwindcss"),
+]);
+
+export default {
+  plugins,
+  importOrderParserPlugins: [
+    "typescript",
+    "jsx",
+    "decorators",
+    "importAttributes",
+  ],
+  importOrderTypeScriptVersion: "5.0.0",
+};

package/typescript/base.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "esModuleInterop": true,
+    "exactOptionalPropertyTypes": true,
+    "forceConsistentCasingInFileNames": true,
+    "isolatedModules": true,
+    "module": "NodeNext",
+    "noEmit": true, // If code should be emitted, it's recommended to create a separate tsconfig.build.json file
+    "noImplicitOverride": true,
+    "noImplicitReturns": true,
+    "noPropertyAccessFromIndexSignature": true,
+    "noUncheckedIndexedAccess": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "target": "ESNext"
+  },
+  "$schema": "https://json.schemastore.org/tsconfig"
+}