@varlet/release 0.4.4 → 1.0.1

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@varlet/release",
-  "version": "0.4.4",
+  "version": "1.0.1",
   "description": "publish all packages, generate changelogs and check commit messages",
   "keywords": [
-    "varlet",
-    "release",
     "changelog",
-    "commit-lint"
+    "commit-lint",
+    "release",
+    "varlet"
   ],
   "bugs": "https://github.com/varletjs/release/issues",
   "repository": {
@@ -19,15 +19,12 @@
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
-      "import": "./dist/index.js",
-      "require": "./dist/index.cjs"
+      "default": "./dist/index.js"
     }
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "bin": {
-    "vr": "bin/index.js"
+    "vr": "dist/cli.js"
   },
   "files": [
     "dist"
@@ -37,51 +34,57 @@
     "commit-msg": "pnpm run commit-lint -p $1"
   },
   "lint-staged": {
+    "*.{md}": "prettier --write",
     "*.{ts,js}": [
       "prettier --write",
       "eslint --fix"
     ],
-    "*.md": "prettier --write"
+    "package.json": "prettier --write"
   },
   "dependencies": {
-    "@inquirer/prompts": "^6.0.1",
+    "@clack/prompts": "^1.0.0",
     "commander": "^11.1.0",
     "conventional-changelog": "^5.1.0",
-    "fs-extra": "^11.1.1",
-    "glob": "^10.3.10",
-    "nanospinner": "^1.1.0",
-    "rslog": "^1.2.3",
+    "fs-extra": "^11.3.3",
+    "rslog": "^2.0.0",
     "semver": "^7.5.4",
-    "tinyexec": "^0.3.0"
+    "tinyexec": "^1.0.2"
   },
   "devDependencies": {
     "@configurajs/eslint": "^0.1.2",
     "@configurajs/prettier": "^0.1.4",
+    "@ianvs/prettier-plugin-sort-imports": "^4.7.1",
     "@types/conventional-changelog": "^3.1.5",
     "@types/fs-extra": "^11.0.4",
-    "@types/node": "^20.9.0",
+    "@types/node": "^22.14.0",
     "@types/semver": "^7.5.5",
-    "@varlet/eslint-config": "^2.18.4",
-    "eslint": "^9.17.0",
-    "lint-staged": "^15.2.0",
-    "prettier": "^3.1.0",
-    "rimraf": "^6.0.1",
-    "simple-git-hooks": "^2.9.0",
-    "tsup": "^8.3.0",
-    "typescript": "^5.2.2"
+    "@vitest/coverage-v8": "^4.0.18",
+    "eslint": "^9.39.2",
+    "lint-staged": "^16.2.7",
+    "prettier": "^3.8.1",
+    "prettier-plugin-packagejson": "^3.0.0",
+    "prettier-plugin-tailwindcss": "^0.7.2",
+    "rimraf": "^6.1.2",
+    "simple-git-hooks": "^2.13.1",
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
   },
   "engines": {
-    "node": ">=16.0.0",
-    "pnpm": ">=9.0"
+    "node": "^20.19.0 || >=22.12.0",
+    "pnpm": ">=10.0"
   },
   "scripts": {
-    "build": "tsup",
+    "build": "tsdown",
     "clean": "rimraf node_modules dist",
-    "commit-lint": "node bin/index.js commit-lint",
-    "dev": "tsup --watch",
-    "format": "prettier --write .",
-    "lint": "eslint --fix .",
-    "release": "pnpm build && node bin/index.js release -c",
+    "commit-lint": "node dist/cli.js commit-lint",
+    "dev": "tsdown --watch",
+    "format": "eslint . --fix && prettier --write .",
+    "lint": "eslint . && prettier --check .",
+    "release": "pnpm build && vitest run && node scripts/release.js",
+    "release:dev": "pnpm build && node scripts/release.js",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage",
     "type-check": "tsc --noEmit"
   }
 }

package/bin/index.js

