release-it 17.4.0 → 17.4.2

package/README.md

@@ -60,13 +60,14 @@ npx release-it
 
 You will be prompted to select the new version, and more prompts will follow based on your configuration.
 
-## Yarn
+## Yarn & pnpm
 
-Using Yarn? Please see the [npm section on Yarn][15].
+- Using Yarn? Please see the [npm section on Yarn][15].
+- Using pnpm? Please see [release-it-pnpm][16].
 
 ## Monorepos
 
-Using a monorepo? Please see this [monorepo recipe][16].
+Using a monorepo? Please see this [monorepo recipe][17].
 
 ## Global Installation
 
@@ -77,27 +78,28 @@ Per-project installation as shown above is recommended, but global installs are
 
 ## Containerized
 
-Use [Release It! - Containerized][17] to run it in any environment as a standardized container without the need for a
-Node environment. Thanks [Juan Carlos][18]!
+Use [Release It! - Containerized][18] to run it in any environment as a standardized container without the need for a
+Node environment. Thanks [Juan Carlos][19]!
 
 ## Videos, articles & examples
 
 Here's a list of interesting external resources:
 
-- Video: [How to use GitHub Actions & Release-It to Easily Release Your Code][19]
-- Article: [Monorepo Semantic Releases][20] ([repo][21])
+- Video: [How to use GitHub Actions & Release-It to Easily Release Your Code][20]
+- Article: [Monorepo Semantic Releases][21] ([repo][22])
 
 Want to add yours to the list? Just open a pull request!
 
 ## Configuration
 
-Out of the box, release-it has sane defaults, and [plenty of options][22] to configure it. Most projects use a
+Out of the box, release-it has sane defaults, and [plenty of options][23] to configure it. Most projects use a
 `.release-it.json` file in the project root, or a `release-it` property in `package.json`.
 
 Here's a quick example `.release-it.json`:
 
 ```json
 {
+  "$schema": "https://unpkg.com/release-it@17/schema/release-it.json",
   "git": {
     "commitMessage": "chore: release v${version}"
   },
@@ -107,7 +109,7 @@ Here's a quick example `.release-it.json`:
 }
 ```
 
-→ See [Configuration][23] for more details.
+→ See [Configuration][24] for more details.
 
 ## Interactive vs. CI mode
 
@@ -125,15 +127,15 @@ Use `--only-version` to use a prompt only to determine the version, and automate
 
 How does release-it determine the latest version?
 
-1. For projects with a `package.json`, its `version` will be used (see [npm][24] to skip this).
+1. For projects with a `package.json`, its `version` will be used (see [npm][25] to skip this).
 2. Otherwise, release-it uses the latest Git tag to determine which version should be released.
 3. As a last resort, `0.0.0` will be used as the latest version.
 
 Alternatively, a plugin can be used to override this (e.g. to manage a `VERSION` or `composer.json` file):
 
-- [@release-it/bumper][25] to read from or bump the version in any file
-- [@release-it/conventional-changelog][26] to get a recommended bump based on commit messages
-- [release-it-calver-plugin][27] to use CalVer (Calendar Versioning)
+- [@release-it/bumper][26] to read from or bump the version in any file
+- [@release-it/conventional-changelog][27] to get a recommended bump based on commit messages
+- [release-it-calver-plugin][28] to use CalVer (Calendar Versioning)
 
 Add the `--release-version` flag to print the **next** version without releasing anything.
 
@@ -142,35 +144,35 @@ Add the `--release-version` flag to print the **next** version without releasing
 Git projects are supported well by release-it, automating the tasks to stage, commit, tag and push releases to any Git
 remote.
 
-→ See [Git][28] for more details.
+→ See [Git][29] for more details.
 
 ## GitHub Releases
 
 GitHub projects can have releases attached to Git tags, containing release notes and assets. There are two ways to add
-[GitHub releases][29] in your release-it flow:
+[GitHub releases][30] in your release-it flow:
 
 1. Automated (requires a `GITHUB_TOKEN`)
 2. Manual (using the GitHub web interface with pre-populated fields)
 
