@peerigon/configs 4.1.0 → 4.3.0-beta.1

package/dist/semantic-release/cross-publish.js

@@ -0,0 +1,31 @@
+import { config as baseConfig } from "./base.js";
+/**
+ * @param {{ github: boolean; jsr: boolean }} options?
+ * @returns {import("semantic-release").Options}
+ */
+export const config = ({ github = false, jsr = false } = { github: true, jsr: true }) => {
+    /** @type {import("semantic-release").PluginSpec[]} */
+    const plugins = [];
+    if (baseConfig.plugins) {
+        plugins.push(...baseConfig.plugins);
+    }
+    if (github) {
+        plugins.push([
+            "@semantic-release/exec",
+            {
+                verifyConditionsCmd: 'echo "registry=https://npm.pkg.github.com/\n//npm.pkg.github.com/:_authToken=${process.env.GITHUB_TOKEN}" > /tmp/github.npmrc && npm whoami --userconfig /tmp/github.npmrc',
+                publishCmd: "npm publish --userconfig /tmp/github.npmrc --tag ${nextRelease.channel} --no-git-tag-version",
+                successCmd: "rm /tmp/github.npmrc",
+                failCmd: "rm /tmp/github.npmrc",
+            },
+        ]);
+    }
+    if (jsr) {
+        plugins.push("@sebbo2002/semantic-release-jsr");
+    }
+    return {
+        ...baseConfig,
+        plugins,
+    };
+};
+export default config();

package/dist/typescript/base.json

@@ -0,0 +1,41 @@
+{
+    // Inspired by https://www.totaltypescript.com/tsconfig-cheat-sheet
+    // and https://2ality.com/2025/01/tsconfig-json.html
+    "compilerOptions": {
+        // == Target and module settings ==
+        // Deliberately not using ESNext/NodeNext here to avoid breaking changes just by updating TypeScript.
+        "target": "es2022",
+        "module": "Preserve",
+        "moduleDetection": "force",
+        "lib": ["es2022"],
+        // == Strictness settings ==
+        "strict": true,
+        "noImplicitOverride": true,
+        // Warns about functions with implicit returns where other code paths return a value.
+        // This option is basically the same as ESLint's `consistent-return` rule.
+        "noImplicitReturns": true,
+        "noUncheckedIndexedAccess": true,
+        "noUncheckedSideEffectImports": true,
+        "noFallthroughCasesInSwitch": true,
+        // We decided to turn off `exactOptionalPropertyTypes` because it's too strict
+        // by complaining about too much unproblematic code. We may revisit this decision later.
+        "exactOptionalPropertyTypes": false,
+        // == Module resolution settings ==
+        "resolveJsonModule": true,
+        "rewriteRelativeImportExtensions": true,
+        "allowImportingTsExtensions": true,
+        // == Other settings ==
+        "allowJs": true,
+        "checkJs": true,
+        "forceConsistentCasingInFileNames": true,
+        // Using noEmit true here because you should have a separate build config anyway
+        "noEmit": true,
+        "noPropertyAccessFromIndexSignature": true,
+        // Not setting skipLibCheck: true for now because it can hide type conflicts in dependencies
+        // You can override this in your app if you can't fix it with your package manager.
+        "skipLibCheck": false,
+        "verbatimModuleSyntax": true
+    },
+    "exclude": ["${configDir}/dist"],
+    "$schema": "https://json.schemastore.org/tsconfig"
+}

package/dist/typescript/configs.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/typescript/configs.js

@@ -0,0 +1,4 @@
+// We only need this file to tell TypeScript that we want these JSON files in dist
+import "./base.json" with { type: "json" };
+import "./js-lib.json" with { type: "json" };
+import "./lib.json" with { type: "json" };

package/dist/typescript/js-lib.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./base.json",
+    "compilerOptions": {
+        "declaration": true,
+        "noEmit": false,
+        "outDir": "${configDir}/dist"
+    },
+    "$schema": "https://json.schemastore.org/tsconfig"
+}

package/dist/typescript/lib.json

