cross-release-cli 0.2.2 → 0.4.0

package/README.md

@@ -13,7 +13,8 @@ pnpm i -D cross-release
 ```json
 {
     "scripts": {
-        "release": "cross-release"
+        "release": "cross-release -ax 'pnpm changelog' && pnpm build && pnpm -r publish",
+        "changelog": "conventional-changelog -si CHANGELOG.md",
     }
 }
 ```
@@ -26,23 +27,34 @@ pnpm run release
 
 ## Command line
 
-| short | long                   | description                                         | default                                         |
-| ----- | ---------------------- | --------------------------------------------------- | ----------------------------------------------- |
-| -V    | --version              | output the version number                           | false                                           |
-| -a    | --all                  | Add all changed files to staged                     | false                                           |
-| -c    | --config [file]        | Config file                                         | auto detect                                     |
-| -D    | --dry                  | Dry run                                             | false                                           |
-| -d    | --debug                | Enable debug mode                                   | false                                           |
-| -e    | --exclude [dir]        | Folders to exclude from search                      | ["node_modules",".git","target","build","dist"] |
-| -m    | --main                 | Base project language [e.g. java, rust, javascript] | "javascript"                                    |
-| -r    | --recursive            | Run the command for each project in the workspace   | false                                           |
-| -x    | --execute [command...] | Execute the command                                 | []                                              |
-| -y    | --yes                  | Answer yes to all prompts                           | false                                           |
-|       | --cwd [dir]            | Set working directory                               | process.cwd()                                   |
-| -c    | --no-commit            | Skip committing changes                             | false                                           |
-| -p    | --no-push              | Skip pushing                                        | false                                           |
-| -t    | --no-tag               | Skip tagging                                        | false                                           |
-| -h    | --help                 | Display this message                                | false                                           |
+```
+Usage:
+  $ cross-release [version] [options]
+
+Options:
+  -v, --version                 Display version number
+  -a, --all                     shortcut for --commit.stageAll
+  -c, --config [file]           Config file (auto detect by default)
+  -D, --dry                     Dry run
+  -d, --debug                   Enable debug mode
+  -e, --exclude [dir...]        Folders to exclude from search
+  -m, --main [lang]             Base project language [e.g. java, rust, javascript]
+  -r, --recursive               Run the command for each project in the workspace
+  -x, --execute [command...]    Execute the command
+  -y, --yes                     Answer yes to all prompts
+  --cwd [dir]                   Set working directory
+  --commit                      Committing changes
+  --commit.signoff              Commit with signoff
+  --commit.stageAll             Stage all changes before commit
+  --commit.template <template>  Template for commit message
+  --commit.verify               Verify commit message
+  --push                        Pushing Commit to remote
+  --push.followTags             Pushing with follow tags
+  --push.branch <branch>        Branch name to push
+  --tag                         Tagging for release
+  --tag.template <template>     Template for tag message
+  -h, --help                    Display this message
+```
 
 ## Configuration
 