-→ See [GitHub Releases][30] for more details.
+→ See [GitHub Releases][31] for more details.
 
 ## GitLab Releases
 
 GitLab projects can have releases attached to Git tags, containing release notes and assets. To automate [GitLab
-releases][31]:
+releases][32]:
 
 - Configure `gitlab.release: true`
-- Obtain a [personal access token][32] (release-it only needs the "api" scope).
-- Make sure the token is [available as an environment variable][33].
+- Obtain a [personal access token][33] (release-it only needs the "api" scope).
+- Make sure the token is [available as an environment variable][34].
 
-→ See [GitLab Releases][34] for more details.
+→ See [GitLab Releases][35] for more details.
 
 ## Changelog
 
 By default, release-it generates a changelog, to show and help select a version for the new release. Additionally, this
 changelog serves as the release notes for the GitHub or GitLab release.
 
-The [default command][22] is based on `git log ...`. This setting (`git.changelog`) can be overridden. To further
+The [default command][23] is based on `git log ...`. This setting (`git.changelog`) can be overridden. To further
 customize the release notes for the GitHub or GitLab release, there's `github.releaseNotes` or `gitlab.releaseNotes`.
 Make sure any of these commands output the changelog to `stdout`. Note that release-it by default is agnostic to commit
 message conventions. Plugins are available for:
@@ -182,14 +184,14 @@ message conventions. Plugins are available for:
 
 To print the changelog without releasing anything, add the `--changelog` flag.
 
-→ See [Changelog][35] for more details.
+→ See [Changelog][36] for more details.
 
 ## Publish to npm
 
 With a `package.json` in the current directory, release-it will let `npm` bump the version in `package.json` (and
 `package-lock.json` if present), and publish to the npm registry.
 
-→ See [Publish to npm][24] for more details.
+→ See [Publish to npm][25] for more details.
 
 ## Manage pre-releases
 
@@ -197,7 +199,7 @@ With release-it, it's easy to create pre-releases: a version of your software th
 it's not in the stable semver range yet. Often "alpha", "beta", and "rc" (release candidate) are used as identifiers for
 pre-releases. An example pre-release version is `2.0.0-beta.0`.
 
-→ See [Manage pre-releases][36] for more details.
+→ See [Manage pre-releases][37] for more details.
 
 ## Update or re-run existing releases
 
@@ -227,7 +229,7 @@ Use the optional `:plugin` part in the middle to hook into a life cycle method e
 The core plugins include `version`, `git`, `npm`, `github`, `gitlab`.
 
 Note that hooks like `after:git:release` will not run when either the `git push` failed, or when it is configured not to
-be executed (e.g. `git.push: false`). See [execution order][37] for more details on execution order of plugin lifecycle
+be executed (e.g. `git.push: false`). See [execution order][38] for more details on execution order of plugin lifecycle
 methods.
 
 All commands can use configuration variables (like template strings). An array of commands can also be provided, they
@@ -245,7 +247,7 @@ will run one after another. Some example release-it configuration:
 }
 ```
 
-The variables can be found in the [default configuration][22]. Additionally, the following variables are exposed:
+The variables can be found in the [default configuration][23]. Additionally, the following variables are exposed:
 
 ```text
 version
