@thisismanta/semantic-version 10.0.0 → 11.1.0

package/README.md

@@ -1,53 +1,76 @@
-# `npx lint-commit-message <path>`
+The following commands respect [`packageManager`](https://github.com/nodejs/corepack?tab=readme-ov-file#when-authoring-packages) field first then [`devEngines.packageManager.name`](https://docs.npmjs.com/cli/v10/configuring-npm/package-json#devengines) in _package.json_, but fallback to **npm** if none is specified.
+
+---
+
+### `npx lint-commit-message <path>`
 
 The `<path>` must point to a text file containing commit message that complies with the following pattern:
 
 ```
 <type>[!]: <subject>
 ```
+
 Where
-- `<type>` can be either `feat`, `fix`, `test`, `refactor` or `chore`.
-- `!` indicates that the commit contains breaking changes.
+
+- `<type>` can be either `feat`, `fix`, `build` or `chore`.
+- `!` indicates that the commit contains a breaking change.
 - `<subject>` is the actual commit message where the first word must be written in lower cases.
 
-> Usage example with [**lefthook**](https://www.npmjs.com/package/lefthook)
-> ```yml
-> # lefthook.yml
-> commit-msg:
->   commands:
->     lint:
->       run: npx lint-commit-message {1}
-> ```
-
-# `npx auto-npm-version`
-
-This command is supposed to be run on CI, such as **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|Post-commit command|
-|---|---|
-|`!`|`npm version major`|
-|`feat`|`npm version minor`|
-|`fix`|`npm version patch`|
-|Others|Does not run `npm version`|
-
-> Usage example with **GitHub Actions**
-> ```yml
-> on:
->   push:
->     branches: [master]
-> jobs:
->   release:
->     runs-on: ubuntu-latest
->     steps:
->       - uses: actions/checkout@v4
->         with:
->           fetch-depth: 0 # Ensure Git tags are fetched
->       - uses: actions/setup-node@v4
->         with:
->           node-version-file: 'package.json'
->           cache: npm
->       - run: npm ci # Install semantic-version as part of the dependencies
->       - run: npx auto-npm-version
->         env:
->           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make it possible to create a new release using GitHub API
-> ```
+Usage example with [**lefthook**](https://www.npmjs.com/package/lefthook):
+
+```yml
+# lefthook.yml
+commit-msg:
+  commands:
+    lint:
+      run: npx lint-commit-message {1}
+```
+
+---
+
+### `npx make-next-release`
+
+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                    |
+| ------------------- | -------------------------- |
+| `!`                 | `npm version major`        |
+| `feat`              | `npm version minor`        |
+| `fix` or `build`    | `npm version patch`        |
+| Others              | Does not run `npm version` |
+
+```json
+// package.json
+{
+	"scripts": {
+		"version": "npm run build",
+		"postversion": "npm publish"
+	}
+}
+```
+
+```yml
+# .github/workflows/push.yml
+on:
+   push:
+     branches: [master]
+
+ jobs:
+   release:
+     runs-on: ubuntu-latest
+     steps:
+       - uses: actions/checkout@v6
+         with:
+           fetch-depth: 0 # Ensure Git tags are fetched
+
+       - uses: actions/setup-node@v6
+         with:
+           node-version-file: 'package.json'
+           cache: npm
+
+       - run: npm ci # Install semantic-version as part of the dependencies
+
+       - run: npx make-next-release
+         env:
+           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Make it possible to create a new release using GitHub API
+```

package/bin/lint-commit-message

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

package/bin/make-next-release

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+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 +1,11 @@
-"use strict";var __defProp=Object.defineProperty;var __getOwnPropDesc=Object.getOwnPropertyDescriptor;var __getOwnPropNames=Object.getOwnPropertyNames;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 __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:true}),mod);var index_exports={};__export(index_exports,{allowedTypes:()=>allowedTypes,checkConventionalMessage:()=>checkConventionalMessage});module.exports=__toCommonJS(index_exports);var titlePattern=/^(?<type>\w+)(?<scope>\(.*?\))?(?<breaking>\!)?:(?<subject>.+)/;var allowedTypes=["feat","fix","build","chore"];function checkConventionalMessage(message){const pattern=message.match(titlePattern)?.groups||{};const{type,scope,breaking,subject}=pattern;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}}0&&(module.exports={allowedTypes,checkConventionalMessage});
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+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 +1,14 @@
-"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(isNodeMode||!mod||!mod.__esModule?__defProp(target,"default",{value:mod,enumerable:true}):target,mod));var __toCommonJS=mod=>__copyProps(__defProp({},"__esModule",{value:true}),mod);var lint_commit_message_exports={};__export(lint_commit_message_exports,{default:()=>main});module.exports=__toCommonJS(lint_commit_message_exports);var fs=__toESM(require("fs/promises"));var titlePattern=/^(?<type>\w+)(?<scope>\(.*?\))?(?<breaking>\!)?:(?<subject>.+)/;var allowedTypes=["feat","fix","build","chore"];function checkConventionalMessage(message){const pattern=message.match(titlePattern)?.groups||{};const{type,scope,breaking,subject}=pattern;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}}async function main(messageFilePath){console.log("Verifying the commit message...");const message=(await fs.readFile(messageFilePath,"utf-8")).trim();console.log("  input =",message);const{errors}=checkConventionalMessage(message);for(const error of errors){console.error("  error =",error)}process.exitCode=errors.length}
+const require_src = require("./src.js");
+let node_fs_promises = require("node:fs/promises");
+node_fs_promises = require_src.__toESM(node_fs_promises);
+//#region src/lint-commit-message.ts
+(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_src.checkConventionalMessage(message);
+	for (const error of errors) console.error("  error =", error);
+	process.exitCode = errors.length;
+})();
+//#endregion

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

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