@thisismanta/semantic-version 1.0.0

package/README.md

@@ -0,0 +1,20 @@
+Once installed, this package verifies your upcoming **Git commit messages** against the convention and automatically runs `npm version` after a commit if needed.
+
+## Git commit message convention
+
+```
+<type>[!]: <subject>
+```
+Where
+- `<type>` can be either `feat`, `fix`, `test`, `refactor` or `chore`.
+- `!` indicates that the commit contains breaking changes.
+- `<subject>` is the actual commit message where the first word must be written in lower cases.
+
+## Versioning
+
+|Commit message type|Post-commit command|
+|---|---|
+|`!`|`npm version major`|
+|`feat`|`npm version minor`|
+|`fix`|`npm version patch`|
+|Others|Does not run `npm version`|

package/bin/auto-npm-version

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

package/bin/lint-commit-message

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

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

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

package/lib/auto-npm-version.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const execa_1 = require("execa");
+const index_1 = require("./index");
+main();
+async function main() {
+    const message = await run('git log -1 HEAD --format=%s');
+    console.log('message »', message);
+    const { type, breaking } = (0, index_1.checkConventionalMessage)(message, console);
+    const releaseType = (() => {
+        if (breaking) {
+            return 'major';
+        }
+        else if (type === 'feat') {
+            return 'minor';
+        }
+        else if (type === 'fix') {
+            return 'patch';
+        }
+        // Indicate no version bump
+        return '';
+    })();
+    console.log('releaseType »', releaseType);
+    if (!releaseType) {
+        return;
+    }
+    const newVersion = await run(`npm version --json --no-commit-hooks ${releaseType}`);
+    await run(`git push origin refs/tags/${newVersion}`);
+}
+async function run(command) {
+    console.log(command);
+    const { stdout } = await (0, execa_1.execaCommand)(command);
+    console.log(stdout);
+    return stdout;
+}

package/lib/index.d.ts

@@ -0,0 +1,7 @@
+export declare const allowedTypes: string[];
+export declare function checkConventionalMessage(message: string, { debug }: Pick<Console, 'debug'>): {
+    type: string | undefined;
+    breaking: boolean;
+    subject: string | undefined;
+    errors: string[];
+};

package/lib/index.js

@@ -0,0 +1,33 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkConventionalMessage = exports.allowedTypes = void 0;
+const titlePattern = /^(?<type>\w+)(?<scope>\(.*?\))?(?<breaking>\!)?:(?<subject>.+)/;
+exports.allowedTypes = ['feat', 'fix', 'test', 'refactor', 'chore'];
+function checkConventionalMessage(message, { debug }) {
+    const pattern = (message.match(titlePattern)?.groups || {});
+    debug(JSON.stringify(pattern, null, 2));
+    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' && exports.allowedTypes.includes(type.toLowerCase()) === false &&
+            'The type in a pull request title must be one of ' + exports.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.',
+    ].filter((error) => typeof error === 'string');
+    return {
+        type,
+        breaking: !!breaking,
+        subject: typeof subject === 'string' ? subject.trim() : subject,
+        errors
+    };
+}
+exports.checkConventionalMessage = checkConventionalMessage;

package/lib/index.test.d.ts

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