@@ -277,7 +279,7 @@ Using Inquirer.js inside custom hook scripts might cause issues (since release-i
 
 Use `--dry-run` to show the interactivity and the commands it _would_ execute.
 
-→ See [Dry Runs][38] for more details.
+→ See [Dry Runs][39] for more details.
 
 ## Troubleshooting & debugging
 
@@ -293,66 +295,67 @@ Since v11, release-it can be extended in many, many ways. Here are some plugins:
 
 | Plugin                                    | Description                                                                                 |
 | ----------------------------------------- | ------------------------------------------------------------------------------------------- |
-| [@release-it/bumper][25]                  | Read & write the version from/to any file                                                   |
-| [@release-it/conventional-changelog][26]  | Provides recommended bump, conventional-changelog, and updates `CHANGELOG.md`               |
-| [@release-it/keep-a-changelog][39]        | Maintain CHANGELOG.md using the Keep a Changelog standards                                  |
-| [@release-it-plugins/lerna-changelog][40] | Integrates lerna-changelog into the release-it pipeline                                     |
-| [@jcamp-code/release-it-changelogen][41]  | Use [@unjs/changelogen][42] for versioning and changelog                                    |
-| [@release-it-plugins/workspaces][43]      | Releases each of your projects configured workspaces                                        |
-| [release-it-calver-plugin][27]            | Enables Calendar Versioning (calver) with release-it                                        |
-| [@grupoboticario/news-fragments][44]      | An easy way to generate your changelog file                                                 |
-| [@j-ulrich/release-it-regex-bumper][45]   | Regular expression based version read/write plugin for release-it                           |
-| [@jcamp-code/release-it-dotnet][46]       | Use .csproj or .props file for versioning, automate NuGet publishing                        |
-| [release-it-pnpm][47]                     | Add basic support for pnpm workspaces, integrates with [bumpp][48] and [changelogithub][49] |
+| [@release-it/bumper][26]                  | Read & write the version from/to any file                                                   |
+| [@release-it/conventional-changelog][27]  | Provides recommended bump, conventional-changelog, and updates `CHANGELOG.md`               |
+| [@release-it/keep-a-changelog][40]        | Maintain CHANGELOG.md using the Keep a Changelog standards                                  |
+| [@release-it-plugins/lerna-changelog][41] | Integrates lerna-changelog into the release-it pipeline                                     |
+| [@jcamp-code/release-it-changelogen][42]  | Use [@unjs/changelogen][43] for versioning and changelog                                    |
+| [@release-it-plugins/workspaces][44]      | Releases each of your projects configured workspaces                                        |
+| [release-it-calver-plugin][28]            | Enables Calendar Versioning (calver) with release-it                                        |
+| [@grupoboticario/news-fragments][45]      | An easy way to generate your changelog file                                                 |
+| [@j-ulrich/release-it-regex-bumper][46]   | Regular expression based version read/write plugin for release-it                           |
+| [@jcamp-code/release-it-dotnet][47]       | Use .csproj or .props file for versioning, automate NuGet publishing                        |
+| [release-it-pnpm][16]                     | Add basic support for pnpm workspaces, integrates with [bumpp][48] and [changelogithub][49] |
+| [changesets-release-it-plugin][50]        | Combine [Changesets][51] changelog management with release-it                               |
 
 Internally, release-it uses its own plugin architecture (for Git, GitHub, GitLab, npm).
 
-→ See all [release-it plugins on npm][50].
+→ See all [release-it plugins on npm][52].
 
-→ See [plugins][51] for documentation to write plugins.
+→ See [plugins][53] for documentation to write plugins.
 
 ## Use release-it programmatically
 
 While mostly used as a CLI tool, release-it can be used as a dependency to integrate in your own scripts. See [use
-release-it programmatically][52] for example code.
+release-it programmatically][54] for example code.
 
 ## Projects using release-it
 
-- [AdonisJs][53]
-- [Axios][54]
-- [Cal.com][55]
-- [Ember CLI][56]
-- [Halo][57]
-- [hosts][58]
-- [js-cookie][59]
-- [Madge][60]
-- [Metalsmith][61]
-- [Node-Redis][62]
-- [React Native Paper][63]
-- [Readability.js][64]
-- [Redux][65]
-- [Saleor][66]
-- [Semantic UI React][67]
-- [Shepherd][68]
-- [Tabler][69] + [tabler-icons][70]
-- Swagger ([swagger-ui][71] + [swagger-editor][72])
-- [Repositories that depend on release-it][73]
-- GitHub search for [path:\*\*/.release-it.json][74]
+- [AdonisJs][55]
+- [Axios][56]
+- [Cal.com][57]
+- [Ember CLI][58]
+- [Halo][59]
+- [hosts][60]
+- [js-cookie][61]
+- [Madge][62]
+- [Metalsmith][63]
+- [Node-Redis][64]
+- [React Native Paper][65]
+- [Readability.js][66]
+- [Redux][67]
+- [Saleor][68]
+- [Semantic UI React][69]
+- [Shepherd][70]
+- [Tabler][71] + [tabler-icons][72]
+- Swagger ([swagger-ui][73] + [swagger-editor][74])
+- [Repositories that depend on release-it][75]
+- GitHub search for [path:\*\*/.release-it.json][76]
 
 ## Legacy Node.js
 
 The latest major version is v17, supporting Node.js 18 and up (as Node.js v16 is EOL). The previous major version was
