@thisismanta/semantic-version 8.0.1 → 9.1.0

package/bin/auto-npm-version

@@ -1,2 +1,2 @@
 #!/usr/bin/env node
-require('../lib/auto-npm-version')
+require('../lib/auto-npm-version').default()

package/bin/lint-commit-message

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

package/lib/auto-npm-version.d.ts

@@ -1 +1,9 @@
+export default function main(): Promise<void>;
+interface GitCommit {
+    hash: string;
+    type: string | undefined;
+    breaking: boolean;
+    subject: string;
+}
+export declare function getReleaseType(commits: Array<GitCommit>): string | null;
 export {};

package/lib/auto-npm-version.js

@@ -26,86 +26,106 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const semver_1 = __importDefault(require("semver"));
+exports.default = main;
+exports.getReleaseType = getReleaseType;
+const valid_1 = __importDefault(require("semver/functions/valid"));
 const github = __importStar(require("@actions/github"));
 const index_1 = require("./index");
 const run_1 = require("./run");
-const debug_1 = require("./debug");
-main();
 async function main() {
-    (0, debug_1.debug)('process.env.GITHUB_TOKEN »', process.env.GITHUB_TOKEN);
-    if (!process.env.GITHUB_TOKEN) {
-        throw new Error('Expected "GITHUB_TOKEN" env to be provided.');
-    }
-    // Set up Git commit author for further use in "npm version" and "git push" command
     // See https://github.com/actions/checkout#push-a-commit-using-the-built-in-token
-    if (!(await (0, run_1.run)(`git config user.name`).catch(() => ''))) {
-        await (0, run_1.run)(`git config user.name ${github.context.payload.pusher?.name || github.context.actor}`);
-        await (0, run_1.run)(`git config user.email ${github.context.payload.pusher?.email || 'github-actions@github.com'}`);
+    const existingGitUserName = await (0, run_1.run)(`git config user.name`).catch(() => '');
+    if (!existingGitUserName) {
+        console.log('Setting Git commit author for further use in `npm version` and `git push` command...');
+        const name = github.context.payload.pusher?.name || github.context.actor;
+        console.log('  user.name =', name);
+        await (0, run_1.run)(`git config user.name ${name}`);
+        const email = github.context.payload.pusher?.email || 'github-actions@github.com';
+        console.log('  user.email =', name);
+        await (0, run_1.run)(`git config user.email ${email}`);
     }
+    console.log('Getting the remote repository...');
     const remote = await (0, run_1.run)(`git remote`) || 'origin';
-    // Check if the given GITHUB_TOKEN has the permission to push to the repository
+    console.log('  remote =', remote);
+    if (!process.env.GITHUB_TOKEN) {
+        throw new Error('Expected "GITHUB_TOKEN" to be set in the environment variables.');
+    }
     // See https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#configuring-the-default-github_token-permissions
+    console.log('Checking if the current setup has the permission to push to the remote repository...');
     await (0, run_1.run)(`git push --dry-run ${remote}`);
-    const lastVersion = await getLastVersion();
-    (0, debug_1.debug)('lastVersion »', JSON.stringify(lastVersion));
-    if (!lastVersion) {
+    console.log('  OK');
+    console.log('Getting the current package version...');
+    const currentVersion = await getCurrentPackageVersion();
+    console.log('  version =', currentVersion ?? JSON.stringify(currentVersion));
+    if (!currentVersion) {
         throw new Error('Expected "version" field to exist in package.json.');
     }
-    const commits = getCommits(await getGitHistory(lastVersion));
-    console.log(`Found ${commits.length} qualified commit${commits.length === 1 ? '' : 's'} since v${lastVersion}`);
-    (0, debug_1.debug)('commits »', JSON.stringify(commits, null, 2));
+    console.log('Getting the commit history since the current version...');
+    const commits = await getGitHistory(currentVersion);
+    if (commits.length === 0) {
+        console.log('  Found 0 commits.');
+    }
+    else {
+        for (const commit of commits) {
+            console.log(`  - ${commit.type}${commit.breaking ? '!' : ''}: ${commit.subject} (${commit.hash.substring(0, 7)})`);
+        }
+    }
+    console.log('Determining the upcoming release type...');
     const releaseType = getReleaseType(commits);
-    (0, debug_1.debug)('releaseType »', JSON.stringify(releaseType));
+    console.log('  ' + JSON.stringify(releaseType));
     if (!releaseType) {
-        console.log('Done without a new version');
+        console.log('');
+        console.log('Done without a new version.');
         return;
     }
-    await (0, run_1.run)(`npm version --git-tag-version ${releaseType}`);
+    console.log('Running `npm version` command and its pre-post scripts...');
+    await (0, run_1.run)(`npm version ${releaseType} --git-tag-version --no-commit-hooks`);
+    console.log('  OK');
+    console.log('Pushing the new version to the remote repository...');
     await (0, run_1.run)(`git push --follow-tags ${remote}`);
-    const nextVersion = await getLastVersion();
-    (0, debug_1.debug)('nextVersion »', JSON.stringify(nextVersion));
-    console.log(`Created tag v${nextVersion}`);
-    if (!nextVersion) {
-        throw new Error(`Expected "${nextVersion}" returned from "npm version" to be a valid semantic version.`);
-    }
+    console.log('  OK');
+    console.log('Verifying the new version...');
+    const latestVersion = await getCurrentPackageVersion();
+    console.log('  version =', latestVersion ?? JSON.stringify(latestVersion));
+    console.log('Creating a release note on GitHub...');
     const releaseNote = getReleaseNote(commits);
-    (0, debug_1.debug)('releaseNote »', releaseNote);
-    const octokit = github.getOctokit(process.env.GITHUB_TOKEN);
     // See https://octokit.github.io/rest.js/v19#repos-create-release
+    const octokit = github.getOctokit(process.env.GITHUB_TOKEN);
     const releaseCreationRespond = await octokit.rest.repos.createRelease({
         ...github.context.repo,
-        tag_name: 'v' + nextVersion,
+        tag_name: 'v' + latestVersion,
         body: releaseNote,
         make_latest: 'legacy',
     });
-    (0, debug_1.debug)('releaseCreationRespond »', JSON.stringify(releaseCreationRespond, null, 2));
-    console.log('Done with a new release at', releaseCreationRespond.data.html_url);
+    console.log('  ' + releaseCreationRespond.data.html_url);
+    console.log('');
+    console.log('Done with the new version.');
 }
-async function getLastVersion() {
-    const versionFromGit = await (0, run_1.run)('git describe --tags --abbrev=0').catch(() => null);
-    const versionFromPackageJSON = JSON.parse(await (0, run_1.run)('npm pkg get version'));
-    const versions = [versionFromGit, versionFromPackageJSON]
-        .map(version => semver_1.default.valid(version))
-        .filter((version) => !!version);
-    // Choose the higher version
-    return semver_1.default.sort(versions).pop();
+async function getCurrentPackageVersion() {
+    const version = JSON.parse(await (0, run_1.run)('npm pkg get version'));
+    if (typeof version === 'string' && (0, valid_1.default)(version)) {
+        return version;
+    }
+    else {
+        throw new Error('Expected a valid version field in package.json.');
+    }
 }
 async function getGitHistory(version) {
-    const tagFound = !!(await (0, run_1.run)(`git tag --list v${version}`));
-    return await (0, run_1.run)(`git --no-pager log ${tagFound ? `v${version}..HEAD` : ''} --format=%H%s`);
+    const tag = (await (0, run_1.run)(`git tag --list v${version}`) ||
+        await (0, run_1.run)('git describe --tags --abbrev=0'));
+    return getCommits(await (0, run_1.run)(`git --no-pager log ${tag ? tag + '..HEAD' : ''} --format=%H%s`));
 }
-function getCommits(gitLog) {
-    return gitLog
+function getCommits(gitLogs) {
+    return gitLogs
         .split('\n')
         .filter(line => line.length > 0)
         .map(line => ({
         hash: line.substring(0, 40),
         message: line.substring(40),
     }))
-        .filter(({ message }) => semver_1.default.valid(message) === null)
+        .filter(({ message }) => (0, valid_1.default)(message) === null)
         .map(({ hash, message }) => {
-        const { type, breaking, subject } = (0, index_1.checkConventionalMessage)(message, { debug: () => { } });
+        const { type, breaking, subject } = (0, index_1.checkConventionalMessage)(message);
         return { hash, type, breaking, subject };
     });
 }

package/lib/index.d.ts

@@ -1,6 +1,6 @@
 export declare const allowedTypes: readonly ["feat", "fix", "build", "chore"];
 export type SemanticType = typeof allowedTypes[number];
-export declare function checkConventionalMessage(message: string, { debug }: Pick<Console, 'debug'>): {
+export declare function checkConventionalMessage(message: string): {
     type: "feat" | "fix" | "build" | "chore" | undefined;
     breaking: boolean;
     subject: string;

package/lib/index.js

@@ -1,15 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkConventionalMessage = exports.allowedTypes = void 0;
+exports.allowedTypes = void 0;
+exports.checkConventionalMessage = checkConventionalMessage;
 const titlePattern = /^(?<type>\w+)(?<scope>\(.*?\))?(?<breaking>\!)?:(?<subject>.+)/;
 exports.allowedTypes = ['feat', 'fix', 'build', 'chore'];
-function checkConventionalMessage(message, { debug }) {
+function checkConventionalMessage(message) {
     const pattern = (message.match(titlePattern)?.groups || {});
     const { type, scope, breaking, subject } = pattern;
-    debug('type »', type);
-    debug('scope »', scope);
-    debug('breaking »', breaking);
-    debug('subject »', subject?.trim());
     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/',
@@ -37,4 +34,3 @@ function checkConventionalMessage(message, { debug }) {
         errors
     };
 }
-exports.checkConventionalMessage = checkConventionalMessage;

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

@@ -1 +1 @@
-export {};
+export default function main(messageFilePath: string): Promise<void>;

package/lib/lint-commit-message.js

@@ -23,20 +23,16 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = main;
 const fs = __importStar(require("fs/promises"));
 const index_1 = require("./index");
-const debug_1 = require("./debug");
-main();
-async function main() {
-    const [messageFilePath] = process.argv.slice(2);
-    (0, debug_1.debug)('messageFilePath »', messageFilePath);
+async function main(messageFilePath) {
+    console.log('Verifying the commit message...');
     const message = (await fs.readFile(messageFilePath, 'utf-8')).trim();
-    (0, debug_1.debug)('message »', message);
-    const { errors } = (0, index_1.checkConventionalMessage)(message, { debug: debug_1.debug });
-    if (errors.length > 0) {
-        for (const error of errors) {
-            console.error(error);
-        }
-        process.exit(1);
+    console.log('  input =', message);
+    const { errors } = (0, index_1.checkConventionalMessage)(message);
+    for (const error of errors) {
+        console.error('  error =', error);
     }
+    process.exitCode = errors.length;
 }

package/lib/run.js

@@ -23,22 +23,22 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.run = void 0;
+exports.run = run;
 const cp = __importStar(require("child_process"));
-const debug_1 = require("./debug");
 function run(command) {
-    (0, debug_1.debug)(command);
     return new Promise((resolve, reject) => {
         cp.exec(command, (error, stdout, stderr) => {
             if (error) {
+                // See https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#grouping-log-lines
+                console.log('::group::' + command);
+                console.log(stdout);
+                console.error(stderr);
+                console.log('::endgroup::');
                 reject(error);
             }
             else {
-                const output = (stdout + stderr).trim();
-                (0, debug_1.debug)(output);
-                resolve(output);
+                resolve((stdout + stderr).trim());
             }
         });
     });
 }
-exports.run = run;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thisismanta/semantic-version",
-	"version": "8.0.1",
+	"version": "9.1.0",
 	"author": "Anantachai Saothong <thisismanta@gmail.com>",
 	"license": "ISC",
 	"repository": {
@@ -21,27 +21,20 @@
 		"./bin"
 	],
 	"scripts": {
-		"test": "jest",
+		"test": "vitest --no-watch",
 		"build": "rm -rf lib && tsc",
 		"preversion": "npm run build",
 		"version": "npm publish --access public"
 	},
 	"devDependencies": {
-		"@types/jest": "^29.5.12",
 		"@types/node": "^20.0.0",
-		"@types/semver": "^7.5.7",
-		"jest": "^29.7.0",
-		"lefthook": "^1.6.1",
-		"ts-jest": "^29.1.2",
-		"ts-node": "^10.9.2",
-		"typescript": "^5.3.3"
+		"@types/semver": "^7.5.8",
+		"lefthook": "^1.7.14",
+		"typescript": "^5.5.4",
+		"vitest": "^2.0.5"
 	},
 	"dependencies": {
 		"@actions/github": "^6.0.0",
-		"semver": "^7.6.0"
-	},
-	"jest": {
-		"preset": "ts-jest",
-		"resetMocks": true
+		"semver": "^7.6.3"
 	}
 }

package/lib/debug.d.ts

@@ -1 +0,0 @@
-export declare function debug(...args: Array<any>): void;

package/lib/debug.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.debug = void 0;
-function debug(...args) {
-    if (process.env.DEBUG || process.env.RUNNER_DEBUG /* For GitHub Actions */) {
-        console.log(...args);
-    }
-}
-exports.debug = debug;