@thisismanta/semantic-version 6.0.0 → 8.0.0

package/README.md

@@ -1,4 +1,6 @@
-Once installed, this package verifies your upcoming **Git commit messages** against the convention below.
+# `npx lint-commit-message <path>`
+
+The `<path>` must point to a text file containing commit message that complies with the following pattern:
 
 ```
 <type>[!]: <subject>
@@ -8,9 +10,18 @@ Where
 - `!` indicates that the commit contains breaking changes.
 - `<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`
 
-Additionally, you can run `npx auto-npm-version` on **GitHub Actions** to trigger `npm version` based on your commit messages and create a GitHub release (optional).
+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|
 |---|---|
@@ -19,25 +30,24 @@ Additionally, you can run `npx auto-npm-version` on **GitHub Actions** to trigge
 |`fix`|`npm version patch`|
 |Others|Does not run `npm version`|
 
-Here's an example of **GitHub Actions** workflow file:
-
-```yml
-on:
-  push:
-    branches: [master]
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0 # Ensure Git tags are fetched
-      - uses: actions/setup-node@v3
-        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 **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
+> ```

package/lib/auto-npm-version.js

@@ -27,9 +27,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const semver_1 = __importDefault(require("semver"));
-const execa_1 = require("execa");
 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() {
@@ -39,14 +39,14 @@ async function main() {
     }
     // 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 run(`git config user.name`).catch(() => ''))) {
-        await run(`git config user.name ${github.context.payload.pusher?.name || github.context.actor}`);
-        await run(`git config user.email ${github.context.payload.pusher?.email || 'github-actions@github.com'}`);
+    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 remote = await run(`git remote`) || 'origin';
+    const remote = await (0, run_1.run)(`git remote`) || 'origin';
     // Check if the given GITHUB_TOKEN has the permission to push to the repository
     // 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
-    await run(`git push --dry-run ${remote}`);
+    await (0, run_1.run)(`git push --dry-run ${remote}`);
     const lastVersion = await getLastVersion();
     (0, debug_1.debug)('lastVersion »', JSON.stringify(lastVersion));
     if (!lastVersion) {
@@ -61,8 +61,8 @@ async function main() {
         console.log('Done without a new version');
         return;
     }
-    await run(`npm version --git-tag-version ${releaseType}`);
-    await run(`git push --follow-tags ${remote}`);
+    await (0, run_1.run)(`npm version --git-tag-version ${releaseType}`);
+    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}`);
@@ -82,19 +82,18 @@ async function main() {
     (0, debug_1.debug)('releaseCreationRespond »', JSON.stringify(releaseCreationRespond, null, 2));
     console.log('Done with a new release at', releaseCreationRespond.data.html_url);
 }