@@ -1,47 +0,0 @@
-#!/usr/bin/env node
-import { Command } from 'commander'
-import fse from 'fs-extra'
-import { changelog, commitLint, publish, release } from '../dist/index.js'
-
-const program = new Command()
-
-const packageJson = fse.readJSONSync(new URL('../package.json', import.meta.url))
-
-program.version(packageJson.version)
-
-program
-  .command('release')
-  .option('-r --remote <remote>', 'Remote name')
-  .option('-s --skip-npm-publish', 'Skip npm publish')
-  .option('-sc --skip-changelog', 'Skip generate changelog')
-  .option('-sgt --skip-git-tag', 'Skip git tag')
-  .option('-nt --npm-tag <npmTag>', 'Npm tag')
-  .option('-c --check-remote-version', 'Check remote version')
-  .description('Release all packages and generate changelogs')
-  .action((options) => release(options))
-
-program
-  .command('publish')
-  .option('-c --check-remote-version', 'Check remote version')
-  .option('-nt --npm-tag <npmTag>', 'Npm tag')
-  .description('Publish to npm')
-  .action((options) => publish(options))
-
-program
-  .command('changelog')
-  .option('-rc --releaseCount <releaseCount>', 'Release count')
-  .option('-f --file <file>', 'Changelog filename')
-  .option('-p --preset <preset>', 'Changelog preset')
-  .description('Generate changelog')
-  .action((options) => changelog(options))
-
-program
-  .command('commit-lint')
-  .option('-p --commitMessagePath <path>', 'Git commit message path')
-  .option('-r --commitMessageRe <reg>', 'Validate the regular of whether the commit message passes')
-  .option('-e --errorMessage <message>', 'Validation failed to display error messages')
-  .option('-w --warningMessage <message>', 'Validation failed to display warning messages')
-  .description('Lint commit message')
-  .action((option) => commitLint(option))
-
-program.parse()

package/dist/index.cjs