@@ -65,6 +77,7 @@ export default {
     "cross-release": {
         // "commit": false,
         commit: {
+            signoff: true,
             // Whether to stage all un-staged files or stage only changed files
             stageAll: false,
             // the symbol '%s' will be replace to the version number that you specified
@@ -76,6 +89,8 @@ export default {
         dry: false,
         // Your config will be append within default exclude folders
         excludes: ["path/to/exclude"],
+        // use for read current version number
+        main: "javascript",
         // "push": false,
         push: {
             branch: false,

package/dist/app.d.ts

@@ -1,4 +1,4 @@
-import { ReleaseOptions } from "./types-D4PQyQEq.js";
+import { ReleaseOptions } from "./types-Bmp7nnWP.js";
 import { ProjectFile } from "cross-bump";
 
 //#region src/app.d.ts
@@ -13,6 +13,7 @@ declare class App {
   private _taskStatus;
   constructor(argv?: string[]);
   checkGitClean(): void;
+  checkGitRemote(): void;
   confirmReleaseOptions(): Promise<void>;
   executeTasks(): Promise<void>;
   resolveExecutes(): void;
@@ -24,5 +25,6 @@ declare class App {
   get nextVersion(): string;
   get options(): ReleaseOptions;
   get projectFiles(): ProjectFile[];
-} //#endregion
+}
+//#endregion
 export { App as default };

package/dist/app.js

@@ -72,6 +72,7 @@ let ExitCode = /* @__PURE__ */ function(ExitCode$1) {
 	ExitCode$1[ExitCode$1["Canceled"] = 2] = "Canceled";
 	ExitCode$1[ExitCode$1["FatalError"] = 1] = "FatalError";
 	ExitCode$1[ExitCode$1["GitDirty"] = 3] = "GitDirty";
+	ExitCode$1[ExitCode$1["GitUnreachable"] = 4] = "GitUnreachable";
 	ExitCode$1[ExitCode$1["InvalidArgument"] = 9] = "InvalidArgument";
 	ExitCode$1[ExitCode$1["Success"] = 0] = "Success";
 	return ExitCode$1;
@@ -150,19 +151,19 @@ const cliOptions = z.object({
 
 //#endregion
 //#region package.json
-var version = "0.2.1";
+var version = "0.3.0";
 
 //#endregion
 //#region src/cli.ts
 const debug$3 = createDebug("cli");
 function createCliProgram(argv) {
-	const cli = cac("cross-release").usage("A release tool that support multi programming language").version(version).usage("[version] [options]").option("-c, --config [file]", "Config file (auto detect by default)").option("-D, --dry", "Dry run").option("-d, --debug", "Enable debug mode").option("-e, --exclude [dir...]", "Folders to exclude from search").option("-m, --main [lang]", "Base project language [e.g. java, rust, javascript]").option("-r, --recursive", "Run the command for each project in the workspace").option("-x, --execute [command...]", "Execute the command").option("-y, --yes", "Answer yes to all prompts").option("--cwd [dir]", "Set working directory").option("--commit", "Committing changes").option("--commit.signoff", "Pushing Commit with signoff").option("--commit.stageAll", "Stage all changes before pushing").option("--commit.template <template>", "Template for commit message").option("--commit.verify", "Verify commit message").option("--push", "Pushing Commit to remote").option("--push.followTags", "Pushing with follow tags").option("--push.branch <branch>", "Branch name to push").option("--push.followTags", "pushing with follow tags").option("--tag", "Tagging for release").option("--tag.template <template>", "Template for tag message").help();
+	const cli = cac("cross-release").usage("A release tool that support multi programming language").version(version).usage("[version] [options]").option("-a, --all", "shortcut for --commit.stageAll").option("-c, --config [file]", "Config file (auto detect by default)").option("-D, --dry", "Dry run").option("-d, --debug", "Enable debug mode").option("-e, --exclude [dir...]", "Folders to exclude from search").option("-m, --main [lang]", "Base project language [e.g. java, rust, javascript]").option("-r, --recursive", "Run the command for each project in the workspace").option("-x, --execute [command...]", "Execute the command").option("-y, --yes", "Answer yes to all prompts").option("--cwd [dir]", "Set working directory").option("--commit", "Committing changes").option("--commit.signoff", "Commit with signoff").option("--commit.stageAll", "Stage all changes before commit").option("--commit.template <template>", "Template for commit message").option("--commit.verify", "Verify commit message").option("--push", "Pushing Commit to remote").option("--push.followTags", "Pushing with follow tags").option("--push.branch <branch>", "Branch name to push").option("--tag", "Tagging for release").option("--tag.template <template>", "Template for tag message").help();
 	return cli.parse(argv);
 }
 function argvToReleaseOptions(cli) {
 	const { args, options } = cli;
 	const opts = {
-		commit: options.commit,
+		commit: merge({ stageAll: options.all }, options.commit),
 		config: options.config,
 		cwd: options.cwd,
 		debug: options.debug,
@@ -225,6 +226,27 @@ const execa = execaSync({
 	all: true,
 	reject: false
 });
+function gitLsRemote(options) {
+	const { cwd = process.cwd(), dry = false, mode = "branches", pattern, remote, repository = "origin" } = options;
+	const s = spinner();
+	s.start("listing remote...");
+	const args = [];
+	if (remote) args.push(remote);
+	if (mode) args.push(`--${mode}`);
+	args.push(repository);
+	if (pattern) args.push(pattern);
+	debug$2(`command: git ls-remote ${args.join(" ")}`);
+	if (!dry) {
+		const { all, exitCode, failed, shortMessage } = execa("git", ["ls-remote", ...args], { cwd });
+		debug$2("git ls-remote stdout:", all);
+		if (failed) {
+			s.stop(color.red(shortMessage), exitCode);
+			return false;
+		}
+	}
+	s.stop(`listed remote`);
+	return true;
+}
 function gitTag(options) {
 	const { cwd = process.cwd(), del = false, dry = false, force = false, message: message$1, tagName: name } = options ?? {};
 	const s = spinner();
@@ -232,15 +254,7 @@ function gitTag(options) {
 	const args = [];
 	if (del) args.push("--delete");
 	else if (!message$1 || message$1?.length === 0) log.warn("no message provided, is recommended to provide a message for create an annotated tag");
-	else args.push(
-		// Create an annotated tag, which is recommended for releases.
-		// See https://git-scm.com/docs/git-tag
-		"--annotate",
-		// Use the same commit message for the tag
-		"--message",
-		// formatMessageString(template, nextVersion),
-		message$1
-);
+	else args.push("--annotate", "--message", message$1);
 	if (force) args.push("--force");
 	args.push(name);
 	debug$2(`command: git tag ${args.join(" ")}`);
@@ -491,11 +505,23 @@ var App = class {
 		const commit = resolveAltOptions(this._options, "commit");
 		const isClean = isGitClean({ cwd });
 		if (!isClean && !commit.stageAll) {
-			log.warn("git is not clean, please commit or stash your changes before release");
+			log.warn("git is not clean, please commit or stash your changes");
 			this.#done();
 			process.exit(ExitCode.GitDirty);
 		}
 	}
+	checkGitRemote() {
+		const { cwd, debug: debug$5, dry } = this._options;
+		const hasRemote = gitLsRemote({
+			cwd,
+			dry: dry || debug$5
+		});
+		if (!hasRemote) {
+			log.warn("git remote not found, please add remote or check your network");
+			this.#done();
+			process.exit(ExitCode.GitUnreachable);
+		}
+	}
 	async confirmReleaseOptions() {
 		const { cwd, dry, yes } = this._options;
 		const confirmTask = async (name, message$1, exec) => {
@@ -643,6 +669,7 @@ var App = class {
 	async run() {
 		this.#start();
 		this.checkGitClean();
+		this.checkGitRemote();
 		this.resolveProjectFiles();
 		await this.resolveNextVersion();
 		this.resolveProjects();

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-import { DefineConfigOptions } from "./types-D4PQyQEq.js";
+import { DefineConfigOptions } from "./types-Bmp7nnWP.js";
 
 //#region src/index.d.ts
 declare function defineConfig(config: DefineConfigOptions): DefineConfigOptions;
-
 //#endregion
 export { defineConfig };

package/dist/types-Bmp7nnWP.d.ts

@@ -0,0 +1,114 @@
+import { ProjectCategory } from "cross-bump";
+import "cac";
+
+//#region src/types.d.ts
+
+type DefineConfigOptions = Partial<Omit<ReleaseOptions, "config">>;
+type ReleaseOptions = {
+  /**
+   * Indicates whether to commit the changes.
+   */
+  commit: boolean | CommitOptions;
+  /**
+   * Specifies the path to the configuration file.
+   */
+  config: string;
+  /**
+   * The directory path where the operation will be performed.
+   * @default process.cwd()
+   */
+  cwd: string;
+  /**
+   * Enable debug log
+   */
+  debug: boolean;
+  /**
+   * Whether the operation is being run in a dry-run mode (simulated execution).
+   */
+  dry: boolean;
+  /**
+   * The list of directories to exclude from the search.
+   * @default ["node_modules", ".git", "target", "build", "dist"]
+   */
+  exclude: string[];
+  /**
+   * The command to execute before pushing.
+   */
+  execute: string[];
+  /**
+   * Specifies the main project category.
+   */
+  main: ProjectCategory;
+  /**
+   * Whether push changes to remote and push options
+   * @default false
+   */
+  push: boolean | PushOptions;
+  /**
+   * Specifies whether the operation should be performed recursively.
+   * @default false
+   */
+  recursive: boolean;
+  /**
+   * Indicates whether to create a tag for a release.
+   * @default false
+   */
+  tag: boolean | TagOptions;
+  /**
+   * The version string associated with the command or operation.
+   */
+  version: string;
+  /**
+   * Whether all prompts requiring user input will be answered with "yes".
+   * @default false
+   */
+  yes: boolean;
+};
+type CommitOptions = {
+  /**
+   * Whether to sign the commit.
+   * @default true
+   */
+  signoff?: true;
+  /**
+   * Whether to stage all files or only modified files.
+   * @default false
+   */
+  stageAll?: boolean;
+  /**
+   * The template string for the commit message. if the template contains any "%s" placeholders,
+   * then they are replaced with the version number;
+   * @default "chore: release v%s"
+   */
+  template?: string;
+  /**
+   * Whether to enable git pre-commit and commit-msg hook.
+   * @default true
+   */
+  verify?: boolean;
+};
+type PushOptions = {
+  /**
+   * The branch name, Use the same branch name as the local if not specified.
+   */
+  branch?: string;
+  /**
+   * Whether to follow tags
+   * @default true
+   */
+  followTags?: boolean;
+  /**
+   * The remote name, defaults to the upstream defined in the Git repository if not specified.
+   */
+  remote?: string;
+};
+type TagOptions = {
+  /**
+   * The template for tag name, same as @type {CommitOptions.template}
+   * if the template contains any "%s" placeholders,
+   * then they are replaced with the version number;
+   */
+  template?: string;
+};
+//#endregion
+export { DefineConfigOptions, ReleaseOptions };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "cross-release-cli",
   "type": "module",
-  "version": "0.2.2",
+  "version": "0.4.0",
   "description": "command line app for cross language bump utility",
   "author": {
     "name": "rainbowatcher",
@@ -18,6 +18,7 @@
     "url": "https://github.com/rainbowatcher/cross-release/issues"
   },
   "main": "dist/index.js",
+  "types": "./dist/index.d.ts",
   "bin": {
     "cross-release": "./bin/cross-release.js"
   },
@@ -26,19 +27,19 @@
     "dist"
   ],
   "dependencies": {
-    "@clack/prompts": "^0.10.1",
+    "@clack/prompts": "^0.11.0",
     "@rainbowatcher/common": "^0.7.0",
     "@rainbowatcher/fs-extra": "^0.7.0",
     "@rainbowatcher/path-extra": "^0.7.0",
     "cac": "^6.7.14",
     "debug": "^4.4.1",
     "defu": "^6.1.4",
-    "execa": "^9.5.3",
+    "execa": "^9.6.0",
     "is-unicode-supported": "^2.1.0",
     "picocolors": "^1.1.1",
     "unconfig": "^7.3.2",
-    "zod": "^3.24.4",
-    "cross-bump": "0.2.2"
+    "zod": "^4.0.17",
+    "cross-bump": "0.4.0"
   },
   "devDependencies": {
     "@rainbowatcher/maybe": "^0.7.0"

package/dist/types-D4PQyQEq.d.ts

@@ -1,112 +0,0 @@
-import { ProjectCategory } from "cross-bump";
-
-//#region src/types.d.ts
-
-type DefineConfigOptions = Partial<Omit<ReleaseOptions, "config">>;
-type ReleaseOptions = {
-  /**
-  * Indicates whether to commit the changes.
-  */
-  commit: boolean | CommitOptions;
-  /**
-  * Specifies the path to the configuration file.
-  */
-  config: string;
-  /**
-  * The directory path where the operation will be performed.
-  * @default process.cwd()
-  */
-  cwd: string;
-  /**
-  * Enable debug log
-  */
-  debug: boolean;
-  /**
-  * Whether the operation is being run in a dry-run mode (simulated execution).
-  */
-  dry: boolean;
-  /**
-  * The list of directories to exclude from the search.
-  * @default ["node_modules", ".git", "target", "build", "dist"]
-  */
-  exclude: string[];
-  /**
-  * The command to execute before pushing.
-  */
-  execute: string[];
-  /**
-  * Specifies the main project category.
-  */
-  main: ProjectCategory;
-  /**
-  * Whether push changes to remote and push options
-  * @default false
-  */
-  push: boolean | PushOptions;
-  /**
-  * Specifies whether the operation should be performed recursively.
-  * @default false
-  */
-  recursive: boolean;
-  /**
-  * Indicates whether to create a tag for a release.
-  * @default false
-  */
-  tag: boolean | TagOptions;
-  /**
-  * The version string associated with the command or operation.
-  */
-  version: string;
-  /**
-  * Whether all prompts requiring user input will be answered with "yes".
-  * @default false
-  */
-  yes: boolean;
-};
-type CommitOptions = {
-  /**
-  * Whether to sign the commit.
-  * @default true
-  */
-  signoff?: true;
-  /**
-  * Whether to stage all files or only modified files.
-  * @default false
-  */
-  stageAll?: boolean;
-  /**
-  * The template string for the commit message. if the template contains any "%s" placeholders,
-  * then they are replaced with the version number;
-  * @default "chore: release v%s"
-  */
-  template?: string;
-  /**
-  * Whether to enable git pre-commit and commit-msg hook.
-  * @default true
-  */
-  verify?: boolean;
-};
-type PushOptions = {
-  /**
-  * The branch name, Use the same branch name as the local if not specified.
-  */
-  branch?: string;
-  /**
-  * Whether to follow tags
-  * @default true
-  */
-  followTags?: boolean;
-  /**
-  * The remote name, defaults to the upstream defined in the Git repository if not specified.
-  */
-  remote?: string;
-};
-type TagOptions = {
-  /**
-  * The template for tag name, same as @type {CommitOptions.template}
-  * if the template contains any "%s" placeholders,
-  * then they are replaced with the version number;
-  */
-  template?: string;
-}; //#endregion
-export { DefineConfigOptions, ReleaseOptions };