package/lib/index.test.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const debug = jest.fn();
+it('does not return any error, given a valid pattern', () => {
+    for (const type of index_1.allowedTypes) {
+        expect((0, index_1.checkConventionalMessage)(type + ': xxx', { debug })).toEqual({
+            type: type,
+            breaking: false,
+            subject: 'xxx',
+            errors: []
+        });
+    }
+    expect((0, index_1.checkConventionalMessage)('chore!: xxx', { debug })).toEqual({
+        type: 'chore',
+        breaking: true,
+        subject: 'xxx',
+        errors: []
+    });
+});
+it('returns the error, given an invalid pattern', () => {
+    expect((0, index_1.checkConventionalMessage)('xxx', { debug })).toMatchObject({
+        errors: [
+            '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/'
+        ]
+    });
+});
+it('returns the error, given an unknown type', () => {
+    expect((0, index_1.checkConventionalMessage)('unknown: xxx', { debug })).toMatchObject({
+        type: 'unknown',
+        errors: [
+            'The type in a pull request title must be one of \"feat\", \"fix\", \"test\", \"refactor\", \"chore\".'
+        ]
+    });
+});
+it('returns the error, given a non-lower-case type', () => {
+    expect((0, index_1.checkConventionalMessage)('CHORE: xxx', { debug })).toMatchObject({
+        errors: [
+            'The type in a pull request title must be in lower case only.'
+        ]
+    });
+});
+it('returns the error, given a scope', () => {
+    expect((0, index_1.checkConventionalMessage)('chore(scope): xxx', { debug })).toMatchObject({
+        errors: [
+            'A scope in a pull request title is never allowed.'
+        ]
+    });
+});
+it('returns the error, given zero or more-than-one spaces after ":" symbol', () => {
+    expect((0, index_1.checkConventionalMessage)('chore:xxx', { debug })).toMatchObject({
+        subject: 'xxx',
+        errors: [
+            'A single space must be after ":" symbol.'
+        ]
+    });
+    expect((0, index_1.checkConventionalMessage)('chore:  xxx', { debug })).toMatchObject({
+        subject: 'xxx',
+        errors: [
+            'A single space must be after ":" symbol.'
+        ]
+    });
+});
+it('returns the error, given the first word in non-lower-case for the subject', () => {
+    expect((0, index_1.checkConventionalMessage)('chore: Xxx', { debug })).toMatchObject({
+        errors: [
+            'The subject must start with a lower case latin alphabet.'
+        ]
+    });
+});

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

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

package/lib/install-git-hooks.js

@@ -0,0 +1,51 @@
+"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"));
+main();
+async function main() {
+    const huskyDirectoryPath = fp.resolve(process.cwd(), '.husky');
+    await upsert(fp.join(huskyDirectoryPath, 'commit-msg'), 'npx lint-commit-message ${1}');
+    await upsert(fp.join(huskyDirectoryPath, 'post-commit'), 'npx auto-npm-version');
+}
+async function upsert(filePath, text) {
+    try {
+        await fs.access(filePath);
+    }
+    catch (error) {
+        console.log('Created', filePath);
+        await fs.writeFile(filePath, '#!/usr/bin/env sh' + '\n' +
+            '. "$(dirname -- "$0")/_/husky.sh"' + '\n', 'utf-8');
+    }
+    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);
+    }
+}

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

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

package/lib/lint-commit-message.js

@@ -0,0 +1,36 @@
+"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 index_1 = require("./index");
+main();
+async function main() {
+    const [messageFilePath] = process.argv.slice(2);
+    const message = (await fs.readFile(messageFilePath, 'utf-8')).trim();
+    const { errors } = (0, index_1.checkConventionalMessage)(message, console);
+    if (errors.length > 0) {
+        throw new Error(errors[0]);
+    }
+}

package/package.json

@@ -0,0 +1,43 @@
+{
+	"name": "@thisismanta/semantic-version",
+	"version": "1.0.0",
+	"author": "Anantachai Saothong <thisismanta@gmail.com>",
+	"license": "ISC",
+	"engines": {
+		"node": ">=16.0.0"
+	},
+	"main": "./lib/index.js",
+	"types": "./lib/index.d.ts",
+	"bin": {
+		"lint-commit-message": "./bin/lint-commit-message",
+		"auto-npm-version": "./bin/auto-npm-version"
+	},
+	"files": [
+		"./lib",
+		"./bin"
+	],
+	"scripts": {
+		"test": "jest",
+		"build": "tsc",
+		"preversion": "npm run test && npm run build && git add lib/*",
+		"version": "npm publish --access public",
+		"postversion": "git push --tags origin master",
+		"postinstall": "husky install && node ./lib/install-git-hooks.js",
+		"prepare": "husky uninstall && rm -rf .husky"
+	},
+	"devDependencies": {
+		"@types/jest": "^29.4.0",
+		"@types/node": "^16.0.0",
+		"jest": "^29.4.3",
+		"ts-jest": "^29.0.5",
+		"typescript": "^4.9.5"
+	},
+	"dependencies": {
+		"execa": "npm:@esm2cjs/execa@^6.1.1-cjs.1",
+		"husky": "^8.0.3"
+	},
+	"jest": {
+		"preset": "ts-jest",
+		"resetMocks": true
+	}
+}