@thisismanta/semantic-version 1.0.4 → 2.0.0-0

package/lib/auto-npm-version.js

@@ -1,35 +1,123 @@
 "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;
+};
+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"));
 const execa_1 = require("execa");
+const github = __importStar(require("@actions/github"));
 const index_1 = require("./index");
+const debug_1 = require("./debug");
 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) {
+    const lastVersion = semver_1.default.valid(await run('git describe --tags --abbrev=0') ||
+        await run('npm pkg get version'));
+    (0, debug_1.debug)('lastVersion »', JSON.stringify(lastVersion));
+    if (!lastVersion) {
+        throw new Error('Expect to have a last version on Git tag or package.json `version` field.');
+    }
+    const commits = (await run(`git log v${lastVersion}..HEAD --format="%H %s"`))
+        .trim()
+        .split('\n')
+        .map(line => {
+        const hash = line.substring(0, line.indexOf(' '));
+        const message = line.substring(line.indexOf(' ') + 1);
+        const { type, breaking, subject } = (0, index_1.checkConventionalMessage)(message, { debug: debug_1.debug });
+        return {
+            hash,
+            type,
+            breaking,
+            subject,
+        };
+    });
+    console.log(`Found ${commits.length} commits since ${lastVersion}`);
+    (0, debug_1.debug)('commits »', JSON.stringify(commits, null, 2));
+    const releaseType = commits.reduce((releaseType, { type, breaking }) => {
+        if (releaseType === 'major' || breaking) {
             return 'major';
         }
-        else if (type === 'feat') {
-            return 'minor';
+        if (releaseType === 'minor' || type === 'feat') {
+            return releaseType;
         }
-        else if (type === 'fix') {
+        if (type === 'fix') {
             return 'patch';
         }
-        // Indicate no version bump
-        return '';
-    })();
-    console.log('releaseType »', releaseType);
+        return releaseType;
+    }, null);
+    (0, debug_1.debug)('releaseType »', JSON.stringify(releaseType));
     if (!releaseType) {
+        console.log('Exited without releasing a new version');
         return;
     }
-    const newVersion = await run(`npm version --json --no-commit-hooks ${releaseType}`);
-    await run(`git push origin refs/tags/${newVersion}`);
+    const nextVersion = await run(`npm version --json --no-commit-hooks ${releaseType}`);
+    (0, debug_1.debug)('nextVersion »', nextVersion);
+    console.log(`Created version ${releaseType}`);
+    await run(`git push --follow-tags origin master`);
+    console.log(`Pushed Git tags`);
+    if (semver_1.default.valid(nextVersion) && process.env.GITHUB_TOKEN) {
+        const commitGroups = {
+            'BREAKING CHANGES': [],
+            'Features': [],
+            'Bug Fixes': [],
+            'Others': [],
+        };
+        for (const commit of commits) {
+            if (commit.breaking) {
+                commitGroups['BREAKING CHANGES'].push(commit);
+            }
+            else if (commit.type === 'feat') {
+                commitGroups['Features'].push(commit);
+            }
+            else if (commit.type === 'bug') {
+                commitGroups['Bug Fixes'].push(commit);
+            }
+            else {
+                commitGroups['Others'].push(commit);
+            }
+        }
+        const releaseNote = Object.entries(commitGroups)
+            .filter(([title, commits]) => commits.length > 0)
+            .map(([title, commits]) => `### ${title}\n\n` +
+            commits.map(({ subject, hash }) => `- ${subject} (${hash})`).join('\n'))
+            .join('\n\n');
+        (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 octokitRespond = await octokit.rest.repos.createRelease({
+            ...github.context.repo,
+            tag_name: nextVersion,
+            body: releaseNote,
+        });
+        (0, debug_1.debug)('octokitRespond »', JSON.stringify(octokitRespond, null, 2));
+        console.log('Created a new release on GitHub');
+    }
 }
 async function run(command) {
-    console.log(command);
+    (0, debug_1.debug)(command);
     const { stdout } = await (0, execa_1.execaCommand)(command);
-    console.log(stdout);
+    (0, debug_1.debug)(stdout);
     return stdout;
 }

package/lib/debug.d.ts

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

package/lib/debug.js

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

package/lib/index.d.ts

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

package/lib/index.js

@@ -5,8 +5,11 @@ 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;
+    debug('type »', type);
+    debug('scope »', scope);
+    debug('breaking »', breaking);
+    debug('subject »', subject);
     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/',
@@ -22,11 +25,15 @@ function checkConventionalMessage(message, { debug }) {
             '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,
         breaking: !!breaking,
-        subject: typeof subject === 'string' ? subject.trim() : subject,
+        subject: typeof subject === 'string'
+            ? subject.trim().replace(/[\s\.]+$/, '') + (/\.{3}$/.test(subject.trim()) ? '...' : '')
+            : message,
         errors
     };
 }