@@ -1,409 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  COMMIT_MESSAGE_RE: () => COMMIT_MESSAGE_RE,
-  changelog: () => changelog,
-  commitLint: () => commitLint,
-  getCommitMessage: () => getCommitMessage,
-  isSameVersion: () => isSameVersion,
-  isVersionCommitMessage: () => isVersionCommitMessage,
-  publish: () => publish,
-  release: () => release,
-  updateVersion: () => updateVersion
-});
-module.exports = __toCommonJS(src_exports);
-
-// src/release.ts
-var import_path2 = require("path");
-var import_prompts = require("@inquirer/prompts");
-var import_fs_extra2 = __toESM(require("fs-extra"), 1);
-var import_glob = require("glob");
-var import_nanospinner2 = require("nanospinner");
-var import_rslog = require("rslog");
-var import_semver = __toESM(require("semver"), 1);
-var import_tinyexec = require("tinyexec");
-
-// src/changelog.ts
-var import_path = require("path");
-var import_conventional_changelog = __toESM(require("conventional-changelog"), 1);
-var import_fs_extra = __toESM(require("fs-extra"), 1);
-var import_nanospinner = require("nanospinner");
-var { createWriteStream } = import_fs_extra.default;
-function changelog({
-  releaseCount = 0,
-  file = "CHANGELOG.md",
-  preset = "angular",
-  writerOpts = {
-    transform(commit, context) {
-      let discard = true;
-      const issues = [];
-      commit.notes.forEach((note) => {
-        note.title = "BREAKING CHANGES";
-        discard = false;
-      });
-      if (commit.type === "feat") {
-        commit.type = "Features";
-      } else if (commit.type === "fix") {
-        commit.type = "Bug Fixes";
-      } else if (commit.type === "perf") {
-        commit.type = "Performance Improvements";
-      } else if (commit.type === "revert" || commit.revert) {
-        commit.type = "Reverts";
-      } else if (commit.type === "refactor") {
-        commit.type = "Code Refactoring";
-      } else if (discard) {
-        return false;
-      } else if (commit.type === "docs") {
-        commit.type = "Documentation";
-      } else if (commit.type === "style") {
-        commit.type = "Styles";
-      } else if (commit.type === "test") {
-        commit.type = "Tests";
-      } else if (commit.type === "build") {
-        commit.type = "Build System";
-      } else if (commit.type === "ci") {
-        commit.type = "Continuous Integration";
-      }
-      if (commit.scope === "*") {
-        commit.scope = "";
-      }
-      if (typeof commit.hash === "string") {
-        commit.shortHash = commit.hash.substring(0, 7);
-      }
-      if (typeof commit.subject === "string") {
-        let url = context.repository ? `${context.host}/${context.owner}/${context.repository}` : context.repoUrl;
-        if (url) {
-          url = `${url}/issues/`;
-          commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
-            issues.push(issue);
-            return `[#${issue}](${url}${issue})`;
-          });
-        }
-        if (context.host) {
-          commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
-            if (username.includes("/")) {
-              return `@${username}`;
-            }
-            return `[@${username}](${context.host}/${username})`;
-          });
-        }
-      }
-      commit.references = commit.references.filter((reference) => {
-        if (issues.indexOf(reference.issue) === -1) {
-          return true;
-        }
-        return false;
-      });
-      return commit;
-    }
-  }
-} = {}) {
-  const s = (0, import_nanospinner.createSpinner)("Generating changelog").start();
-  return new Promise((resolve2) => {
-    (0, import_conventional_changelog.default)(
-      {
-        preset,
-        releaseCount
-      },
-      void 0,
-      void 0,
-      void 0,
-      writerOpts
-    ).pipe(createWriteStream((0, import_path.resolve)(process.cwd(), file))).on("close", () => {
-      s.success({ text: "Changelog generated success!" });
-      resolve2();
-    });
-  });
-}
-
-// src/release.ts
-var cwd = process.cwd();
-var { writeFileSync, readJSONSync } = import_fs_extra2.default;
-var releaseTypes = ["patch", "minor", "major", "prepatch", "preminor", "premajor"];
-var BACK_HINT = "Back to previous step";
-async function isWorktreeEmpty() {
-  const ret = await (0, import_tinyexec.x)("git", ["status", "--porcelain"]);
-  return !ret.stdout;
-}
-async function isSameVersion(version) {
-  const s = (0, import_nanospinner2.createSpinner)("Check remote version...").start();
-  const packageJsones = getPackageJsons();
-  const packageJson = packageJsones.find((packageJson2) => !packageJson2.config.private) || packageJsones[0];
-  if (packageJson) {
-    const { config } = packageJson;
-    try {
-      await (0, import_tinyexec.x)("npm", ["view", `${config.name}@${version ?? config.version}`, "version"], {
-        throwOnError: true
-      });
-      s.warn({
-        text: `The npm package has a same remote version ${version ?? config.version}.`
-      });
-      return true;
-    } catch {
-      s.success();
-      return false;
-    }
-  }
-}
-async function publish({ preRelease, checkRemoteVersion, npmTag }) {
-  const s = (0, import_nanospinner2.createSpinner)("Publishing all packages").start();
-  const args = ["-r", "publish", "--no-git-checks", "--access", "public"];
-  if (checkRemoteVersion && await isSameVersion()) {
-    import_rslog.logger.error("publishing automatically skipped.");
-    return;
-  }
-  if (preRelease) {
-    args.push("--tag", "alpha");
-  } else if (npmTag) {
-    args.push("--tag", npmTag);
-  }
-  const ret = await (0, import_tinyexec.x)("pnpm", args, { throwOnError: true });
-  s.success({ text: "Publish all packages successfully" });
-  ret.stdout && import_rslog.logger.log(ret.stdout);
-}
-async function pushGit(version, remote = "origin", skipGitTag = false) {
-  const s = (0, import_nanospinner2.createSpinner)("Pushing to remote git repository").start();
-  await (0, import_tinyexec.x)("git", ["add", "."], {
-    throwOnError: true
-  });
-  await (0, import_tinyexec.x)("git", ["commit", "-m", `v${version}`], {
-    throwOnError: true
-  });
-  if (!skipGitTag) {
-    await (0, import_tinyexec.x)("git", ["tag", `v${version}`], {
-      throwOnError: true
-    });
-    await (0, import_tinyexec.x)("git", ["push", remote, `v${version}`], {
-      throwOnError: true
-    });
-  }
-  const ret = await (0, import_tinyexec.x)("git", ["push"], {
-    throwOnError: true
-  });
-  s.success({ text: "Push remote repository successfully" });
-  ret.stdout && import_rslog.logger.log(ret.stdout);
-}
-function getPackageJsons() {
-  const packageJsons = ["package.json", ...import_glob.glob.sync("packages/*/package.json")];
-  return packageJsons.map((path) => {
-    const filePath = (0, import_path2.resolve)(cwd, path);
-    return {
-      config: readJSONSync(filePath),
-      filePath
-    };
-  });
-}
-function updateVersion(version) {
-  const packageJsons = getPackageJsons();
-  packageJsons.forEach(({ config, filePath }) => {
-    config.version = version;
-    writeFileSync(filePath, JSON.stringify(config, null, 2));
-  });
-}
-async function confirmRegistry() {
-  const registry = (await (0, import_tinyexec.x)("npm", ["config", "get", "registry"])).stdout;
-  const ret = await (0, import_prompts.confirm)({
-    message: `Current registry is: ${registry}`
-  });
-  return ret;
-}
-async function confirmVersion(currentVersion, expectVersion) {
-  const ret = await (0, import_prompts.select)({
-    message: "Version confirm",
-    choices: [`All packages version ${currentVersion} -> ${expectVersion}`, BACK_HINT].map((value) => ({
-      name: value,
-      value
-    }))
-  });
-  return ret;
-}
-async function confirmRefs(remote = "origin") {
-  const { stdout } = await (0, import_tinyexec.x)("git", ["remote", "-v"]);
-  const reg = new RegExp(`${remote}	(.*) \\(push`);
-  const repo = stdout.match(reg)?.[1];
-  const { stdout: branch } = await (0, import_tinyexec.x)("git", ["branch", "--show-current"]);
-  const ret = await (0, import_prompts.confirm)({
-    message: `Current refs ${repo}:refs/for/${branch}`
-  });
-  return ret;
-}
-async function getReleaseType() {
-  const releaseType = await (0, import_prompts.select)({
-    message: "Please select release type",
-    choices: releaseTypes.map((type) => ({ name: type, value: type }))
-  });
-  return releaseType;
-}
-async function getReleaseVersion(currentVersion) {
-  let isPreRelease = false;
-  let expectVersion = "";
-  let confirmVersionRet = "";
-  do {
-    const type = await getReleaseType();
-    isPreRelease = type.startsWith("pre");
-    expectVersion = import_semver.default.inc(currentVersion, type, `alpha.${Date.now()}`);
-    expectVersion = isPreRelease ? expectVersion.slice(0, -2) : expectVersion;
-    confirmVersionRet = await confirmVersion(currentVersion, expectVersion);
-  } while (confirmVersionRet === BACK_HINT);
-  return { isPreRelease, expectVersion };
-}
-async function release(options) {
-  try {
-    const currentVersion = readJSONSync((0, import_path2.resolve)(cwd, "package.json")).version;
-    if (!currentVersion) {
-      import_rslog.logger.error("Your package is missing the version field");
-      return;
-    }
-    if (!await isWorktreeEmpty()) {
-      import_rslog.logger.error("Git worktree is not empty, please commit changed");
-      return;
-    }
-    if (!await confirmRefs(options.remote)) {
-      return;
-    }
-    if (!options.skipNpmPublish && !await confirmRegistry()) {
-      return;
-    }
-    const { isPreRelease, expectVersion } = await getReleaseVersion(currentVersion);
-    if (options.checkRemoteVersion && await isSameVersion(expectVersion)) {
-      import_rslog.logger.error("Please check remote version.");
-      return;
-    }
-    updateVersion(expectVersion);
-    if (options.task) {
-      await options.task(expectVersion, currentVersion);
-    }
-    if (!options.skipNpmPublish) {
-      await publish({ preRelease: isPreRelease, npmTag: options.npmTag });
-    }
-    if (!isPreRelease) {
-      if (!options.skipChangelog) {
-        await changelog();
-      }
-      await pushGit(expectVersion, options.remote, options.skipGitTag);
-    }
-    import_rslog.logger.success(`Release version ${expectVersion} successfully!`);
-    if (isPreRelease) {
-      try {
-        await (0, import_tinyexec.x)("git", ["restore", "**/package.json"], {
-          throwOnError: true
-        });
-      } catch {
-      }
-      try {
-        await (0, import_tinyexec.x)("git", ["restore", "package.json"], {
-          throwOnError: true
-        });
-      } catch {
-      }
-    }
-  } catch (error) {
-    import_rslog.logger.error(error.toString());
-    process.exit(1);
-  }
-}
-
-// src/commitLint.ts
-var import_fs_extra3 = __toESM(require("fs-extra"), 1);
-var import_rslog2 = require("rslog");
-var import_semver2 = __toESM(require("semver"), 1);
-var { readFileSync } = import_fs_extra3.default;
-var COMMIT_MESSAGE_RE = /^(revert|fix|feat|docs|perf|test|types|style|build|chore|release|refactor|merge|wip)(\(.+\))?!?: (.|\n)+/;
-var ERROR_MESSAGE = "Commit message invalid.";
-var WARNING_MESSAGE = `The rules for commit messages are as follows
-
-Example:
-
-feat: add a new feature
-feat(ui/button): add a new feature in the ui/button scope
-
-fix: fix a bug
-fix(ui/button): fix a bug in the ui/button scope
-
-docs: fix an error in the documentation
-docs(ui/button): fix a documentation error in the ui/button scope
-
-Allowed types:
-- fix
-- feat
-- docs
-- perf
-- test
-- types
-- style
-- build
-- chore
-- release
-- refactor
-- revert
-- merge
-- wip
-
-Commit message reference: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y
-\u53C2\u8003\u962E\u4E00\u5CF0Commit message\u7F16\u5199\u6307\u5357: https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html`;
-function isVersionCommitMessage(message) {
-  return message.startsWith("v") && import_semver2.default.valid(message.slice(1));
-}
-function getCommitMessage(commitMessagePath) {
-  return readFileSync(commitMessagePath, "utf-8").trim();
-}
-function commitLint(options) {
-  const {
-    commitMessagePath,
-    commitMessageRe = COMMIT_MESSAGE_RE,
-    errorMessage = ERROR_MESSAGE,
-    warningMessage = WARNING_MESSAGE
-  } = options;
-  if (!commitMessagePath) {
-    import_rslog2.logger.error("commitMessagePath is required");
-    process.exit(1);
-  }
-  const commitMessage = getCommitMessage(commitMessagePath);
-  const isValidCommitMessage = new RegExp(commitMessageRe).test(commitMessage);
-  if (!isVersionCommitMessage(commitMessage) && !isValidCommitMessage) {
-    import_rslog2.logger.error(errorMessage);
-    import_rslog2.logger.warn(warningMessage);
-    process.exit(1);
-  }
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  COMMIT_MESSAGE_RE,
-  changelog,
-  commitLint,
-  getCommitMessage,
-  isSameVersion,
-  isVersionCommitMessage,
-  publish,
-  release,
-  updateVersion
-});

