@peerigon/configs 1.0.0-beta.18 → 1.0.0-beta.19

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [1.0.0-beta.19](https://github.com/peerigon/configs/compare/v1.0.0-beta.18...v1.0.0-beta.19) (2025-01-27)
+
+### Features
+
+- Enable .ts imports ([781a4a9](https://github.com/peerigon/configs/commit/781a4a97e15df6b218959c76c62a2e0893b3c026))
+- Update dependencies ([839e69c](https://github.com/peerigon/configs/commit/839e69cdfef60349772479b7f5a7105c81be9d93))
+
 # [1.0.0-beta.18](https://github.com/peerigon/configs/compare/v1.0.0-beta.17...v1.0.0-beta.18) (2025-01-26)
 
 ### Features

package/README.md

@@ -24,11 +24,22 @@ Also checkout the instructions for each respective config:
 
 ## Philosophy
 
-Our rules aim to prevent as many bugs and security vulnerabilities as possible and make refactoring easier. At the same time, they should stay out of the way as much as possible.
+Linting, formatting and type-checking rules are always a balance between:
+
+- ease of reading
+- ease of refactoring
+- ease of writing.
+
+We think that:
+
+- code is read more often than refactored
+- and refactored more often than written from scratch.
+
+Our configs have been designed with these assumptions in mind.
 
 ### Formatting
 
-Formatting should follow the community standard. Our config is entirely based on Prettier's default config. Besides that, it also:
+Formatting should follow the community standard. Our config is therefore based on Prettier's default config. Besides that it also:
 
 - auto-sorts `import` statements
 - formats JSDoc comments
@@ -36,6 +47,8 @@ Formatting should follow the community standard. Our config is entirely based on
 - formats and sorts CSS properties
 - sorts Tailwind CSS class names
 
+This makes git diffs smaller and reviewing them more focussed.
+
 ### Linting
 
 Linting should mostly catch bugs in the control flow and prevent security issues. Furthermore, it should enforce a modern, idiomatic and consistent code style that is easy to read and to refactor.

package/eslint/README.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```sh
-npm install @peerigon/configs
+npm install eslint @peerigon/configs --save-dev
 ```
 
 Then create a `eslint.config.js` next to your `package.json`:
@@ -46,7 +46,7 @@ Presets bundle all relevant rules into one `import`. They can be imported as `@p
 - `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)
+- `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
 
@@ -73,20 +73,25 @@ export const NULL = null;
 
 ### `prefer-interface`
 
-[Prefer TypeScript's `interface` over `type`](https://typescript-eslint.io/rules/consistent-type-definitions/).
+Prefer TypeScript's `interface` over `type`:
 
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/typescript",
-        "peerigon/styles/prefer-interface"
-    ],
+```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.
-It enforces this:
+Enforces TypeScript arrays to use the shorthand array-style instead of the generic style:
 
 ```ts
 const foo: string[] = [];

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

@@ -1,4 +1,5 @@
 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++) {
@@ -28,6 +29,7 @@ export const App = (_props: { name: string; count: number }) => {
       {"Hello world"}
       {/* eslint-disable-next-line @eslint-react/no-leaked-conditional-rendering */}
       <>{_props.count && <view />}</>
+      <Other />
     </>
   );
 };

package/eslint/presets/typescript.test/main.ts

@@ -1,4 +1,4 @@
-import { getMessage } from "./message.js";
+import { getMessage } from "./message.ts";
 // Check if import attributes are detected and formatted correctly
 import test from "./test.json" with { type: "json" };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peerigon/configs",
-  "version": "1.0.0-beta.18",
+  "version": "1.0.0-beta.19",
   "description": "Configs for ESLint, Prettier, TypeScript & friends",
   "keywords": [
     "eslint",
@@ -122,48 +122,60 @@
     "*.{js,jsx,ts,tsx,css,md,yml,yaml}": "prettier --write"
   },
   "dependencies": {
-    "@eslint-react/eslint-plugin": "^1.16.1",
-    "@eslint/compat": "^1.2.3",
-    "@eslint/js": "9.14.0",
-    "@ianvs/prettier-plugin-sort-imports": "^4.4.0",
+    "@eslint-react/eslint-plugin": "^1.24.1",
+    "@eslint/compat": "^1.2.5",
+    "@eslint/js": "^9.19.0",
+    "@ianvs/prettier-plugin-sort-imports": "^4.4.1",
     "@types/eslint-config-prettier": "^6.11.3",
-    "@types/eslint-plugin-jsx-a11y": "^6.9.0",
+    "@types/eslint-plugin-jsx-a11y": "^6.10.0",
     "@types/eslint__js": "^8.42.3",
-    "eslint-config-prettier": "^9.1.0",
+    "eslint-config-prettier": "^10.0.1",
     "eslint-plugin-jsx-a11y": "^6.10.2",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-react": "^7.37.2",
+    "eslint-plugin-react": "^7.37.4",
     "eslint-plugin-react-compiler": "^19.0.0-beta-a7bf2bd-20241110",
-    "eslint-plugin-react-hooks": "^5.0.0",
-    "eslint-plugin-react-refresh": "^0.4.14",
-    "eslint-plugin-unicorn": "^56.0.0",
-    "globals": "^15.12.0",
+    "eslint-plugin-react-hooks": "^5.1.0",
+    "eslint-plugin-react-refresh": "^0.4.18",
+    "eslint-plugin-unicorn": "^56.0.1",
+    "globals": "^15.14.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.14.0"
+    "prettier-plugin-jsdoc": "^1.3.2",
+    "prettier-plugin-packagejson": "^2.5.8",
+    "prettier-plugin-tailwindcss": "^0.6.11",
+    "typescript-eslint": "^8.21.0"
   },
   "devDependencies": {
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/exec": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "@types/node": "^22.9.0",
-    "@types/react": "^18.3.12",
-    "eslint": "9.14.0",
-    "husky": "^9.1.6",
-    "lint-staged": "^15.2.10",
+    "@types/node": "^22.10.10",
+    "@types/react": "^19.0.8",
+    "eslint": "^9.19.0",
+    "husky": "^9.1.7",
+    "lint-staged": "^15.4.3",
     "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"
+    "pin-github-action": "^2.0.2",
+    "prettier": "^3.4.2",
+    "react": "^19.0.0",
+    "semantic-release": "^24.2.1",
+    "typescript": "^5.7.3"
   },
   "peerDependencies": {
-    "eslint": "^9.0.0",
-    "prettier": "^3.3.3",
-    "typescript": "^5.6.3"
+    "eslint": "^9.19.0",
+    "prettier": "^3.4.2",
+    "semantic-release": "^24.2.1",
+    "typescript": "^5.7.3"
+  },
+  "peerDependenciesMeta": {
+    "eslint": {
+      "optional": true
+    },
+    "prettier": {
+      "optional": true
+    },
+    "typescript": {
+      "optional": true
+    }
   },
   "publishConfig": {
     "access": "public",

package/prettier/README.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```sh
-npm install @peerigon/configs
+npm install prettier @peerigon/configs --save-dev
 ```
 
 Then create a `prettier.config.js` next to your `package.json`:

package/semantic-release/README.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```sh
-npm install @peerigon/configs
+npm install semantic-release @peerigon/configs --save-dev
 ```
 
 Then create a `.releaserc.json` next to your `package.json`:
@@ -23,12 +23,15 @@ Recommended configuration in your `package.json`:
     "release": "semantic-release"
   },
   "publishConfig": {
-    "access": "public", // only if the package is supposed to be public
+    "//": "only if the package is supposed to be public"
+    "access": "public",
     "provenance": true
   }
 }
 ```
 
+`"provenance": true` will generate [provenance statements](https://docs.npmjs.com/generating-provenance-statements) in case your Github actions has the correct permissions (see below).
+
 Recommended Github action:
 
 ```yaml
@@ -61,7 +64,8 @@ jobs:
       # ...
       - name: 🚀 Release
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          # GITHUB_TOKEN is only necessary if you want to publish to Github
+          # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
         run: |
           npm run release

package/types/eslint/presets/javascript.test/other.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"other.d.ts","sourceRoot":"","sources":["../../../../eslint/presets/javascript.test/other.js"],"names":[],"mappings":"AAAA,kBAAmB;AACnB,kBAAmB"}
+{"version":3,"file":"other.d.ts","sourceRoot":"","sources":["../../../../eslint/presets/javascript.test/other.js"],"names":[],"mappings":"AAAA,gBAAiB,CAAC,CAAC;AACnB,gBAAiB,CAAC,CAAC"}

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

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../../eslint/styles/no-default-export.test/main.ts"],"names":[],"mappings":";AACA,wBAAiC"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../../../../eslint/styles/no-default-export.test/main.ts"],"names":[],"mappings":"wBACe,iBAAiB;AAAhC,wBAAiC"}

package/typescript/README.md

@@ -3,7 +3,7 @@
 ## Installation
 
 ```sh
-npm install @peerigon/configs
+npm install typescript @peerigon/configs --save-dev
 ```
 
 Then create a `tsconfig.json` just for type-checking next to your `package.json`:
@@ -55,4 +55,4 @@ We export the following `tsconfig.json` presets. They can be used by extending `
 
 - `typescript`: Recommended base config for all modern TypeScript projects
 - `typescript/lib`: Config for building TS libraries
-- `typescript/js-lib`: Config for building JS libraries with [TS JSDoc annotations](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html).
+- `typescript/js-lib`: Config for building JS libraries with [JSDoc type annotations](https://www.typescriptlang.org/docs/handbook/jsdoc-supported-types.html).

package/typescript/base.json

@@ -1,9 +1,13 @@
 {
   "compilerOptions": {
+    "allowImportingTsExtensions": true,
     "checkJs": true,
+    // TODO: Enable erasableSyntaxOnly when TS 5.8 is released
+    // https://www.totaltypescript.com/erasable-syntax-only
+    // "erasableSyntaxOnly": true,
     "esModuleInterop": 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.
+    // We decided to turn off `exactOptionalPropertyTypes` because it's too strict
     "exactOptionalPropertyTypes": false,
     "forceConsistentCasingInFileNames": true,
     "isolatedModules": true,
@@ -15,13 +19,11 @@
     "noPropertyAccessFromIndexSignature": true,
     "noUncheckedIndexedAccess": true,
     "resolveJsonModule": true,
+    "rewriteRelativeImportExtensions": true,
     "skipLibCheck": true,
     "strict": true,
-    "target": "ESNext"
-    // TODO: Turn on the following settings once TS 5.7 is released, see also https://nodejs.org/docs/latest/api/typescript.html#typescript-features
-    // "allowImportingTsExtensions": true,
-    // "rewriteRelativeImportExtensions": true,
-    // "verbatimModuleSyntax": true
+    "target": "ESNext",
+    "verbatimModuleSyntax": true
   },
   "$schema": "https://json.schemastore.org/tsconfig"
 }