@mlaursen/release-script 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Mikkel Laursen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,85 @@
+# @mlaursen/release-script
+
+This is the normal npm release script I use. This requires:
+
+- [changesets](https://github.com/changesets/changesets) to handle bumping
+  versions and generating changelogs.
+- A Github [release token](https://github.com/settings/personal-access-tokens)
+  - The token only needs repository access
+  - This is normally stored as `GITHUB_TOKEN` in an `.env.local` file that
+    should not be committed
+
+## Installation
+
+The release script relies on
+[changesets](https://github.com/changesets/changesets) to handle bumping
+versions and generating changelogs.
+
+```sh
+pnpm install --save-dev @mlaursen/release-script \
+  @changesets/cli \
+  tsx
+```
+
+Setup the `.changeset` dir if needed:
+
+```sh
+pnpm changeset init
+git add .changeset
+git add -u
+git commit -m "build: setup changesets"
+```
+
+## Usage
+
+Create a `scripts/release.ts` file with:
+
+```ts
+import { release } from "@mlaursen/release-script";
+
+await release({
+  repo: "{{REPO_NAME}}", // i.e. eslint-config
+
+  // if the repo is not under `mlaursen` for some reason
+  // owner: "mlaursen",
+
+  // If there is a custom clean command for releases. `clean` is the default
+  // cleanCommand: "clean",
+
+  // If there is a custom build command for releases. `build` is the default
+  // buildCommand: "build",
+
+  // An optional flag if the build step should be skipped. `false` by default
+  // skipBuild: process.argv.includes("--skip-build"),
+
+  // This is useful for monorepos where only a single Github release needs to
+  // be created. Defaults to `JSON.parse(await readFile("package.json)).name`
+  // mainPackage: "{{PACKAGE_NAME}}",
+
+  // If the version message needs to be customized. The following is the default
+  // versionMessage: "build(version): version package",
+
+  // An optional `.env` file path that includes the `GITLAB_TOKEN` environment variable.
+  // envPath: ".env.local",
+});
+```
+
+Next, update `package.json` to include the release script:
+
+```diff
+   "scripts": {
+     "prepare": "husky",
+     "typecheck": "tsc --noEmit",
+     "check-format": "prettier --check .",
+     "format": "prettier --write .",
+     "clean": "rm -rf dist",
+     "build": "tsc -p tsconfig.json",
++    "release": "tsx index.ts"
+   },
+```
+
+Finally, run the release script whenever a new release should go out:
+
+```sh
+pnpm release
+```

package/dist/continueRelease.d.ts

@@ -0,0 +1 @@
+export declare function continueRelease(): Promise<void>;

package/dist/continueRelease.js

@@ -0,0 +1,7 @@
+import confirm from "@inquirer/confirm";
+export async function continueRelease() {
+    const confirmed = confirm({ message: "Continue the release?" });
+    if (!confirmed) {
+        process.exit(1);
+    }
+}

package/dist/createRelease.d.ts

@@ -0,0 +1,21 @@
+export interface ConfigurableCreateReleaseOptions {
+    repo: string;
+    /**
+     * @defaultValue `"mlaursen"`
+     */
+    owner?: string;
+    /**
+     * The `.env` file to load to get the `GITHUB_TOKEN` environment variable.
+     *
+     * @defaultValue `".env.local"`
+     */
+    envPath?: string;
+}
+export interface CreateReleaseOptions extends ConfigurableCreateReleaseOptions {
+    body: string;
+    version: string;
+    override?: boolean;
+    tagPrefix: string;
+    prerelease: boolean;
+}
+export declare function createRelease(options: CreateReleaseOptions): Promise<void>;

package/dist/createRelease.js

@@ -0,0 +1,28 @@
+import confirm from "@inquirer/confirm";
+import { Octokit } from "@octokit/core";
+import dotenv from "dotenv";
+export async function createRelease(options) {
+    const { version, body, tagPrefix, override, owner = "mlaursen", repo, prerelease, envPath = ".env.local", } = options;
+    dotenv.config({ path: envPath, override });
+    const octokit = new Octokit({ auth: process.env.GITHUB_TOKEN });
+    try {
+        const response = await octokit.request("POST /repos/{owner}/{repo}/releases", {
+            owner,
+            repo,
+            tag_name: `${tagPrefix}@${version}`,
+            body,
+            prerelease,
+        });
+        console.log(`Created release: ${response.data.html_url}`);
+    }
+    catch (e) {
+        console.error(e);
+        console.log();
+        console.log("The npm token is most likely expired or never created. Update the `.env.local` to include the latest GITHUB_TOKEN");
+        console.log("Regenerate the token: https://github.com/settings/personal-access-tokens");
+        if (!(await confirm({ message: "Try creating the Github release again?" }))) {
+            process.exit(1);
+        }
+        return createRelease({ ...options, override: true });
+    }
+}

package/dist/getCurrentChangeset.d.ts

@@ -0,0 +1 @@
+export declare function getCurrentChangeset(): Promise<string>;

package/dist/getCurrentChangeset.js

@@ -0,0 +1,26 @@
+import confirm from "@inquirer/confirm";
+import rawlist from "@inquirer/rawlist";
+import { execSync } from "node:child_process";
+import { readdir, readFile } from "node:fs/promises";
+import { join } from "node:path";
+export async function getCurrentChangeset() {
+    let changesetName = execSync("git diff --name-only @{upstream} .changeset/*.md")
+        .toString()
+        .trim();
+    if (!changesetName ||
+        !(await confirm({
+            message: `Is "${changesetName}" the correct changeset path?`,
+        }))) {
+        const changesetNames = await readdir(".changeset");
+        changesetName = await rawlist({
+            message: "Select the changeset path",
+            choices: changesetNames
+                .filter((changeset) => changeset.endsWith(".md"))
+                .map((changeset) => ({
+                value: changeset,
+            })),
+        });
+        changesetName = join(".changeset", changesetName);
+    }
+    return await readFile(changesetName, "utf8");
+}

package/dist/getPackageManager.d.ts

@@ -0,0 +1,2 @@
+export type PackageManager = "npm" | "yarn" | "pnpm";
+export declare function getPackageManager(): Promise<PackageManager>;

package/dist/getPackageManager.js

@@ -0,0 +1,24 @@
+import { readFile } from "node:fs/promises";
+import { resolve } from "node:path";
+export async function getPackageManager() {
+    const rawPackageJson = await readFile(resolve(process.cwd(), "package.json"), "utf8");
+    const packageJson = JSON.parse(rawPackageJson);
+    if (typeof packageJson.volta === "object" && packageJson.volta) {
+        const { volta } = packageJson;
+        if ("pnpm" in volta) {
+            return "pnpm";
+        }
+        if ("yarn" in volta) {
+            return "yarn";
+        }
+        return "npm";
+    }
+    if (typeof packageJson.packageManager === "string") {
+        const mgr = packageJson.packageManagerreplace(/@.+/, "");
+        if (mgr === "pnpm" || mgr === "yarn" || mgr === "npm") {
+            return mgr;
+        }
+        throw new Error(`Unsupported package mananger "${mgr}" in package.json`);
+    }
+    throw new Error("Unable to find a package manager");
+}

package/dist/getReleaseVersion.d.ts

@@ -0,0 +1 @@
+export declare function getReleaseVersion(mainPackage?: string): Promise<string>;

package/dist/getReleaseVersion.js

@@ -0,0 +1,21 @@
+import confirm from "@inquirer/confirm";
+import input from "@inquirer/input";
+import { readFile } from "node:fs/promises";
+import { resolve } from "node:path";
+export async function getReleaseVersion(mainPackage) {
+    let packageJsonPath = "package.json";
+    if (mainPackage) {
+        packageJsonPath = `packages/${mainPackage}.json`;
+    }
+    packageJsonPath = resolve(process.cwd(), packageJsonPath);
+    const packageJson = await readFile(packageJsonPath, "utf8");
+    const { version } = JSON.parse(packageJson);
+    if (await confirm({
+        message: `Is "${version}" the next github release version?`,
+    })) {
+        return version;
+    }
+    return await input({
+        message: "Input the next release version for Github",
+    });
+}

package/dist/getTagPrefix.d.ts

@@ -0,0 +1 @@
+export declare function getTagPrefix(mainPackage?: string): Promise<string>;

package/dist/getTagPrefix.js

@@ -0,0 +1,24 @@
+import confirm from "@inquirer/confirm";
+import input from "@inquirer/input";
+import { readFile } from "node:fs/promises";
+import { resolve } from "node:path";
+async function getPkgName() {
+    const pkgJson = await readFile(resolve(process.cwd(), "package.json"), "utf8");
+    return JSON.parse(pkgJson).name || "";
+}
+export async function getTagPrefix(mainPackage) {
+    let pkg = "";
+    try {
+        pkg = mainPackage ?? (await getPkgName());
+    }
+    catch {
+        console.error("Unable to get package name from package.json");
+    }
+    if (!pkg ||
+        !(await confirm({ message: `Use ${pkg} as the next tag name?` }))) {
+        return await input({
+            message: "Enter the next tag name prefix",
+        });
+    }
+    process.exit(1);
+}

package/dist/release.d.ts

@@ -0,0 +1,9 @@
+import { ConfigurableCreateReleaseOptions } from "./createRelease.js";
+export interface ReleaseOptions extends ConfigurableCreateReleaseOptions {
+    skipBuild?: boolean;
+    cleanCommand?: string;
+    buildCommand?: string;
+    mainPackage?: string;
+    versionMessage?: string;
+}
+export declare function release(options: ReleaseOptions): Promise<void>;

package/dist/release.js

@@ -0,0 +1,40 @@
+import { execSync } from "node:child_process";
+import { continueRelease } from "./continueRelease.js";
+import { getCurrentChangeset } from "./getCurrentChangeset.js";
+import { getPackageManager } from "./getPackageManager.js";
+import { getReleaseVersion } from "./getReleaseVersion.js";
+import { createRelease, } from "./createRelease.js";
+import { getTagPrefix } from "./getTagPrefix.js";
+const exec = (command, opts) => {
+    console.log(command);
+    execSync(command, opts);
+};
+export async function release(options) {
+    const { owner, repo, envPath, skipBuild, cleanCommand = "clean", buildCommand = "build", mainPackage, versionMessage = "build(version): version package", } = options;
+    const pkgManager = await getPackageManager();
+    if (!skipBuild) {
+        exec(`${pkgManager} ${cleanCommand}`);
+        exec(`${pkgManager} ${buildCommand}`);
+    }
+    exec(`${pkgManager} changeset`, { stdio: "inherit" });
+    await continueRelease();
+    exec("git add -u");
+    exec("git add .changeset");
+    const changeset = await getCurrentChangeset();
+    exec("pnpm changeset version", { stdio: "inherit" });
+    exec("git add -u");
+    const version = await getReleaseVersion(mainPackage);
+    await continueRelease();
+    exec(`git commit -m "${versionMessage}"`);
+    exec(`${pkgManager} changeset publish`, { stdio: "inherit" });
+    exec("git push --follow-tags");
+    await createRelease({
+        owner,
+        repo,
+        body: changeset,
+        tagPrefix: await getTagPrefix(mainPackage),
+        version,
+        envPath,
+        prerelease: version.includes("next"),
+    });
+}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@mlaursen/release-script",
+  "type": "module",
+  "version": "0.0.1",
+  "description": "The release script I normally use for packages I publish to npm",
+  "repository": "https://github.com/mlaursen/release-script.git",
+  "author": "Mikkel Laursen <mlaursen03@gmail.com>",
+  "license": "MIT",
+  "files": [
+    "dist/"
+  ],
+  "exports": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "bugs": {
+    "url": "https://github.com/mlaursen/release-script/issues"
+  },
+  "keywords": [
+    "release",
+    "script",
+    "npm"
+  ],
+  "dependencies": {
+    "@changesets/cli": "^2.29.5",
+    "@inquirer/confirm": "^5.1.14",
+    "@inquirer/input": "^4.2.1",
+    "@inquirer/rawlist": "^4.1.5",
+    "@octokit/core": "^7.0.3",
+    "dotenv": "^17.2.1"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.29",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.1.2",
+    "prettier": "^3.6.2",
+    "tsx": "^4.20.3",
+    "typescript": "^5.8.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "lint-staged": {
+    "**/*.{js,jsx,ts,tsx,md,yml,yaml,json}": [
+      "prettier --write"
+    ]
+  },
+  "volta": {
+    "node": "22.17.1",
+    "pnpm": "10.13.1"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "check-format": "prettier --check .",
+    "format": "prettier --write .",
+    "clean": "rm -rf dist",
+    "build": "tsc -p tsconfig.build.json",
+    "release": "tsx index.ts"
+  }
+}