-async function run(command) {
-    (0, debug_1.debug)(command);
-    const { stdout } = await (0, execa_1.execaCommand)(command);
-    (0, debug_1.debug)(stdout);
-    return stdout;
-}
 async function getLastVersion() {
-    return (semver_1.default.valid(await run('git describe --tags --abbrev=0').catch(() => '')) ||
-        semver_1.default.valid(JSON.parse(await run('npm pkg get version'))));
+    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 getGitHistory(version) {
-    const tagFound = !!(await run(`git tag --list v${version}`));
-    return await run(`git --no-pager log ${tagFound ? `v${version}..HEAD` : ''} --format=%H%s`);
+    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`);
 }
 function getCommits(gitLog) {
     return gitLog
@@ -111,10 +110,16 @@ function getCommits(gitLog) {
     });
 }
 function getReleaseType(commits) {
-    return (commits.find(({ breaking }) => breaking) && 'major' ||
-        commits.find(({ type }) => type === 'feat') && 'minor' ||
-        commits.find(({ type }) => type === 'fix' || type === 'build') && 'patch' ||
-        null);
+    if (commits.find(({ breaking }) => breaking)) {
+        return 'major';
+    }
+    if (commits.find(({ type }) => type === 'feat')) {
+        return 'minor';
+    }
+    if (commits.find(({ type }) => type === 'fix' || type === 'build')) {
+        return 'patch';
+    }
+    return null;
 }
 function getReleaseNote(commits) {
     const groups = {

package/lib/run.d.ts

@@ -0,0 +1 @@
+export declare function run(command: string): Promise<string>;

package/lib/run.js

@@ -0,0 +1,44 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.run = void 0;
+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) {
+                reject(error);
+            }
+            else {
+                const output = (stdout + stderr).trim();
+                (0, debug_1.debug)(output);
+                resolve(output);
+            }
+        });
+    });
+}
+exports.run = run;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thisismanta/semantic-version",
-	"version": "6.0.0",
+	"version": "8.0.0",
 	"author": "Anantachai Saothong <thisismanta@gmail.com>",
 	"license": "ISC",
 	"repository": {
@@ -24,23 +24,20 @@
 		"test": "jest",
 		"build": "rm -rf lib && tsc",
 		"preversion": "npm run build",
-		"version": "npm publish --access public",
-		"postinstall": "node ./lib/install-git-hooks.js",
-		"prepare": "husky install"
+		"version": "npm publish --access public"
 	},
 	"devDependencies": {
 		"@types/jest": "^29.5.11",
 		"@types/node": "^20.0.0",
 		"@types/semver": "^7.5.6",
 		"jest": "^29.7.0",
+		"lefthook": "^1.6.1",
 		"ts-jest": "^29.1.1",
 		"ts-node": "^10.9.2",
 		"typescript": "^5.3.3"
 	},
 	"dependencies": {
 		"@actions/github": "^6.0.0",
-		"execa": "npm:@esm2cjs/execa@^6.1.1-cjs.1",
-		"husky": "^8.0.3",
 		"semver": "^7.5.4"
 	},
 	"jest": {

package/lib/install-git-hooks.d.ts

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

package/lib/install-git-hooks.js

@@ -1,89 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const fs = __importStar(require("fs/promises"));
-const fp = __importStar(require("path"));
-const execa_1 = require("execa");
-const debug_1 = require("./debug");
-main();
-const packageName = require('../package.json').name;
-async function main() {
-    const currentDirectoryPath = process.cwd();
-    (0, debug_1.debug)('currentDirectoryPath »', currentDirectoryPath);
-    const gitDirectoryPath = await findGitDirectoryPath(currentDirectoryPath);
-    (0, debug_1.debug)('gitDirectoryPath »', gitDirectoryPath);
-    if (!gitDirectoryPath) {
-        throw new Error('Could not find a Git directory.');
-    }
-    const packageJSON = JSON.parse(await fs.readFile(fp.join(gitDirectoryPath, 'package.json'), 'utf-8'));
-    if (packageJSON.name === packageName) {
-        console.warn('Skip installing Git hooks as it is supposed to be done on a consumer repository.');
-        return;
-    }
-    console.log('Installing Husky');
-    await (0, execa_1.execaCommand)('npx husky install', { cwd: gitDirectoryPath });
-    const huskyDirectoryPath = fp.resolve(gitDirectoryPath, '.husky');
-    (0, debug_1.debug)('huskyDirectoryPath »', huskyDirectoryPath);
-    await fs.access(huskyDirectoryPath);
-    await upsert(fp.join(huskyDirectoryPath, 'commit-msg'), 'npx lint-commit-message ${1}');
-    console.log('Done adding Git hooks.');
-}
-async function findGitDirectoryPath(path) {
-    const pathList = path.split(fp.sep);
-    while (pathList.length > 1) {
-        const testPath = fp.join(pathList.join(fp.sep), '.git');
-        try {
-            await fs.access(testPath);
-            const stat = await fs.lstat(testPath);
-            if (stat.isDirectory()) {
-                return pathList.join(fp.sep);
-            }
-        }
-        catch {
-            // Do nothing
-        }
-        pathList.pop();
-    }
-    return null;
-}
-async function upsert(filePath, text) {
-    try {
-        await fs.access(filePath);
-        console.log('Found', filePath);
-    }
-    catch (error) {
-        await fs.writeFile(filePath, '#!/usr/bin/env sh' + '\n' +
-            '. "$(dirname -- "$0")/_/husky.sh"' + '\n', 'utf-8');
-        console.log('Created', filePath);
-    }
-    const fileText = await fs.readFile(filePath, 'utf-8');
-    const lines = fileText.trim().split('\n');
-    const index = lines
-        .findIndex(line => line.trim().includes(text));
-    if (index === -1) {
-        await fs.appendFile(filePath, '\n' + text + '\n', 'utf-8');
-        console.log(`Added "${text}" to ${filePath}`);
-    }
-}