package/lib/index.test.js

@@ -68,3 +68,17 @@ it('returns the error, given the first word in non-lower-case for the subject',
         ]
     });
 });
+it('returns the error, given a period after the subject', () => {
+    expect((0, index_1.checkConventionalMessage)('chore: xxx.', { debug })).toMatchObject({
+        subject: 'xxx',
+        errors: [
+            'The subject must not end with a period or a space.'
+        ]
+    });
+    expect((0, index_1.checkConventionalMessage)('chore: xxx ...', { debug })).toEqual({
+        type: 'chore',
+        breaking: false,
+        subject: 'xxx...',
+        errors: []
+    });
+});

package/lib/install-git-hooks.js

@@ -26,28 +26,28 @@ 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();
-    console.debug('currentDirectoryPath »', currentDirectoryPath);
+    (0, debug_1.debug)('currentDirectoryPath »', currentDirectoryPath);
     const gitDirectoryPath = await findGitDirectoryPath(currentDirectoryPath);
-    console.debug('gitDirectoryPath »', gitDirectoryPath);
+    (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 === '@thisismanta/semantic-version') {
+    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 });
-    // Up 3 levels because of `node_modules/@thisismanta/semantic-version`
-    const huskyDirectoryPath = fp.resolve(currentDirectoryPath, '../../..', '.husky');
+    const huskyDirectoryPath = fp.resolve(gitDirectoryPath, '.husky');
+    (0, debug_1.debug)('huskyDirectoryPath »', huskyDirectoryPath);
     await fs.access(huskyDirectoryPath);
-    console.log('Found', huskyDirectoryPath);
     await upsert(fp.join(huskyDirectoryPath, 'commit-msg'), 'npx lint-commit-message ${1}');
-    await upsert(fp.join(huskyDirectoryPath, 'post-commit'), 'npx auto-npm-version');
     console.log('Done adding Git hooks.');
 }
 async function findGitDirectoryPath(path) {
@@ -71,11 +71,12 @@ async function findGitDirectoryPath(path) {
 async function upsert(filePath, text) {
     try {
         await fs.access(filePath);
+        console.log('Found', filePath);
     }
     catch (error) {
-        console.log('Created', filePath);
         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');

package/lib/lint-commit-message.js

@@ -25,12 +25,18 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 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);
     const message = (await fs.readFile(messageFilePath, 'utf-8')).trim();
-    const { errors } = (0, index_1.checkConventionalMessage)(message, console);
+    (0, debug_1.debug)('message »', message);
+    const { errors } = (0, index_1.checkConventionalMessage)(message, { debug: debug_1.debug });
     if (errors.length > 0) {
-        throw new Error(errors[0]);
+        for (const error of errors) {
+            console.error(error);
+        }
+        process.exit(1);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@thisismanta/semantic-version",
-	"version": "1.0.4",
+	"version": "2.0.0-0",
 	"author": "Anantachai Saothong <thisismanta@gmail.com>",
 	"license": "ISC",
 	"engines": {
@@ -18,22 +18,25 @@
 	],
 	"scripts": {
 		"test": "jest",
-		"build": "tsc",
-		"preversion": "npm run test && npm run build && git add lib/*",
+		"build": "rm -rf lib && tsc",
+		"preversion": "npm run test && npm run build",
 		"version": "npm publish --access public",
-		"postversion": "git push --tags origin master",
+		"postversion": "git push --follow-tags origin master",
 		"postinstall": "node ./lib/install-git-hooks.js"
 	},
 	"devDependencies": {
 		"@types/jest": "^29.4.0",
 		"@types/node": "^16.0.0",
+		"@types/semver": "^7.3.13",
 		"jest": "^29.4.3",
 		"ts-jest": "^29.0.5",
 		"typescript": "^4.9.5"
 	},
 	"dependencies": {
+		"@actions/github": "^5.1.1",
 		"execa": "npm:@esm2cjs/execa@^6.1.1-cjs.1",
-		"husky": "^8.0.3"
+		"husky": "^8.0.3",
+		"semver": "^7.3.8"
 	},
 	"jest": {
 		"preset": "ts-jest",