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

package/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [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
+
+- Add docs ([83e7f61](https://github.com/peerigon/configs/commit/83e7f617d6fc44abcd7e0d05c700299d8e2910c2))
+
 # [1.0.0-beta.17](https://github.com/peerigon/configs/compare/v1.0.0-beta.16...v1.0.0-beta.17) (2025-01-20)
 
 ### Bug Fixes

package/README.md

@@ -1,451 +1,63 @@
-# eslint-config-peerigon
+# configs
 
-**[Peerigon](https://peerigon.com/) coding rules as [ESLint](http://eslint.org/) config.**
+**Best practice configs for [ESLint](https://eslint.org/), [Prettier](https://prettier.io/), [TypeScript](https://www.typescriptlang.org/) & friends. By [Peerigon](https://www.peerigon.com/).**
 
-[![Version on NPM](https://img.shields.io/npm/v/eslint-config-peerigon?style=for-the-badge)](https://www.npmjs.com/package/eslint-config-peerigon)
+[![Version on NPM](https://img.shields.io/npm/v/@peerigon/configs?style=for-the-badge)](https://www.npmjs.com/package/@peerigon/configs)
 [![Semantically released](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=for-the-badge)](https://github.com/semantic-release/semantic-release)
-[![Monthly downloads on NPM](https://img.shields.io/npm/dm/eslint-config-peerigon?style=for-the-badge)](https://www.npmjs.com/package/eslint-config-peerigon)<br>
-[![License](https://img.shields.io/npm/l/eslint-config-peerigon?style=for-the-badge)](./LICENSE)
+[![Monthly downloads on NPM](https://img.shields.io/npm/dm/@peerigon/configs?style=for-the-badge)](https://www.npmjs.com/package/@peerigon/configs)<br>
+[![License](https://img.shields.io/npm/l/@peerigon/configs?style=for-the-badge)](./LICENSE)
 
-Linting and formatting rules are always a balance between
+This package contains best practice configs and rules for linting, type-checking, formatting and publishing JavaScript and TypeScript code. Use them to kickstart you next awesome web project 🚀!
 
-- ease of reading
-- ease of refactoring
-- ease of writing.
+## Installation
 
-We think that
-
-- code is read more often than refactored
-- and refactored more often than written from scratch.
-
-Our linting rules have been designed with these assumptions in mind.
-
-## Table of contents
-
-- [Quick start](#quick-start)
-- [Practical guide](#practical-guide)
-- [Provided configs](#provided-configs)
-- [Styles](#styles)
-
-## Quick start
-
-Recommended configuration in your `package.json`:
-
-```js
-{
-    "scripts": {
-        "test:lint": "eslint --max-warnings 0 --cache",
-        "posttest": "npm run test:lint"
-    }
-}
-```
-
-We also offer a [Prettier](https://prettier.io/) config that matches our ESLint config. Create a `.prettierrc.json` in your project with the following content:
-
-```json
-"eslint-config-peerigon/prettier.config.js"
-```
-
-There are presets for the most common setups:
-
-### TypeScript
-
-```
-npm i eslint eslint-config-peerigon --save-dev
-```
-
-```js
-{
-    "extends": [
-        "peerigon/presets/typescript.js"
-    ],
-    "env": {
-        "node": true
-    },
-    "root": true
-}
-```
-
-### TypeScript + React
-
-```
-npm i eslint eslint-config-peerigon eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-react-hooks --save-dev
-```
-
-```js
-{
-    "extends": [
-        "peerigon/presets/typescript-react.js"
-    ],
-    "env": {
-        "node": true,
-        "browser": true
-    },
-    "root": true
-}
-```
-
-### TypeScript + Node
-
-```
-npm i eslint eslint-config-peerigon eslint-plugin-n --save-dev
-```
-
-```js
-{
-    "extends": [
-        "peerigon/presets/typescript-node.js"
-    ],
-    "root": true
-}
-```
-
-## Practical guide
-
-### Disabling rules
-
-Try to disable as less rules as possible. In most cases it's best to just write
-
-```js
-// eslint-disable-next-line [rule-code]
-```
-
-where `[rule-code]` is the code that is displayed along the error message. Disabling the next line is usually better because it resists [Prettier](https://prettier.io/) reformatting.
-
-Sometimes it makes sense to disable a rule within a specifc file. In that case you can put the following snippet at the beginning of the file:
-
-```js
-/* eslint-disable [rule-code] */
-```
-
-If you don't agree with a rule, please do not just disable the rule. Often there are good reasons and the current setting is the result of years of experience. It's better to create an issue here to start a discussion about the pros and cons of a rule.
-
-### Different 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. That's why we also provide a list of [accepted custom styles](#styles) (see also [this discussion](https://github.com/peerigon/eslint-config-peerigon/issues/11)) which you can pick.
-
-### VSCode
-
-This is our recommended VSCode configuration using the [Prettier extension](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode). Adjust it to the needs of your particular project:
-
-```json
-{
-  "editor.defaultFormatter": "esbenp.prettier-vscode",
-  "editor.formatOnSave": true,
-  "editor.codeActionsOnSave": {
-    "source.fixAll.eslint": true
-  }
-}
-```
-
-### Experimental syntax using Babel
-
-If you're using Babel you should set [`requireConfigFile: true`](https://github.com/babel/babel/tree/main/eslint/babel-eslint-parser#additional-parser-configuration) in your ESLint config. ESLint will then use your `babel.config.json`.
-
-```js
-{
-    "parserOptions": { "requireConfigFile": true },
-}
-```
-
-### Naming conventions for properties
-
-Sometimes we're not in full control over the naming conventions in our codebase, for instance if data is coming from a foreign API. While it often is preferable to transform property names into camelCase, it might not be practical. In these situations you can disable the check for properties like this:
-
-```js
-const options = require("eslint-config-peerigon/options.js");
-
-module.exports = {
-  /* ... */
-  rules: {
-    // The API uses snake_case as properties
-    camelcase: [
-      "warn",
-      {
-        ...options["camelcase"],
-        properties: "never",
-      },
-    ],
-  },
-};
-```
-
-**In TypeScript projects:**
-
-```js
-const options = require("eslint-config-peerigon/options.js");
-
-module.exports = {
-  /* ... */
-  rules: {
-    // The API uses snake_case as properties
-    "@typescript-eslint/naming-convention": [
-      "warn",
-      options["@typescript-eslint/naming-convention"].ignoreProperties,
-      ...options["@typescript-eslint/naming-convention"].defaultRules,
-    ],
-  },
-};
-```
-
-## Provided configs
-
-### [`peerigon`](base.js)
-
-**Base rules for every project. You should always add these rules.**
-
-```
-npm i eslint eslint-config-peerigon --save-dev
-```
-
-These rules assume a modern project with full ES2015 support, including ES modules. For specific environments like Node.js or old JS engines, see below. The base rules do not define an `env`, so you might want to do that for yourself to enable specific globals.
-
-Add an `.eslintrc.json` to the project's root folder:
-
-```js
-{
-    "extends": [
-        // Base rules for every project
-        "peerigon"
-    ],
-    // Do not search for further eslint configs in upper directories
-    "root": true,
-    // If you're using Babel, you should set requireConfigFile: true
-    // ESLint will then use your babel.config.json.
-    // "parserOptions": { "requireConfigFile": true },
-}
-```
-
-The base rules use the `eslint-plugin-import` to resolve imports. Although it's possible to define [custom resolvers](https://github.com/benmosher/eslint-plugin-import#resolvers), it's highly discouraged to deviate from the common Node.js resolving algorithm. Other tools like linters and intellisense don't work reliably when you change the resolver.
-
-### [`peerigon/typescript`](typescript.js)
-
-Rules for [TypeScript](https://www.typescriptlang.org/).
-
-```js
-{
-    "extends": [
-        "peerigon",
-        "peerigon/typescript",
-        // Arrow functions are preferred with TypeScript
-        // See https://github.com/peerigon/eslint-config-peerigon/issues/23#issuecomment-472614432
-        "peerigon/styles/prefer-arrow"
-    ],
-    "root": true,
-}
-```
-
-You need to add `--ext js,jsx,cjs,mjs,ts,tsx` to the `test:lint` script:
-
-```js
-{
-    "scripts": {
-        "test:lint": "eslint --max-warnings 0 --cache --ext js,jsx,cjs,mjs,ts,tsx --ignore-path .gitignore ."
-    }
-}
-```
-
-_We recommend using [`peerigon/styles/prefer-arrow`](#peerigonstylesprefer-arrow) because arrow functions (or function expressions in general) can leverage [TypeScript's contextual typing](https://www.typescriptlang.org/docs/handbook/type-inference.html#contextual-typing)._
-
-### [`peerigon/node`](node.js)
-
-**Important: Requires [`eslint-plugin-n`](https://github.com/eslint-community/eslint-plugin-n).**
-
-```
-npm i eslint-plugin-n --save-dev
-```
-
-```js
-{
-    "extends": [
-        "peerigon",
-        "peerigon/node"
-    ],
-    // Setting env.node = true is not necessary, this is already done by peerigon/node
-    "root": true
-}
-```
-
-### [`peerigon/react`](react.js)
-
-**Important: Requires [`eslint-plugin-react`](https://github.com/yannickcr/eslint-plugin-react), [`eslint-plugin-jsx-a11y`](https://github.com/evcohen/eslint-plugin-jsx-a11y) and [`eslint-plugin-react-hooks`](https://www.npmjs.com/package/eslint-plugin-react-hooks) as project dependency.**
-
-```
-npm i eslint-plugin-react eslint-plugin-jsx-a11y eslint-plugin-react-hooks --save-dev
-```
-
-Rules for [React](https://facebook.github.io/react/) development, including accessibility rules.
-These rules are also applicable in other JSX environments, like [Preact](https://github.com/developit/preact):
-
-```js
-{
-    "extends": [
-        "peerigon",
-        "peerigon/react"
-    ],
-    "root": true
-}
-```
-
-_We recommend using [`peerigon/styles/react-jsx-no-literals`](#peerigonstylesreact-jsx-no-literals) if you're using i18n in your project._
-_You can use [`peerigon/styles/react-jsx-no-bind`](#peerigonstylesreact-jsx-no-bind) if you're using `memo` and `shouldComponentUpdate` a lot._
-
-### [`peerigon/jsdoc`](jsdoc.js)
-
-**Important: Requires [`eslint-plugin-jsdoc`](https://github.com/gajus/eslint-plugin-jsdoc) as project dependency.**
-
-```
-npm i eslint-plugin-jsdoc --save-dev
-```
-
-Makes sure that JSDoc annotations are written in a standard-compliant and uniform way.
-
-```js
-{
-    "extends": [
-        "peerigon",
-        "peerigon/jsdoc"
-    ],
-    "root": true
-}
-```
-
-## Styles
-
-The following rules enable specific writing styles. Use them as you prefer.
-
-### [`peerigon/styles/prefer-arrow`](styles/prefer-arrow.js)
-
-Enforces arrow function expressions instead of function declarations (see [#23](https://github.com/peerigon/eslint-config-peerigon/issues/23)).
-Regular functions are still allowed as methods in objects or classes.
-
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/styles/prefer-arrow"
-    ],
-```
-
-### [`peerigon/styles/no-default-export`](styles/no-default-export.js)
-
-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/).
-
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/styles/no-default-export"
-    ],
-```
-
-**Please note:** This rule is disabled in `.jsx` and `.tsx` files because React components are usually exported via `export default`. [`React.lazy`](https://reactjs.org/docs/code-splitting.html#reactlazy) even expects the lazy loaded component to be exported as `default`.
-
-### [`peerigon/styles/no-null`](styles/no-null.js)
-
-**Important: Requires [`eslint-plugin-no-null`](https://github.com/nene/eslint-plugin-no-null) as project dependency.**
-
-```
-npm i eslint-plugin-no-null --save-dev
+```sh
+npm install @peerigon/configs
 ```
 
-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**.
+Also checkout the instructions for each respective config:
 
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/styles/no-null"
-    ],
-```
+- [ESLint](/eslint/README.md)
+- [Prettier](/prettier/README.md)
+- [TypeScript](/typescript/README.md)
+- [Semantic release](/semantic-release/README.md)
 
-**Please note:** 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:
+## Philosophy
 
-```js
-// eslint-disable-next-line no-null/no-null
-export const NULL = null;
-```
+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.
 
-### [`peerigon/styles/prefer-interface`](styles/prefer-interface.js)
+### Formatting
 
-**Important: Use it in combination with [`peerigon/typescript`](typescript.js).**
+Formatting should follow the community standard. Our config is entirely based on Prettier's default config. Besides that, it also:
 
-[Prefer `interface` over `type`](https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/docs/rules/prefer-interface.md).
+- auto-sorts `import` statements
+- formats JSDoc comments
+- formats `package.json`
+- formats and sorts CSS properties
+- sorts Tailwind CSS class names
 
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/typescript",
-        "peerigon/styles/prefer-interface"
-    ],
-```
-
-### [`peerigon/styles/react-jsx-no-bind`](styles/react-jsx-no-bind.js)
+### Linting
 
-**Important: Use it in combination with [`peerigon/react`](react.js).**
+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.
 
-Depending on the way you write your components, it might be not ok to create functions during `render()`. Use it if you're using things like `React.memo()` or `shouldComponentUpdate` a lot.
+However, it should **not** nit-pick on formatting or favor certain language features where other options are equally ok. Every rule must be legitimized by objective criteria. A simple “I find it easier to read” is not enough.
 
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/react",
-        "peerigon/styles/react-jsx-no-bind"
-    ],
-```
+Our linting rules:
 
-### [`peerigon/styles/react-jsx-no-literals`](styles/react-jsx-no-literals.js)
+- are mostly based on recommended sets
+- use type information to catch logic bugs
+- highlight a11y problems
+- are less strict in tests
 
-**Important: Use it in combination with [`peerigon/react`](react.js).**
+### Type-checking
 
-Use this style if you're using i18n. It prevents people from putting raw strings in components.
+Type-checking should be rather strict because it is the foundation for safe and sound refactorings. If type-checking is too loose, it may lull the developer into a false sense of security. It should also prevent out-of-bounds errors when accessing arrays or objects.
 
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/react",
-        "peerigon/styles/react-jsx-no-literals"
-    ],
-```
-
-It disallows this:
-
-```jsx
-const Hello = <div>test</div>;
-```
-
-As an escape hatch, this is still allowed:
-
-```jsx
-const Hello = <div>{"test"}</div>;
-```
-
-### [`peerigon/styles/prefer-array-shorthand`](styles/prefer-array-shorthand.js)
-
-**Important: Use it in combination with [`peerigon/typescript`](typescript.js).**
-
-Enforces typescript arrays to use the shorthand array-style instead of the generic style.
-
-```js
-    "extends": [
-        "peerigon",
-        "peerigon/typescript",
-        "peerigon/styles/prefer-array-shorthand"
-    ],
-```
-
-It enforces this:
-
-```ts
-const foo: string[] = [];
-```
-
-instead of
-
-```ts
-const foo: Array<string> = [];
-```
+For highly dynamic code or incompatible types, local exceptions to type safety and escape hatches need to be possible.
 
 ## License
 
-Unlicense
+MIT
 
 ## Sponsors
 

package/eslint/README.md

@@ -0,0 +1,114 @@
+# [ESLint](https://eslint.org/) config
+
+## Installation
+
+```sh
+npm install @peerigon/configs
+```
+
+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-all`](https://www.npmjs.com/package/npm-run-all)):
+
+```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)
+- `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`](https://typescript-eslint.io/rules/consistent-type-definitions/).
+
+```js
+    "extends": [
+        "peerigon",
+        "peerigon/typescript",
+        "peerigon/styles/prefer-interface"
+    ],
+```
+
+### `prefer-array-shorthand`
+
+Enforces TypeScript arrays to use the shorthand array-style instead of the generic style.
+It enforces this:
+
+```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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@peerigon/configs",
-  "version": "1.0.0-beta.17",
+  "version": "1.0.0-beta.18",
   "description": "Configs for ESLint, Prettier, TypeScript & friends",
   "keywords": [
     "eslint",
@@ -73,6 +73,10 @@
       "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"
     },
@@ -162,6 +166,7 @@
     "typescript": "^5.6.3"
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   }
 }

package/prettier/README.md

@@ -0,0 +1,35 @@
+# [Prettier](https://prettier.io/) config
+
+## Installation
+
+```sh
+npm install @peerigon/configs
+```
+
+Then create a `prettier.config.js` next to your `package.json`:
+
+```js
+export { default } from "@peerigon/configs/prettier";
+```
+
+Recommended configuration in your `package.json` (using [`npm-run-all`](https://www.npmjs.com/package/npm-run-all)):
+
+```json
+{
+  "type": "module",
+  "scripts": {
+    "test": "run-p test:*",
+    "test:format": "prettier --check ."
+  }
+}
+```
+
+## Configuration
+
+Our config is entirely based on Prettier's default config. Besides that, it also:
+
+- auto-sorts `import` statements
+- formats JSDoc comments
+- formats `package.json`
+- formats and sorts CSS properties
+- sorts Tailwind CSS class names

package/semantic-release/README.md

@@ -0,0 +1,75 @@
+# [Semantic release](https://semantic-release.gitbook.io/) config
+
+## Installation
+
+```sh
+npm install @peerigon/configs
+```
+
+Then create a `.releaserc.json` next to your `package.json`:
+
+```json
+{
+  "extends": "@peerigon/configs/semantic-release"
+}
+```
+
+Recommended configuration in your `package.json`:
+
+```json
+{
+  "type": "module",
+  "scripts": {
+    "release": "semantic-release"
+  },
+  "publishConfig": {
+    "access": "public", // only if the package is supposed to be public
+    "provenance": true
+  }
+}
+```
+
+Recommended Github action:
+
+```yaml
+name: 🧪 Test and 🚀 Release
+
+on:
+  push:
+    branches:
+      - main
+      - beta
+  pull_request: {}
+
+jobs:
+  test-and-release:
+    runs-on: ubuntu-latest
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+
+    permissions:
+      # Necessary for semantic-release
+      contents: write
+      issues: write
+      pull-requests: write
+      # Necessary for npm publish --provenance
+      # See https://docs.npmjs.com/generating-provenance-statements#example-github-actions-workflow
+      id-token: write
+
+    steps:
+      # ...
+      # Install and build steps
+      # ...
+      - name: 🚀 Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: |
+          npm run release
+```
+
+## Configuration
+
+We export the following `.releaserc.json` presets. They can be used by extending `@peerigon/configs/<preset-name>`:
+
+- `semantic-release`: Recommended config for publishing a library to a single registry (according to your `.npmrc`).
+- `semantic-release/cross-publish`: Config for publishing a library both to NPM _and_ Github

package/semantic-release/base.js

@@ -29,17 +29,6 @@ export const config = {
         assets: ".semantic-release/*.tgz",
       },
     ],
-    [
-      "@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",
-      },
-    ],
   ],
 };
 

package/semantic-release/cross-publish.js

@@ -0,0 +1,22 @@
+import { config as baseConfig } from "./base.js";
+
+/** @type {import("semantic-release").Options} */
+export const config = {
+  ...baseConfig,
+  plugins: [
+    ...(baseConfig.plugins ?? []),
+    [
+      "@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",
+      },
+    ],
+  ],
+};
+
+export default config;

package/types/semantic-release/base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../semantic-release/base.js"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,qBADW,OAAO,kBAAkB,EAAE,OAAO,CA2C3C"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../semantic-release/base.js"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,qBADW,OAAO,kBAAkB,EAAE,OAAO,CAgC3C"}

package/types/semantic-release/cross-publish.d.ts

@@ -0,0 +1,4 @@
+/** @type {import("semantic-release").Options} */
+export const config: import("semantic-release").Options;
+export default config;
+//# sourceMappingURL=cross-publish.d.ts.map

package/types/semantic-release/cross-publish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cross-publish.d.ts","sourceRoot":"","sources":["../../semantic-release/cross-publish.js"],"names":[],"mappings":"AAEA,iDAAiD;AACjD,qBADW,OAAO,kBAAkB,EAAE,OAAO,CAiB3C"}

package/typescript/README.md

@@ -0,0 +1,58 @@
+# [TypeScript](https://www.typescriptlang.org/) config
+
+## Installation
+
+```sh
+npm install @peerigon/configs
+```
+
+Then create a `tsconfig.json` just for type-checking next to your `package.json`:
+
+```json
+{
+  "extends": "@peerigon/configs/typescript"
+}
+```
+
+Recommended configuration in your `package.json` (using [`npm-run-all`](https://www.npmjs.com/package/npm-run-all)):
+
+```json
+{
+  "type": "module",
+  "scripts": {
+    "test": "run-p test:*",
+    "test:types": "tsc"
+  }
+}
+```
+
+In case you're developing a library with a dedicated build process, we recommend to create a separate `tsconfig.build.json`:
+
+```json
+{
+  "extends": ["./tsconfig.json", "@peerigon/configs/typescript/lib"],
+  "include": ["src"],
+  "exclude": ["src/**/*.test.ts", "src/tests/**/*.ts"]
+}
+```
+
+with the following `package.json` `scripts`:
+
+```json
+{
+  "type": "module",
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "test": "run-p test:*",
+    "test:types": "tsc"
+  }
+}
+```
+
+## Presets
+
+We export the following `tsconfig.json` presets. They can be used by extending `@peerigon/configs/<preset-name>`:
+
+- `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).