@thisismanta/semantic-version 7.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

@@ -83,8 +83,13 @@ async function main() {
     console.log('Done with a new release at', releaseCreationRespond.data.html_url);
 }
 async function getLastVersion() {
-    return (semver_1.default.valid(await (0, run_1.run)('git describe --tags --abbrev=0').catch(() => '')) ||
-        semver_1.default.valid(JSON.parse(await (0, run_1.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 (0, run_1.run)(`git tag --list v${version}`));
@@ -105,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/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thisismanta/semantic-version",
-	"version": "7.0.0",
+	"version": "8.0.0",
 	"author": "Anantachai Saothong <thisismanta@gmail.com>",
 	"license": "ISC",
 	"repository": {
@@ -24,15 +24,14 @@
 		"test": "jest",
 		"build": "rm -rf lib && tsc",
 		"preversion": "npm run build",
-		"version": "npm publish --access public",
-		"postinstall": "node ./lib/install-git-hooks.js"
+		"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.0",
+		"lefthook": "^1.6.1",
 		"ts-jest": "^29.1.1",
 		"ts-node": "^10.9.2",
 		"typescript": "^5.3.3"

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

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

package/lib/install-git-hooks.js

@@ -1,68 +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 run_1 = require("./run");
-const debug_1 = require("./debug");
-main();
-const packageName = require('../package.json').name;
-async function main() {
-    const rootDirectoryPath = await (0, run_1.run)('git rev-parse --show-toplevel');
-    (0, debug_1.debug)('rootDirectoryPath »', rootDirectoryPath);
-    if (!rootDirectoryPath) {
-        throw new Error('Could not find a Git directory.');
-    }
-    const packageJSON = JSON.parse(await fs.readFile(fp.join(rootDirectoryPath, '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;
-    }
-    const hookDirectoryPath = await (0, run_1.run)('git config --get core.hooksPath').catch(() => '') || '.git/hooks';
-    const hookFilePath = fp.join(rootDirectoryPath, hookDirectoryPath, 'commit-msg');
-    (0, debug_1.debug)('hookFilePath »', hookFilePath);
-    try {
-        await fs.access(hookFilePath, fs.constants.R_OK | fs.constants.W_OK);
-        (0, debug_1.debug)('Found', hookFilePath);
-    }
-    catch {
-        await fs.mkdir(fp.dirname(hookFilePath), { recursive: true });
-        await fs.writeFile(hookFilePath, '#!/bin/sh\n', 'utf-8');
-        (0, debug_1.debug)('Created', hookFilePath);
-    }
-    const hookFileText = await fs.readFile(hookFilePath, 'utf-8');
-    if (/(^|\s|\/)lint-commit-message(\s|$)/m.test(hookFileText)) {
-        console.log('Skipped adding commit-msg Git hook.');
-    }
-    else {
-        await fs.appendFile(hookFilePath, [
-            '',
-            'dir="$(git rev-parse --show-toplevel)"',
-            '"$dir/node_modules/.bin/lint-commit-message" "$@"',
-            '',
-        ].join('\n'), 'utf-8');
-        console.log('Done adding commit-msg Git hook.');
-    }
-}