-v16, supporting Node.js 16. Use release-it v15 for environments running Node.js v14. Also see [CHANGELOG.md][75].
+v16, supporting Node.js 16. Use release-it v15 for environments running Node.js v14. Also see [CHANGELOG.md][77].
 
 ## Links
 
-- See [CHANGELOG.md][75] for major/breaking updates, and [releases][76] for a detailed version history.
-- To **contribute**, please read [CONTRIBUTING.md][77] first.
-- Please [open an issue][78] if anything is missing or unclear in this documentation.
+- See [CHANGELOG.md][77] for major/breaking updates, and [releases][78] for a detailed version history.
+- To **contribute**, please read [CONTRIBUTING.md][79] first.
+- Please [open an issue][80] if anything is missing or unclear in this documentation.
 
 ## License
 
-[MIT][79]
+[MIT][81]
 
 Are you using release-it at work? Please consider [sponsoring me][14]!
 
@@ -371,67 +374,69 @@ Are you using release-it at work? Please consider [sponsoring me][14]!
 [13]: https://badge.fury.io/js/release-it.svg
 [14]: https://github.com/sponsors/webpro
 [15]: ./docs/npm.md#yarn
-[16]: ./docs/recipes/monorepo.md
-[17]: https://github.com/juancarlosjr97/release-it-containerized
-[18]: https://github.com/juancarlosjr97
-[19]: https://www.youtube.com/watch?v=7pBcuT7j_A0
-[20]: https://medium.com/valtech-ch/monorepo-semantic-releases-db114811efa5
-[21]: https://github.com/b12k/monorepo-semantic-releases
-[22]: ./config/release-it.json
-[23]: ./docs/configuration.md
-[24]: ./docs/npm.md
-[25]: https://github.com/release-it/bumper
-[26]: https://github.com/release-it/conventional-changelog
-[27]: https://github.com/casmith/release-it-calver-plugin
-[28]: ./docs/git.md
-[29]: https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases
-[30]: ./docs/github-releases.md
-[31]: https://docs.gitlab.com/ce/user/project/releases/
-[32]: https://gitlab.com/profile/personal_access_tokens
-[33]: ./docs/environment-variables.md
-[34]: ./docs/gitlab-releases.md
-[35]: ./docs/changelog.md
-[36]: ./docs/pre-releases.md
-[37]: ./docs/plugins.md#execution-order
-[38]: ./docs/dry-runs.md
-[39]: https://github.com/release-it/keep-a-changelog
-[40]: https://github.com/release-it-plugins/lerna-changelog
-[41]: https://github.com/jcamp-code/release-it-changelogen
-[42]: https://github.com/unjs/changelogen
-[43]: https://github.com/release-it-plugins/workspaces
-[44]: https://github.com/grupoboticario/news-fragments
-[45]: https://github.com/j-ulrich/release-it-regex-bumper
-[46]: https://github.com/jcamp-code/release-it-dotnet
-[47]: https://github.com/hyoban/release-it-pnpm
+[16]: https://github.com/hyoban/release-it-pnpm
+[17]: ./docs/recipes/monorepo.md
+[18]: https://github.com/juancarlosjr97/release-it-containerized
+[19]: https://github.com/juancarlosjr97
+[20]: https://www.youtube.com/watch?v=7pBcuT7j_A0
+[21]: https://medium.com/valtech-ch/monorepo-semantic-releases-db114811efa5
+[22]: https://github.com/b12k/monorepo-semantic-releases
+[23]: ./config/release-it.json
+[24]: ./docs/configuration.md
+[25]: ./docs/npm.md
+[26]: https://github.com/release-it/bumper
+[27]: https://github.com/release-it/conventional-changelog
+[28]: https://github.com/casmith/release-it-calver-plugin
+[29]: ./docs/git.md
+[30]: https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases
+[31]: ./docs/github-releases.md
+[32]: https://docs.gitlab.com/ce/user/project/releases/
+[33]: https://gitlab.com/profile/personal_access_tokens
+[34]: ./docs/environment-variables.md
+[35]: ./docs/gitlab-releases.md
+[36]: ./docs/changelog.md
+[37]: ./docs/pre-releases.md
+[38]: ./docs/plugins.md#execution-order
+[39]: ./docs/dry-runs.md
+[40]: https://github.com/release-it/keep-a-changelog
+[41]: https://github.com/release-it-plugins/lerna-changelog
+[42]: https://github.com/jcamp-code/release-it-changelogen
+[43]: https://github.com/unjs/changelogen
+[44]: https://github.com/release-it-plugins/workspaces
+[45]: https://github.com/grupoboticario/news-fragments
+[46]: https://github.com/j-ulrich/release-it-regex-bumper
+[47]: https://github.com/jcamp-code/release-it-dotnet
 [48]: https://github.com/antfu/bumpp
 [49]: https://github.com/antfu/changelogithub
