@4s1/conventional-commit-creator 2.0.1 → 3.0.0-dev.0

package/dist/app-error.js

@@ -0,0 +1,7 @@
+export class AppError extends Error {
+    constructor(msg) {
+        super(msg);
+        // Set the prototype explicitly.
+        Object.setPrototypeOf(this, AppError.prototype);
+    }
+}

package/dist/config.js

@@ -0,0 +1,12 @@
+import fs from 'node:fs';
+import os from 'node:os';
+import { AppError } from './app-error.js';
+export function loadConfig() {
+    const path = `${os.homedir()}/.ccc.json`;
+    if (!fs.existsSync(path)) {
+        throw new AppError(`No configuration found at "${path}".`);
+    }
+    const content = fs.readFileSync(path, { encoding: 'utf-8' });
+    // ToDo: Exception handling
+    return JSON.parse(content);
+}

package/dist/git.js

@@ -21,15 +21,8 @@ export class Git {
             return false;
         }
     }
-    async isAtWork() {
-        try {
-            const output = await this.execute('git remote -v');
-            return output.includes('intra.bender:');
-        }
-        catch (err) {
-            console.error(err);
-            return false;
-        }
+    async getGitRemoteOriginUrl() {
+        return this.execute('git remote get-url --push origin');
     }
     async commit(msg) {
         console.info('committing ...');

package/dist/index.js

@@ -1,6 +1,8 @@
 #!/usr/bin/env node
 import prompts from 'prompts';
 import { Git } from './git.js';
+import { loadConfig } from './config.js';
+import { AppError } from './app-error.js';
 // https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index
 const questions = [
     {
@@ -50,6 +52,11 @@ const questions = [
             }
         },
     },
+    {
+        type: 'text',
+        name: 'body',
+        message: 'body?',
+    },
     {
         type: 'number',
         name: 'issue',
@@ -57,41 +64,118 @@ const questions = [
     },
 ];
 async function main() {
-    const git = new Git();
-    if (!(await git.isCurrentDirUnderGitControl())) {
-        console.error('Current directory is not a git repository.');
-        process.exit(0);
-    }
-    if (!(await git.haveStagedChanges())) {
-        console.error('Nothing to commit');
-        process.exit(0);
-    }
-    const data = (await prompts(questions, {
-        onCancel: () => {
-            console.error('Aborted');
-            process.exit(1);
-        },
-    }));
-    const isAtWork = await git.isAtWork();
-    const msg = await createMsg(data, isAtWork);
-    await git.commit(msg);
-    console.info('done');
-}
-async function createMsg(data, isWork) {
-    let msg = `${data.type.trim()}`;
-    if (data.scope) {
-        msg += `(${data.scope.trim()})`;
+    try {
+        const git = new Git();
+        if (!(await git.isCurrentDirUnderGitControl())) {
+            throw new AppError('Current directory is not a git repository.');
+        }
+        if (!(await git.haveStagedChanges())) {
+            throw new AppError('Nothing to commit');
+        }
+        const config = loadConfig();
+        const remoteOriginUrl = (await git.getGitRemoteOriginUrl()).trim();
+        const template = getMatchingTemplate(config, remoteOriginUrl);
+        console.info(`Using template "${template.name}"\n`);
+        const data = (await prompts(questions, {
+            onCancel: () => {
+                // ToDo: Better exception handling
+                console.error('Aborted');
+                process.exit(1);
+            },
+        }));
+        const msg = await createMsg(data, template);
+        console.info(`${'-'.repeat(42)}\n${msg}\n${'-'.repeat(42)}`);
+        await git.commit(msg);
+        console.info('done');
     }
-    msg += `: ${data.description.trim()}`;
-    if (data.issue) {
-        // Hack to support Redmine ticket linking at work.
-        if (!isWork) {
-            msg += ` (#${data.issue})`;
+    catch (err) {
+        if (err instanceof AppError) {
+            console.error(err.message);
+            process.exit(0);
         }
         else {
-            msg += ` [refs #${data.issue}]`;
+            console.error(err);
+            process.exit(1);
+        }
+    }
+}
+function getMatchingTemplate(config, remoteOriginUrl) {
+    // ToDo: rename var
+    let template2;
+    for (const template of config.templates) {
+        const regEx = new RegExp(template.regex);
+        if (regEx.test(remoteOriginUrl)) {
+            template2 = template;
         }
     }
+    if (!template2) {
+        throw new AppError(`No matching template found for "${remoteOriginUrl}"`);
+    }
+    return template2;
+}
+async function createMsg(data, template) {
+    const type = data.type ? data.type.trim() : '';
+    const scope = data.scope ? data.scope.trim() : '';
+    const body = data.body
+        ? data.body
+            .split('\\n')
+            .map((x) => x.trim())
+            .join('\n')
+            .trim()
+        : '';
+    const description = data.description ? data.description.trim() : '';
+    const issue = data.issue ? data.issue.toString() : '';
+    let msg = template.pattern;
+    if (type) {
+        const typeText = `${template.pre_type ?? ''}${type}${template.post_type ?? ''}`;
+        msg = msg.replace('{type}', typeText);
+        const type2Text = `${template.pre_type2 ?? ''}${type}${template.post_type2 ?? ''}`;
+        msg = msg.replace('{type2}', type2Text);
+    }
+    else {
+        msg = msg.replace('{type}', '');
+        msg = msg.replace('{type2}', '');
+    }
+    if (scope) {
+        const scopeText = `${template.pre_scope ?? ''}${scope}${template.post_scope ?? ''}`;
+        msg = msg.replace('{scope}', scopeText);
+        const scope2Text = `${template.pre_scope2 ?? ''}${scope}${template.post_scope2 ?? ''}`;
+        msg = msg.replace('{scope2}', scope2Text);
+    }
+    else {
+        msg = msg.replace('{scope}', '');
+        msg = msg.replace('{scope2}', '');
+    }
+    if (description) {
+        const descriptionText = `${template.pre_description ?? ''}${description}${template.post_description ?? ''}`;
+        msg = msg.replace('{description}', descriptionText);
+        const description2Text = `${template.pre_description2 ?? ''}${description}${template.post_description2 ?? ''}`;
+        msg = msg.replace('{description2}', description2Text);
+    }
+    else {
+        msg = msg.replace('{description}', '');
+        msg = msg.replace('{description2}', '');
+    }
+    if (body) {
+        const bodyText = `${template.pre_body ?? ''}${body}${template.post_body ?? ''}`;
+        msg = msg.replace('{body}', bodyText);
+        const body2Text = `${template.pre_body2 ?? ''}${body}${template.post_body2 ?? ''}`;
+        msg = msg.replace('{body2}', body2Text);
+    }
+    else {
+        msg = msg.replace('{body}', '');
+        msg = msg.replace('{body2}', '');
+    }
+    if (issue) {
+        const issueText = `${template.pre_issue ?? ''}${issue}${template.post_issue ?? ''}`;
+        msg = msg.replace('{issue}', issueText);
+        const issue2Text = `${template.pre_issue2 ?? ''}${issue}${template.post_issue2 ?? ''}`;
+        msg = msg.replace('{issue2}', issue2Text);
+    }
+    else {
+        msg = msg.replace('{issue}', '');
+        msg = msg.replace('{issue2}', '');
+    }
     return msg;
 }
 main().catch(console.error);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4s1/conventional-commit-creator",
-  "version": "2.0.1",
+  "version": "3.0.0-dev.0",
   "description": "Conventional Commit Creator",
   "keywords": [
     "conventional commit",
@@ -28,15 +28,15 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsc",
-    "build:dev": "pnpm run build -- --project tsconfig.dev.json",
+    "build:dev": "pnpm run build --project tsconfig.dev.json",
     "lbt": "npm run lint && npm run build && npm run test",
     "lint": "eslint --ext .ts src/ && prettier --check .",
     "lint:fix": "eslint --ext .ts --fix src/ && prettier --write .",
     "start": "node dist/index.js",
     "start:dev": "ts-node src/index.ts",
     "test": "echo no tests",
-    "test:cov": "pnpm run test -- --coverage",
-    "test:watch": "pnpm run test -- --watch"
+    "test:cov": "pnpm run test --coverage",
+    "test:watch": "pnpm run test --watch"
   },
   "prettier": "@4s1/eslint-config",
   "dependencies": {
@@ -44,7 +44,7 @@
   },
   "devDependencies": {
     "@4s1/eslint-config": "6.5.0",
-    "@4s1/ts-config": "4.1.1",
+    "@4s1/ts-config": "4.3.0",
     "@types/node": "18.15.11",
     "@types/prompts": "2.4.4",
     "eslint": "8.38.0",