@@ -0,0 +1,11 @@
+{
+    "extends": "./base.json",
+    "compilerOptions": {
+        "declaration": true,
+        "declarationMap": true,
+        "noEmit": false,
+        "outDir": "${configDir}/dist",
+        "sourceMap": true
+    },
+    "$schema": "https://json.schemastore.org/tsconfig"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peerigon/configs",
-  "version": "4.1.0",
+  "version": "4.3.0-beta.1",
   "description": "Configs for ESLint, Prettier, TypeScript & friends",
   "keywords": [
     "eslint",
@@ -21,79 +21,26 @@
   "author": "Peerigon GmbH <hello@peerigon.com>",
   "type": "module",
   "exports": {
-    "./eslint/presets/javascript-browser": {
-      "types": "./types/eslint/presets/javascript-browser.d.ts",
-      "default": "./eslint/presets/javascript-browser.js"
-    },
-    "./eslint/presets/javascript-node": {
-      "types": "./types/eslint/presets/javascript-node.d.ts",
-      "default": "./eslint/presets/javascript-node.js"
-    },
-    "./eslint/presets/javascript": {
-      "types": "./types/eslint/presets/javascript.d.ts",
-      "default": "./eslint/presets/javascript.js"
-    },
-    "./eslint/presets/typescript-node": {
-      "types": "./types/eslint/presets/typescript-node.d.ts",
-      "default": "./eslint/presets/typescript-node.js"
-    },
-    "./eslint/presets/typescript-react": {
-      "types": "./types/eslint/presets/typescript-react.d.ts",
-      "default": "./eslint/presets/typescript-react.js"
-    },
-    "./eslint/presets/typescript": {
-      "types": "./types/eslint/presets/typescript.d.ts",
-      "default": "./eslint/presets/typescript.js"
-    },
-    "./eslint/styles/jsx-no-literals": {
-      "types": "./types/eslint/styles/jsx-no-literals.d.ts",
-      "default": "./eslint/styles/jsx-no-literals.js"
-    },
-    "./eslint/styles/no-default-export": {
-      "types": "./types/eslint/styles/no-default-export.d.ts",
-      "default": "./eslint/styles/no-default-export.js"
-    },
-    "./eslint/styles/no-null": {
-      "types": "./types/eslint/styles/no-null.d.ts",
-      "default": "./eslint/styles/no-null.js"
-    },
-    "./eslint/styles/prefer-array-shorthand": {
-      "types": "./types/eslint/styles/prefer-array-shorthand.d.ts",
-      "default": "./eslint/styles/prefer-array-shorthand.js"
-    },
-    "./eslint/styles/prefer-interface": {
-      "types": "./types/eslint/styles/prefer-interface.d.ts",
-      "default": "./eslint/styles/prefer-interface.js"
-    },
-    "./prettier": {
-      "types": "./types/prettier/base.d.ts",
-      "default": "./prettier/base.js"
-    },
-    "./semantic-release": {
-      "types": "./types/semantic-release/base.d.ts",
-      "default": "./semantic-release/base.js"
-    },
-    "./semantic-release/cross-publish": {
-      "types": "./types/semantic-release/cross-publish.d.ts",
-      "default": "./semantic-release/cross-publish.js"
-    },
-    "./typescript": {
-      "default": "./typescript/base.json"
-    },
-    "./typescript/lib": {
-      "default": "./typescript/lib.json"
-    },
-    "./typescript/js-lib": {
-      "default": "./typescript/js-lib.json"
-    }
+    "./eslint/presets/javascript-browser": "./dist/eslint/presets/javascript-browser.js",
+    "./eslint/presets/javascript-node": "./dist/eslint/presets/javascript-node.js",
+    "./eslint/presets/javascript": "./dist/eslint/presets/javascript.js",
+    "./eslint/presets/typescript-node": "./dist/eslint/presets/typescript-node.js",
+    "./eslint/presets/typescript-react": "./dist/eslint/presets/typescript-react.js",
+    "./eslint/presets/typescript": "./dist/eslint/presets/typescript.js",
+    "./eslint/styles/jsx-no-literals": "./dist/eslint/styles/jsx-no-literals.js",
+    "./eslint/styles/no-default-export": "./dist/eslint/styles/no-default-export.js",
+    "./eslint/styles/no-null": "./dist/eslint/styles/no-null.js",
+    "./eslint/styles/prefer-array-shorthand": "./dist/eslint/styles/prefer-array-shorthand.js",
+    "./eslint/styles/prefer-interface": "./dist/eslint/styles/prefer-interface.js",
+    "./prettier": "./dist/prettier/base.js",
+    "./semantic-release": "./dist/semantic-release/base.js",
+    "./semantic-release/cross-publish": "./dist/semantic-release/cross-publish.js",
+    "./typescript": "./dist/typescript/base.json",
+    "./typescript/lib": "./dist/typescript/lib.json",
+    "./typescript/js-lib": "./dist/typescript/js-lib.json"
   },
   "files": [
-    "docs",
-    "eslint",
-    "prettier",
-    "semantic-release",
-    "types",
-    "typescript",
+    "dist",
     "CHANGELOG.md",
     "README.md"
   ],
@@ -110,7 +57,8 @@
     "test:types": "tsc --noEmit",
     "test:prettier": "prettier --check .",
     "build": "run-s build:*",
-    "build:types": "tsc",
+    "build:clear": "rimraf dist",
+    "build:tsc": "tsc",
     "prepublishOnly": "npm run build",
     "prepare": "husky",
     "release": "semantic-release"
@@ -152,6 +100,7 @@
     "pin-github-action": "^2.1.1",
     "prettier": "^3.5.3",
     "react": "^19.0.0",
+    "rimraf": "^6.0.1",
     "semantic-release": "^24.2.3",
     "typescript": "^5.8.2"
   },

package/eslint/README.md

@@ -1,119 +0,0 @@
-# [ESLint](https://eslint.org/) config
-
-## Installation
-
-```sh
-npm install eslint @peerigon/configs --save-dev
-```
-
-Then create a `eslint.config.js` next to your `package.json`:
-
-```js
-// We have a couple of presets for popular setups, such as typescript-react or typescript-node
-// See "Presets"
-import typescriptNodePreset from "@peerigon/configs/eslint/presets/typescript-node";
-// You can also choose from a bunch of optional coding styles
-// See "Styles"
-import stylesNoDefaultExport from "@peerigon/configs/eslint/styles/no-default-export";
-
-export default [
-  ...typescriptNodePreset,
-  // The idiomatic way to disable rules in certain directories in ESLint>=9.x is
-  // to map() over them and add `ignores` to the rule objects
-  ...stylesNoDefaultExport.map((config) => ({
-    ...config,
-    ignores: [...(config.ignores ?? []), "src/some/folder/*.ts"],
-  })),
-];
-```
-
-Recommended configuration in your `package.json` (using [`npm-run-all2`](https://www.npmjs.com/package/npm-run-all2)):
-
-```json
-{
-  "type": "module",
-  "scripts": {
-    "test": "run-p test:*",
-    "test:lint": "eslint --max-warnings 0 --cache ."
-  }
-}
-```
-
-## Presets
-
-Presets bundle all relevant rules into one `import`. They can be imported as `@peerigon/configs/eslint/presets/<preset-name>`. They **should not** be combined with each other.
-
-- `typescript-react`: Rules for React projects written in TypeScript
-- `typescript-node`: Rules for TypeScript apps that are supposed to run in Node.js
-- `typescript`: Rules for all other TypeScript projects
-- `javascript-browser`: Rules for JavaScript apps running in a browser (e.g. in combination with [JSDoc type annotations](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html))
-- `javascript-node`: Rules for JavaScript apps running in Node.js
-- `javascript`: Rules for all other JavaScript projects
-
-## Styles
-
-We acknowledge that there are certain rules where there are no actual pros and cons or where there is no clear winner. You just have to decide for one style and stick with it. We also know that some rules make sense in one project, but don't make sense in another project. Pick these rules if they make sense for you in your project. They can be imported as `@peerigon/configs/eslint/styles/<style-name>`.
-
-### `no-default-export`
-
-Forbids usage of `export default`. When using default exports, it becomes harder to name classes or functions consistently throughout the codebase since every module can pick its own name for the imported thing. Nicholas C. Zakas, the creator of ESLint, wrote [an article with more compelling arguments why he stopped using `export default`](https://humanwhocodes.com/blog/2019/01/stop-using-default-exports-javascript-module/).
-
-You may want to disable this rule in situations where a default export is required, for instance when using [React's `lazy()`](https://react.dev/reference/react/lazy).
-
-### `no-null`
-
-Forbids the usage of `null`. In a codebase it's often better to use a single non-value to represent _the absence of a value_. With the rise of default parameters and destructuring defaults, JavaScript developed a clear tendency towards `undefined`. [This issue](https://github.com/peerigon/eslint-config-peerigon/issues/71) summarizes the arguments (and trade-offs) of **null vs. undefined**.
-
-**👉 Hint:** If you use this rule, you will probably still need a single `null` value which you can refer to whenever you need to use `null` because of third-party code:
-
-```js
-// eslint-disable-next-line no-null/no-null
-export const NULL = null;
-```
-
-### `prefer-interface`
-
-Prefer TypeScript's `interface` over `type`:
-
-```ts
-interface SomeObject {
-  someProp: boolean;
-}
-```
-
-instead of
-
-```ts
-type SomeObject = {
-  someProp: boolean;
-};
-```
-
-### `prefer-array-shorthand`
-
-Enforces TypeScript arrays to use the shorthand array-style instead of the generic style:
-
-```ts
-const foo: string[] = [];
-```
-
-instead of
-
-```ts
-const foo: Array<string> = [];
-```
-
-### `jsx-no-literals`
-
-Use this style if you're using i18n. It prevents people from putting raw strings in components.
-It disallows this:
-
-```jsx
-const Hello = <div>test</div>;
-```
-
-As an escape hatch, this is still allowed:
-
-```jsx
-const Hello = <div>{"test"}</div>;
-```

package/eslint/lib/glob-patterns.js

@@ -1,11 +0,0 @@
-export const globPatterns = {
-  javascript: ["**/*.{js,mjs,cjs}"],
-  typescript: ["**/*.{ts,cts,mts}"],
-  typescriptAmbient: ["**/*.d.ts"],
-  jsx: ["**/*.jsx"],
-  typescriptJsx: ["**/*.tsx"],
-  tests: [
-    "**/*.{test,spec,stories}.{js,mjs,cjs,ts,cts,mts,jsx,tsx}",
-    "**/test{s,}/**/*.{js,mjs,cjs,ts,cts,mts,jsx,tsx}",
-  ],
-};

package/eslint/lib/rule-options.js

@@ -1,130 +0,0 @@
-const camelcase = {
-  allow: ["^UNSAFE_"], // Allows React UNSAFE_ methods
-  ignoreDestructuring: false,
-  properties: "always",
-};
-
-export const ruleOptions = {
-  ["camelcase"]: camelcase,
-  ["max-lines"]: {
-    max: 700,
-    skipBlankLines: true,
-    skipComments: true,
-  },
-  ["no-unused-expressions"]: {
-    allowShortCircuit: true,
-    allowTernary: true,
-  },
-  ["no-unused-vars"]: {
-    vars: "all",
-    varsIgnorePattern: "^_",
-    args: "after-used",
-    argsIgnorePattern: "^_",
-    caughtErrors: "all",
-    reportUsedIgnorePattern: false,
-    // This pattern is pretty common
-    ignoreRestSiblings: true,
-  },
-  ["@typescript-eslint/naming-convention"]: (() => {
-    const options = {
-      default: {
-        selector: "default",
-        format: ["camelCase", "PascalCase", "UPPER_CASE"],
-        leadingUnderscore: "allow",
-        trailingUnderscore: "allow",
-      },
-      function: {
-        selector: "function",
-        format: ["camelCase"],
-        leadingUnderscore: "allow",
-        trailingUnderscore: "allow",
-      },
-      parameter: {
-        selector: "parameter",
-        format: ["camelCase", "PascalCase"],
-        leadingUnderscore: "allow",
-        trailingUnderscore: "allow",
-      },
-      method: {
-        selector: "method",
-        format: ["camelCase"],
-        leadingUnderscore: "allow",
-        trailingUnderscore: "allow",
-      },
-      typeLike: {
-        selector: "typeLike",
-        format: ["PascalCase"],
-        leadingUnderscore: "allow",
-        trailingUnderscore: "allow",
-      },
-      enumMember: {
-        selector: "enumMember",
-        format: ["PascalCase"],
-        leadingUnderscore: "allow",
-        trailingUnderscore: "allow",
-      },
-      // In case it's destructured, we don't want to force the developer to change the casing
-      destructuring: {
-        selector: "variable",
-        modifiers: ["destructured"],
-        format: null,
-      },
-      // In case the property name requires quotes, we don't enforce any convention
-      requiresQuites: {
-        selector: [
-          "classProperty",
-          "objectLiteralProperty",
-          "typeProperty",
-          "classMethod",
-          "objectLiteralMethod",
-          "typeMethod",
-          "accessor",
-          "enumMember",
-        ],
-        modifiers: ["requiresQuotes"],
-        format: null,
-      },
-      // We don't enforce any convention on object literals since these are often used
-      // for data object where we're not in control of the type (e.g. an api that takes camel_case properties)
-      objectLiteralProperty: {
-        selector: "objectLiteralProperty",
-        format: null,
-      },
-    };
-
-    // By enumerating all selectors explicitly we increase the
-    // specificity of these rules.
-    const escapeHatches = [
-      "variable",
-      "function",
-      "parameter",
-      "property",
-      "parameterProperty",
-      "method",
-      "accessor",
-      "enumMember",
-      "class",
-      "interface",
-      "typeAlias",
-      "enum",
-      "typeParameter",
-    ].map((selector) => ({
-      filter: {
-        match: true,
-        // UNSAFE_ is a prefix used by React for all lifecycle hooks that are about to be deprecated
-        regex: "^(__|UNSAFE_).+$",
-      },
-      format: null,
-      selector,
-    }));
-
-    return {
-      ...options,
-      defaultRules: [...Object.values(options), ...escapeHatches],
-      ignoreProperties: {
-        selector: "property",
-        format: null,
-      },
-    };
-  })(),
-};

package/eslint/presets/javascript.test/eslint.config.js

@@ -1 +0,0 @@
-export { default } from "../javascript-node.js";

package/eslint/presets/javascript.test/main.js

@@ -1,62 +0,0 @@
-//@ts-nocheck
-// prettier-ignore
-import { a } from "./other.js";
-// eslint-disable-next-line no-duplicate-imports
-import { b } from "./other.js";
-
-// eslint-disable-next-line array-callback-return
-[1, 2, 3].reduce((memo, item, index) => {
-  memo[item] = index;
-});
-
-for (const number of [1, 2, 3]) {
-  // eslint-disable-next-line no-await-in-loop
-  await Promise.resolve(number);
-}
-
-(class {
-  constructor() {
-    // eslint-disable-next-line no-constructor-return
-    return 1;
-  }
-})();
-
-// eslint-disable-next-line no-promise-executor-return
-void new Promise(() => 2);
-
-// eslint-disable-next-line no-self-compare
-if (a === a) {
-  void (a, b);
-}
-
-// eslint-disable-next-line no-template-curly-in-string
-void "Hello ${name}!";
-
-// eslint-disable-next-line no-unmodified-loop-condition
-while (a) {
-  void a;
-}
-
-// eslint-disable-next-line no-unreachable-loop
-for (let index = 0; index < 3; index++) {
-  break;
-}
-
-// eslint-disable-next-line no-useless-assignment
-let id = "x1234";
-id = 2;
-void id;
-
-try {
-  /* empty */
-  // eslint-disable-next-line unicorn/catch-error-name
-} catch (bla) {
-  void bla;
-}
-
-let c = 1;
-// eslint-disable-next-line unicorn/prefer-top-level-await
-(async () => {
-  // eslint-disable-next-line require-atomic-updates
-  c += await c;
-})();

package/eslint/presets/javascript.test/other.js

@@ -1,2 +0,0 @@
-export const a = 1;
-export const b = 2;

package/eslint/presets/typescript-react.test/App.tsx

@@ -1,47 +0,0 @@
-import { useEffect, useRef, useState } from "react";
-import { Other } from "./Other.tsx";
-
-export const App = (_props: { name: string; count: number }) => {
-  for (let index = 0; index < 10; index++) {
-    // eslint-disable-next-line react-compiler/react-compiler
-    // eslint-disable-next-line react-hooks/rules-of-hooks
-    useEffect(() => {
-      void index;
-
-      // eslint-disable-next-line react-compiler/react-compiler
-      // eslint-disable-next-line react-hooks/exhaustive-deps
-    }, []);
-  }
-
-  // eslint-disable-next-line @eslint-react/naming-convention/use-state
-  const [state, updateState] = useState(0);
-
-  useEffect(() => {
-    // eslint-disable-next-line @eslint-react/hooks-extra/no-direct-set-state-in-use-effect
-    updateState(1);
-  }, [state]);
-
-  return (
-    <>
-      {/* eslint-disable-next-line jsx-a11y/alt-text */}
-      <img src="some-image.jpg" />
-      {/* eslint-disable-next-line react/jsx-curly-brace-presence */}
-      {"Hello world"}
-      {/* eslint-disable-next-line @eslint-react/no-leaked-conditional-rendering */}
-      <>{_props.count && <view />}</>
-      <Other />
-    </>
-  );
-};
-
-// eslint-disable-next-line react-refresh/only-export-components
-export const doesntWorkWithHmr = () => {};
-
-export const InvalidRefAccessDuringRender = () => {
-  const ref = useRef(null);
-  // eslint-disable-next-line react-compiler/react-compiler
-  const value = ref.current;
-  return value;
-};
-
-<App name="John" count={0} />;

package/eslint/presets/typescript-react.test/Other.tsx

@@ -1,5 +0,0 @@
-// Missing React import should not be reported
-
-export const Other = () => {
-  return <h1>Hello World</h1>;
-};

package/eslint/presets/typescript-react.test/eslint.config.js

@@ -1 +0,0 @@
-export { default } from "../typescript-react.js";

package/eslint/presets/typescript-react.test/tsconfig.json

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

package/eslint/presets/typescript.test/eslint.config.js

@@ -1 +0,0 @@
-export { default } from "../typescript-node.js";