-[50]: https://www.npmjs.com/search?q=keywords:release-it-plugin
-[51]: ./docs/plugins.md
-[52]: ./docs/recipes/programmatic.md
-[53]: https://github.com/adonisjs/core
-[54]: https://github.com/axios/axios
-[55]: https://github.com/calcom/cal.com
-[56]: https://github.com/ember-cli/ember-cli
-[57]: https://github.com/halo-dev/halo
-[58]: https://github.com/StevenBlack/hosts
-[59]: https://github.com/js-cookie/js-cookie
-[60]: https://github.com/pahen/madge
-[61]: https://github.com/metalsmith/metalsmith
-[62]: https://github.com/redis/node-redis
-[63]: https://github.com/callstack/react-native-paper
-[64]: https://github.com/mozilla/readability
-[65]: https://github.com/reduxjs/redux
-[66]: https://github.com/saleor/saleor
-[67]: https://github.com/Semantic-Org/Semantic-UI-React
-[68]: https://github.com/shipshapecode/shepherd
-[69]: https://github.com/tabler/tabler
-[70]: https://github.com/tabler/tabler-icons
-[71]: https://github.com/swagger-api/swagger-ui
-[72]: https://github.com/swagger-api/swagger-editor
-[73]: https://github.com/release-it/release-it/network/dependents
-[74]: https://github.com/search?q=path%3A**%2F.release-it.json&type=code
-[75]: ./CHANGELOG.md
-[76]: https://github.com/release-it/release-it/releases
-[77]: ./.github/CONTRIBUTING.md
-[78]: https://github.com/release-it/release-it/issues/new
-[79]: ./LICENSE
+[50]: https://www.npmjs.com/package/changesets-release-it-plugin
+[51]: https://github.com/changesets/changesets
+[52]: https://www.npmjs.com/search?q=keywords:release-it-plugin
+[53]: ./docs/plugins.md
+[54]: ./docs/recipes/programmatic.md
+[55]: https://github.com/adonisjs/core
+[56]: https://github.com/axios/axios
+[57]: https://github.com/calcom/cal.com
+[58]: https://github.com/ember-cli/ember-cli
+[59]: https://github.com/halo-dev/halo
+[60]: https://github.com/StevenBlack/hosts
+[61]: https://github.com/js-cookie/js-cookie
+[62]: https://github.com/pahen/madge
+[63]: https://github.com/metalsmith/metalsmith
+[64]: https://github.com/redis/node-redis
+[65]: https://github.com/callstack/react-native-paper
+[66]: https://github.com/mozilla/readability
+[67]: https://github.com/reduxjs/redux
+[68]: https://github.com/saleor/saleor
+[69]: https://github.com/Semantic-Org/Semantic-UI-React
+[70]: https://github.com/shipshapecode/shepherd
+[71]: https://github.com/tabler/tabler
+[72]: https://github.com/tabler/tabler-icons
+[73]: https://github.com/swagger-api/swagger-ui
+[74]: https://github.com/swagger-api/swagger-editor
+[75]: https://github.com/release-it/release-it/network/dependents
+[76]: https://github.com/search?q=path%3A**%2F.release-it.json&type=code
+[77]: ./CHANGELOG.md
+[78]: https://github.com/release-it/release-it/releases
+[79]: ./.github/CONTRIBUTING.md
+[80]: https://github.com/release-it/release-it/issues/new
+[81]: ./LICENSE

