@4s1/conventional-commit-creator 3.0.0-dev.1 → 3.1.0

package/README.md

@@ -1,21 +1,158 @@
 # Conventional Commit Creator
 
-This CLI application assists in creating commit messages that are conform to the conventional commit style.
-It will ask for type, scope (optional), description and issue (optional).
+This CLI application assists you in creating commit messages that are conform to the conventional commit style.
+It will ask for _type_, _scope_, _description_, _body_ and _issue id_.
 
-![Usage](https://raw.githubusercontent.com/4s1-org/conventional-commit-creator/main/_docs/usage.gif 'Usage')
+Features:
 
-## Install
+⭐ format of the commit message can be fully customized \
+⭐ different templates for your repositories based on Git remote url \
+⭐ issue id can be inserted in up to three places of a commit message
+
+## Install & usage
+
+Install this package globally.
 
 ```bash
-# Install globally
 npm install -g @4s1/conventional-commit-creator
 ```
 
-## Usage
+Inside your repository run Conventional Commit Creator.
 
 ```bash
 conventional-commit-creator
-# or
+# or just
 ccc
 ```
+
+## Configure commit message templates
+
+The configuration is stored in `~/.config/conventional-commit-creator/config.json`.
+
+The default template look like the following json:
+
+```json
+{
+  "version": 1,
+  "templates": [
+    {
+      "name": "Default",
+      "regex": ".*",
+      "pattern": "{type}{scope}: {description}{issue}{body}",
+
+      "pre_type": "",
+      "post_type": "",
+      "pre_scope": "(",
+      "post_scope": ")",
+      "pre_description": "",
+      "post_description": "",
+      "pre_body": "\n\n",
+      "post_body": "",
+
+      "pre_issue": " (#",
+      "post_issue": ")",
+      "pre_issue2": "",
+      "post_issue2": "",
+      "pre_issue3": "",
+      "post_issue3": ""
+    }
+  ]
+}
+```
+
+and will create the following commit message:
+
+```text
+--- your input --------------------------
+
+type: chore
+scope: foo
+description: some description
+body: Lorem ipsum dolor sit amet.
+issue: 42
+
+--- commit message result ---------------
+
+chore(foo): some description (#42)
+
+Lorem ipsum dolor sit amet.
+```
+
+The `pre` and `post` texts are only inserted if a matching middle part has also been entered.
+
+Now let's look at another more complex variant.
+
+We take the configuration from above, remove all empty strings (missing settings are replaced by empty strings) and add another template that should apply to all GitHub projects (see _regex_).
+
+```json
+{
+  "version": 1,
+  "templates": [
+    {
+      "name": "Default",
+      "regex": ".*",
+      "pattern": "{type}{scope}: {description}{issue}{body}",
+      "pre_scope": "(",
+      "post_scope": ")",
+      "pre_body": "\n\n",
+      "pre_issue": " (#",
+      "post_issue": ")"
+    },
+    {
+      "name": "GitHub Project",
+      "regex": "^.*github.*$",
+      "pattern": "{type}{scope}: {description}{body}{issue}{issue2}{issue3}",
+      "pre_scope": "(",
+      "post_scope": ")",
+      "pre_body": "\n\n",
+      "pre_issue": "\n\nRefs: #",
+      "pre_issue2": " | [refs #",
+      "post_issue2": "]",
+      "pre_issue3": " | REDMINE-",
+      "post_issue3": ""
+    }
+  ]
+}
+```
+
+This will result in the following commit example:
+
+```text
+--- your input --------------------------
+
+type: refactor
+scope: -
+description: foobar
+body: Hallo \n world
+issue: 42
+
+--- commit message result ---------------
+
+refactor: foobar
+
+Hallo
+world
+
+Refs: #42 | [refs #42] | REDMINE-42
+```
+
+or without _issue id_
+
+```text
+--- your input --------------------------
+
+type: refactor
+scope: -
+description: foobar
+body: Hallo \n world
+issue: -
+
+--- commit message result ---------------
+
+refactor: foobar
+
+Hallo
+world
+```
+
+Checking the Git remote url via regular expression is done in the order the templates were specified from top to bottom. The last hit wins.

package/dist/config.js

@@ -1,12 +1,40 @@
 import fs from 'node:fs';
 import os from 'node:os';
-import { AppError } from './app-error.js';
+import path from 'node:path';
 export function loadConfig() {
-    const path = `${os.homedir()}/.ccc.json`;
-    if (!fs.existsSync(path)) {
-        throw new AppError(`No configuration found at "${path}".`);
+    const configFile = `${os.homedir()}/.config/conventional-commit-creator/config.json`;
+    if (fs.existsSync(configFile)) {
+        const config = fs.readFileSync(configFile, { encoding: 'utf-8' });
+        return JSON.parse(config);
+    }
+    else {
+        const config = {
+            $schema: 'https://www.4s1.de/conventional-commit-creator/schema.json',
+            version: 1,
+            templates: [
+                {
+                    name: 'Default',
+                    regex: '.*',
+                    pattern: '{type}{scope}: {description}{issue}{body}',
+                    pre_type: '',
+                    post_type: '',
+                    pre_scope: '(',
+                    post_scope: ')',
+                    pre_description: '',
+                    post_description: '',
+                    pre_body: '\n\n',
+                    post_body: '',
+                    pre_issue: ' (#',
+                    post_issue: ')',
+                    pre_issue2: '',
+                    post_issue2: '',
+                    pre_issue3: '',
+                    post_issue3: '',
+                },
+            ],
+        };
+        fs.mkdirSync(path.dirname(configFile), { recursive: true });
+        fs.writeFileSync(configFile, JSON.stringify(config, null, 2), { encoding: 'utf-8' });
+        return config;
     }
-    const content = fs.readFileSync(path, { encoding: 'utf-8' });
-    // ToDo: Exception handling
-    return JSON.parse(content);
 }

package/dist/index.js

@@ -129,42 +129,30 @@ async function createMsg(data, template) {
     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 ?? ''}`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4s1/conventional-commit-creator",
-  "version": "3.0.0-dev.1",
+  "version": "3.1.0",
   "description": "Conventional Commit Creator",
   "keywords": [
     "conventional commit",
@@ -44,11 +44,11 @@
   },
   "devDependencies": {
     "@4s1/eslint-config": "6.5.0",
-    "@4s1/ts-config": "4.3.0",
-    "@types/node": "18.15.11",
+    "@4s1/ts-config": "4.3.2",
+    "@types/node": "18.16.2",
     "@types/prompts": "2.4.4",
-    "eslint": "8.38.0",
-    "prettier": "2.8.7",
+    "eslint": "8.39.0",
+    "prettier": "2.8.8",
     "ts-node": "10.9.1",
     "typescript": "5.0.4"
   },