@thisismanta/semantic-version 11.0.0 → 11.2.0

package/README.md

@@ -28,9 +28,9 @@ commit-msg:
 
 ---
 
-### `npx make-next-release`
+### `npx make-next-release [--dry-run]`
 
-This command is supposed to be run on **GitHub Actions**. It will run `npm version <new-version>`, which `<new-version>` is automatically derived from your commit messages according to the table below and then it creates a new entry on [**GitHub releases**](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases).
+This command is supposed to be run on **GitHub Actions**. It will run `npm version <new-version>`, which `<new-version>` is automatically derived from your commit messages according to the table below and then it creates a new entry on [**GitHub Releases**](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases).
 
 | Commit message type | Trigger                    |
 | ------------------- | -------------------------- |
@@ -39,28 +39,43 @@ This command is supposed to be run on **GitHub Actions**. It will run `npm versi
 | `fix` or `build`    | `npm version patch`        |
 | Others              | Does not run `npm version` |
 
+```json
+// package.json
+{
+	"scripts": {
+		"preversion": "npm run test",
+		"version": "npm run build && git add lib",
+		"postversion": "npm publish"
+	}
+}
+```
+
+By supplying `--dry-run` argument, it uses `git push --dry-run`, `npm version --ignore-scripts` and creates a new _draft_ **GitHub Release** entry instead, which you may want to [manually delete the _draft_ release](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#deleting-a-release) afterward.
+
 ```yml
 # .github/workflows/push.yml
 on:
    push:
      branches: [master]
 
+permissions:
+  contents: write # Grant Git push and GitHub Release write access to GITHUB_TOKEN
+
  jobs:
    release:
      runs-on: ubuntu-latest
      steps:
        - uses: actions/checkout@v6
          with:
-           fetch-depth: 0 # Ensure Git tags are fetched
+           fetch-depth: 0 # Ensure entire Git history and Git tags are accessible
 
        - uses: actions/setup-node@v6
          with:
-           node-version-file: 'package.json'
-           cache: npm
+           node-version: 22
 
-       - run: npm ci # Install semantic-version as part of the dependencies
+       - run: npm install @thisismanta/semantic-version@11
 
        - run: npx make-next-release
          env:
-           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make it possible to create a new release using GitHub API
+           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```

package/bin/lint-commit-message

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../lib/lint-commit-message')(process.argv.at(2))
+require('../lib/lint-commit-message.js')

package/bin/make-next-release

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../lib/make-next-release').default()
+require('../lib/make-next-release.js')

package/lib/index.d.ts

@@ -0,0 +1,22 @@
+export declare function debug(text: string | number): void;
+export declare function run(command: string): Promise<string>;
+export declare const npm: string;
+export declare const allowedTypes: readonly ["feat", "fix", "build", "chore"];
+export type SemanticType = (typeof allowedTypes)[number];
+export declare function checkConventionalMessage(message: string): {
+    type: "feat" | "fix" | "build" | "chore" | undefined;
+    breaking: boolean;
+    subject: string;
+    errors: string[];
+};
+interface GitCommit {
+    hash: string;
+    type: string | undefined;
+    breaking: boolean;
+    subject: string;
+}
+export declare function getReleaseType(commits: Array<GitCommit>): string | null;
+export declare function getCurrentPackageVersion(): Promise<string>;
+export declare function getGitHistory(version: string): Promise<Array<GitCommit>>;
+export declare function getReleaseNote(commits: Array<GitCommit>): string;
+export {};

package/lib/index.js

@@ -1,31 +1,11 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region src/index.ts
-const titlePattern = /^(?<type>\w+)(?<scope>\(.*?\))?(?<breaking>\!)?:(?<subject>.+)/;
-const allowedTypes = [
-	"feat",
-	"fix",
-	"build",
-	"chore"
-];
-function checkConventionalMessage(message) {
-	const { type, scope, breaking, subject } = message.match(titlePattern)?.groups || {};
-	const errors = [
-		!type && "The pull request title must match the pattern of \"<type>[!]: <subject>\" which is a reduced set of https://www.conventionalcommits.org/en/v1.0.0/",
-		typeof type === "string" && allowedTypes.includes(type.toLowerCase()) === false && "The type in a pull request title must be one of " + allowedTypes.map((name) => "\"" + name + "\"").join(", ") + ".",
-		typeof type === "string" && /^[a-z]+$/.test(type) === false && "The type in a pull request title must be in lower case only.",
-		scope && "A scope in a pull request title is never allowed.",
-		typeof type === "string" && typeof subject !== "string" && "The subject in a pull request title must be provided.",
-		typeof subject === "string" && (subject.match(/^ +/)?.[0].length || 0) !== 1 && "A single space must be after \":\" symbol.",
-		typeof subject === "string" && /^[a-z]/.test(subject.trim()) === false && "The subject must start with a lower case latin alphabet.",
-		typeof subject === "string" && /[\s\.]+$/.test(subject) && /\.{3}$/.test(subject.trim()) === false && "The subject must not end with a period or a space."
-	].filter((error) => typeof error === "string");
-	return {
-		type: allowedTypes.includes(type) ? type : void 0,
-		breaking: !!breaking,
-		subject: typeof subject === "string" ? subject.trim().replace(/[\s\.]+$/, "") + (/\.{3}$/.test(subject.trim()) ? "..." : "") : message,
-		errors
-	};
-}
-//#endregion
-exports.allowedTypes = allowedTypes;
-exports.checkConventionalMessage = checkConventionalMessage;
+const require_src = require("./src.js");
+exports.allowedTypes = require_src.allowedTypes;
+exports.checkConventionalMessage = require_src.checkConventionalMessage;
+exports.debug = require_src.debug;
+exports.getCurrentPackageVersion = require_src.getCurrentPackageVersion;
+exports.getGitHistory = require_src.getGitHistory;
+exports.getReleaseNote = require_src.getReleaseNote;
+exports.getReleaseType = require_src.getReleaseType;
+exports.npm = require_src.npm;
+exports.run = require_src.run;

package/lib/lint-commit-message.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/lint-commit-message.js

@@ -1,15 +1,14 @@
-const require_chunk = require("./chunk.js");
-const require_index = require("./index.js");
+const require_src = require("./src.js");
 let node_fs_promises = require("node:fs/promises");
-node_fs_promises = require_chunk.__toESM(node_fs_promises);
+node_fs_promises = require_src.__toESM(node_fs_promises);
 //#region src/lint-commit-message.ts
-async function lint_commit_message_default(messageFilePath) {
+(async () => {
+	const messageFilePath = process.argv[2];
 	console.log("Verifying the commit message...");
 	const message = (await node_fs_promises.readFile(messageFilePath, "utf-8")).trim();
 	console.log("  input =", message);
-	const { errors } = require_index.checkConventionalMessage(message);
+	const { errors } = require_src.checkConventionalMessage(message);
 	for (const error of errors) console.error("  error =", error);
 	process.exitCode = errors.length;
-}
+})();
 //#endregion
-module.exports = lint_commit_message_default;

package/lib/make-next-release.d.ts

@@ -0,0 +1 @@
+export {};