package/lib/plugin/factory.js

@@ -27,10 +27,12 @@ const load = async pluginName => {
     const module = await import(pluginName);
     plugin = module.default;
   } catch (err) {
+    debug(err);
     try {
       const module = await import(path.join(process.cwd(), pluginName));
       plugin = module.default;
     } catch (err) {
+      debug(err);
       // In some cases or tests we might need to support legacy `require.resolve`
       const require = createRequire(process.cwd());
       const module = await import(url.pathToFileURL(require.resolve(pluginName, { paths: [process.cwd()] })));

package/lib/plugin/github/GitHub.js

@@ -105,8 +105,8 @@ class GitHub extends Release {
       const { data } = await this.client.users.getAuthenticated();
       this.setContext({ username: data.login });
       return true;
-    } catch (error) {
-      this.debug(error);
+    } catch (err) {
+      this.debug(err);
       return false;
     }
   }
@@ -120,8 +120,8 @@ class GitHub extends Release {
       this.log.verbose(`octokit repos#checkCollaborator (${username})`);
       await this.client.repos.checkCollaborator(options);
       return true;
-    } catch (error) {
-      this.debug(error);
+    } catch (err) {
+      this.debug(err);
       return false;
     }
   }

package/lib/plugin/gitlab/GitLab.js

@@ -3,7 +3,6 @@ import path from 'node:path';
 import got from 'got';
 import { globby } from 'globby';
 import { FormData, fileFromSync } from 'node-fetch';
-import allSettled from 'promise.allsettled';
 import _ from 'lodash';
 import Release from '../GitRelease.js';
 import { format, e } from '../../util.js';