package/dist/index.d.cts

@@ -1,41 +0,0 @@
-import conventionalChangelog from 'conventional-changelog';
-
-declare function isSameVersion(version?: string): Promise<boolean | undefined>;
-interface PublishCommandOptions {
-    preRelease?: boolean;
-    checkRemoteVersion?: boolean;
-    npmTag?: string;
-}
-declare function publish({ preRelease, checkRemoteVersion, npmTag }: PublishCommandOptions): Promise<void>;
-declare function updateVersion(version: string): void;
-interface ReleaseCommandOptions {
-    remote?: string;
-    npmTag?: string;
-    skipNpmPublish?: boolean;
-    skipChangelog?: boolean;
-    skipGitTag?: boolean;
-    checkRemoteVersion?: boolean;
-    task?(newVersion: string, oldVersion: string): Promise<void>;
-}
-declare function release(options: ReleaseCommandOptions): Promise<void>;
-
-interface ChangelogCommandOptions {
-    file?: string;
-    releaseCount?: number;
-    preset?: 'angular' | 'atom' | 'codemirror' | 'conventionalcommits' | 'ember' | 'eslint' | 'express' | 'jquery' | 'jshint';
-    writerOpts?: Parameters<typeof conventionalChangelog>['4'];
-}
-declare function changelog({ releaseCount, file, preset, writerOpts, }?: ChangelogCommandOptions): Promise<void>;
-
-declare const COMMIT_MESSAGE_RE: RegExp;
-declare function isVersionCommitMessage(message: string): string | false | null;
-declare function getCommitMessage(commitMessagePath: string): string;
-interface CommitLintCommandOptions {
-    commitMessagePath: string;
-    commitMessageRe?: string | RegExp;
-    errorMessage?: string;
-    warningMessage?: string;
-}
-declare function commitLint(options: CommitLintCommandOptions): void;
-
-export { COMMIT_MESSAGE_RE, type ChangelogCommandOptions, type CommitLintCommandOptions, type PublishCommandOptions, type ReleaseCommandOptions, changelog, commitLint, getCommitMessage, isSameVersion, isVersionCommitMessage, publish, release, updateVersion };