@@ -137,7 +136,7 @@ class GitLab extends Release {
       });
     });
     try {
-      await allSettled(requests).then(results => {
+      await Promise.allSettled(requests).then(results => {
         for (const result of results) {
           if (result.status === 'rejected') {
             throw e('Missing one or more milestones in GitLab. Creating a GitLab release will fail.', docs);

package/lib/shell.js

@@ -78,12 +78,12 @@ class Shell {
       this.log.verbose(stdout, { isExternal });
       debug({ command, options, stdout, stderr });
       return Promise.resolve(stdout || stderr);
-    } catch (error) {
-      if (error.stdout) {
-        this.log.log(`\n${error.stdout}`);
+    } catch (err) {
+      if (err.stdout) {
+        this.log.log(`\n${err.stdout}`);
       }
-      debug({ error });
-      return Promise.reject(new Error(error.stderr || error.message));
+      debug(err);
+      return Promise.reject(new Error(err.stderr || err.message));
     }
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "release-it",
-  "version": "17.4.0",
+  "version": "17.4.2",
   "description": "Generic CLI tool to automate versioning and package publishing-related tasks.",
   "keywords": [
     "build",
@@ -47,7 +47,11 @@
   },
   "type": "module",
   "exports": {
-    ".": "./lib/index.js",
+    ".": {
+      "import": "./lib/index.js",
+      "require": "./lib/index.js",
+      "types": "./types/index.d.ts"
+    },
     "./package.json": "./package.json",
     "./test/util/index.js": "./test/util/index.js"
   },
@@ -56,7 +60,8 @@
     "config",
     "lib",
     "test",
-    "schema"
+    "schema",
+    "types"
   ],
   "types": "./types/index.d.ts",
   "scripts": {
@@ -80,9 +85,9 @@
     "cosmiconfig": "9.0.0",
     "execa": "8.0.1",
     "git-url-parse": "14.0.0",
-    "globby": "14.0.1",
+    "globby": "14.0.2",
     "got": "13.0.0",
-    "inquirer": "9.2.23",
+    "inquirer": "9.3.2",
     "is-ci": "3.0.1",
     "issue-parser": "7.0.1",
     "lodash": "4.17.21",
@@ -92,7 +97,6 @@
     "open": "10.1.0",
     "ora": "8.0.1",
     "os-name": "5.1.0",
-    "promise.allsettled": "1.0.7",
     "proxy-agent": "6.4.0",
     "semver": "7.6.2",
     "shelljs": "0.8.5",
@@ -104,18 +108,19 @@
   "devDependencies": {
     "@eslint/compat": "1.1.0",
     "@eslint/eslintrc": "3.1.0",
-    "@eslint/js": "9.5.0",
+    "@eslint/js": "9.6.0",
     "@octokit/request-error": "5.1.0",
+    "@types/node": "20.14.9",
     "ava": "6.1.3",
-    "eslint": "9.5.0",
+    "eslint": "9.6.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-ava": "15.0.1",
     "eslint-plugin-import": "2.29.1",
     "eslint-plugin-prettier": "5.1.3",
     "fs-monkey": "1.0.6",
-    "globals": "15.6.0",
+    "globals": "15.7.0",
     "installed-check": "9.3.0",
-    "knip": "5.22.1",
+    "knip": "5.23.2",
     "memfs": "4.9.3",
     "mock-stdio": "1.0.3",
     "nock": "13.5.4",
@@ -123,7 +128,12 @@
     "remark-cli": "12.0.1",
     "remark-preset-webpro": "1.1.0",
     "sinon": "18.0.0",
-    "strip-ansi": "7.1.0"
+    "strip-ansi": "7.1.0",
+    "typescript": "5.5.2"
+  },
+  "overrides": {
+    "pac-resolver": "7.0.1",
+    "socks": "2.8.3"
   },
   "engines": {
     "node": "^18.18.0 || ^20.9.0 || ^22.0.0"

package/types/config.d.ts

@@ -0,0 +1,183 @@
+import { Hooks } from './hooks';
+
+export interface Config {
+  hooks?: Hooks;
+
+  plugins?: Record<string, Record<string, any>>;
+
+  git?: {
+    /** @default "git log --pretty=format:\"* %s (%h)\" ${from}...${to}" */
+    changelog?: string;
+
+    /** @default true */
+    requireCleanWorkingDir?: boolean;
+
+    /** @default false */
+    requireBranch?: false | string;
+
+    /** @default true */
+    requireUpstream?: boolean;
+
+    /** @default false */
+    requireCommits?: boolean;
+
+    /** @default true */
+    requireCommitsFail?: boolean;
+
+    /** @default "" */
+    commitsPath?: string;
+
+    /** @default false */
+    addUntrackedFiles?: boolean;
+
+    /** @default true */
+    commit?: boolean;
+
+    /** @default "Release ${version}" */
+    commitMessage?: string;
+
+    commitArgs?: Array<any>;
+
+    /** @default true */
+    tag?: boolean;
+
+    /** @default null */
+    tagExclude?: any;
+
+    /** @default null */
+    tagName?: any;
+
+    /** @default null */
+    tagMatch?: any;
+
+    /** @default false */
+    getLatestTagFromAllRefs?: boolean;
+
+    /** @default "Release ${version}" */
+    tagAnnotation?: string;
+
+    tagArgs?: Array<any>;
+
+    /** @default true */
+    push?: boolean;
+
+    /** @default ["--follow-tags"] */
+    pushArgs?: Array<string>;
+
+    /** @default "" */
+    pushRepo?: string;
+  };
+
+  npm?: {
+    /** @default true */
+    publish?: boolean;
+
+    /** @default "." */
+    publishPath?: string;
+
+    publishArgs?: Array<any>;
+
+    /** @default null */
+    tag?: any;
+
+    /** @default null */
+    otp?: any;
+
+    /** @default false */
+    ignoreVersion?: boolean;
+
+    /** @default false */
+    allowSameVersion?: boolean;
+
+    versionArgs?: Array<any>;
+
+    /** @default false */
+    skipChecks?: boolean;
+
+    /** @default 10 */
+    timeout?: number;
+  };
+
+  github?: {
+    /** @default false */
+    release?: boolean;
+
+    /** @default "Release ${version}" */
+    releaseName?: string;
+
+    /** @default null */
+    releaseNotes?: any;
+
+    /** @default false */
+    autoGenerate?: boolean;
+
+    /** @default false */
+    preRelease?: boolean;
+
+    /** @default false */
+    draft?: boolean;
+
+    /** @default "GITHUB_TOKEN" */
+    tokenRef?: string;
+
+    /** @default null */
+    assets?: any;
+
+    /** @default null */
+    host?: any;
+
+    /** @default 0 */
+    timeout?: number;
+
+    /** @default null */
+    proxy?: any;
+
+    /** @default false */
+    skipChecks?: boolean;
+
+    /** @default false */
+    web?: boolean;
+
+    comments?: {
+      /** @default false */
+      submit?: boolean;
+
+      /** @default ":rocket?: _This issue has been resolved in v${version}. See [${releaseName}](${releaseUrl}) for release notes._" */
+      issue?: string;
+
+      /** @default ":rocket?: _This pull request is included in v${version}. See [${releaseName}](${releaseUrl}) for release notes._" */
+      pr?: string;
+    };
+  };
+
+  gitlab?: {
+    /** @default false */
+    release?: boolean;
+
+    /** @default "Release ${version}" */
+    releaseName?: string;
+
+    /** @default null */
+    releaseNotes?: any;
+
+    milestones?: Array<any>;
+
+    /** @default "GITLAB_TOKEN" */
+    tokenRef?: string;
+
+    /** @default "Private-Token" */
+    tokenHeader?: string;
+
+    /** @default null */
+    certificateAuthorityFile?: any;
+
+    /** @default null */
+    assets?: any;
+
+    /** @default null */
+    origin?: any;
+
+    /** @default false */
+    skipChecks?: boolean;
+  };
+}

package/types/hooks.d.ts

@@ -0,0 +1,47 @@
+export type HookPrefix = 'before' | 'after';
+export type InternalPlugin = 'version' | 'git' | 'npm' | 'github' | 'gitlab';
+export type HookName = 'init' | 'bump' | 'release';
+
+export type Hooks = {
+  ['before:init']?: string | string[];
+  ['before:bump']?: string | string[];
+  ['before:release']?: string | string[];
+  ['after:init']?: string | string[];
+  ['after:bump']?: string | string[];
+  ['after:release']?: string | string[];
+
+  ['before:version:init']?: string | string[];
+  ['before:version:bump']?: string | string[];
+  ['before:version:release']?: string | string[];
+  ['after:version:init']?: string | string[];
+  ['after:version:bump']?: string | string[];
+  ['after:version:release']?: string | string[];
+
+  ['before:git:init']?: string | string[];
+  ['before:git:bump']?: string | string[];
+  ['before:git:release']?: string | string[];
+  ['after:git:init']?: string | string[];
+  ['after:git:bump']?: string | string[];
+  ['after:git:release']?: string | string[];
+
+  ['before:npm:init']?: string | string[];
+  ['before:npm:bump']?: string | string[];
+  ['before:npm:release']?: string | string[];
+  ['after:npm:init']?: string | string[];
+  ['after:npm:bump']?: string | string[];
+  ['after:npm:release']?: string | string[];
+
+  ['before:github:init']?: string | string[];
+  ['before:github:bump']?: string | string[];
+  ['before:github:release']?: string | string[];
+  ['after:github:init']?: string | string[];
+  ['after:github:bump']?: string | string[];
+  ['after:github:release']?: string | string[];
+
+  ['before:gitlab:init']?: string | string[];
+  ['before:gitlab:bump']?: string | string[];
+  ['before:gitlab:release']?: string | string[];
+  ['after:gitlab:init']?: string | string[];
+  ['after:gitlab:bump']?: string | string[];
+  ['after:gitlab:release']?: string | string[];
+};

package/types/index.d.ts

@@ -0,0 +1,3 @@
+declare module 'release-it';
+
+export type { Config } from './config.d';