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

package/README.md

@@ -33,6 +33,7 @@ The default template look like the following json:
 
 ```json
 {
+  "$schema": "https://www.4s1.de/conventional-commit-creator/schema.json",
   "version": 1,
   "templates": [
     {
@@ -86,6 +87,7 @@ We take the configuration from above, remove all empty strings (missing settings
 
 ```json
 {
+  "$schema": "https://www.4s1.de/conventional-commit-creator/schema.json",
   "version": 1,
   "templates": [
     {

package/dist/config.js

@@ -9,6 +9,7 @@ export function loadConfig() {
     }
     else {
         const config = {
+            $schema: 'https://www.4s1.de/conventional-commit-creator/schema.json',
             version: 1,
             templates: [
                 {

package/dist/index.js

@@ -1,68 +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 = [
-    {
-        type: 'select',
-        name: 'type',
-        message: 'type?',
-        choices: [
-            { title: 'fix      - A bugfix', value: 'fix' },
-            { title: 'feat     - A new feature', value: 'feat' },
-            { title: 'refactor - A code change that neither fixes a bug nor adds a feature', value: 'refactor' },
-            { title: 'perf     - A code change that improves performance', value: 'perf' },
-            { title: 'docs     - Documentation only changes', value: 'docs' },
-            { title: 'style    - Code style (semicolon, indentation, white-space, formatting, ...)', value: 'style' },
-            { title: 'test     - add/change/delete tests', value: 'test' },
-            { title: "chore    - Other changes that don't modify src or test files", value: 'chore' },
-            { title: 'build    - build system (npm, git, VSCode, tsconfig, ...)', value: 'build' },
-            { title: 'ci       - CI configuration (GitHub, GitLab, RenovateBot, ...)', value: 'ci' },
-            { title: 'revert   - Reverts a previous commit', value: 'revert' },
-        ],
-    },
-    {
-        type: 'text',
-        name: 'scope',
-        message: 'scope?',
-        validate: (value) => {
-            if (value.length > 30) {
-                return `Your text is ${value.length - 30} char(s) too long.`;
-            }
-            else {
-                return true;
-            }
-        },
-    },
-    {
-        type: 'text',
-        name: 'description',
-        message: 'description?',
-        validate: (value) => {
-            if (value.length > 80) {
-                return `Your text is ${value.length - 80} char(s) too long.`;
-            }
-            else if (value.length < 3) {
-                return `Your text is ${3 - value.length} char(s) too short.`;
-            }
-            else {
-                return true;
-            }
-        },
-    },
-    {
-        type: 'text',
-        name: 'body',
-        message: 'body?',
-    },
-    {
-        type: 'number',
-        name: 'issue',
-        message: 'issue?',
-    },
-];
+import { askForBody, askForDescription, askForIssue, askForScope, askForType } from './questions.js';
 async function main() {
     try {
         const git = new Git();
@@ -76,14 +16,14 @@ async function main() {
         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);
+        const answers = {
+            type: await askForType(),
+            scope: await askForScope(),
+            description: await askForDescription(),
+            body: await askForBody(),
+            issue: await askForIssue(),
+        };
+        const msg = await createMsg(answers, template);
         console.info(`${'-'.repeat(42)}\n${msg}\n${'-'.repeat(42)}`);
         await git.commit(msg);
         console.info('done');
@@ -113,18 +53,18 @@ function getMatchingTemplate(config, 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
+async function createMsg(answers, template) {
+    const type = answers.type ? answers.type.trim() : '';
+    const scope = answers.scope ? answers.scope.trim() : '';
+    const body = answers.body
+        ? answers.body
             .split('\\n')
             .map((x) => x.trim())
             .join('\n')
             .trim()
         : '';
-    const description = data.description ? data.description.trim() : '';
-    const issue = data.issue ? data.issue.toString() : '';
+    const description = answers.description ? answers.description.trim() : '';
+    const issue = answers.issue ? answers.issue.trim() : '';
     let msg = template.pattern;
     if (type) {
         const typeText = `${template.pre_type ?? ''}${type}${template.post_type ?? ''}`;

package/dist/questions.js

@@ -0,0 +1,112 @@
+import select from '@inquirer/select';
+import input from '@inquirer/input';
+export function askForType() {
+    return select({
+        message: 'type?',
+        choices: [
+            {
+                name: 'fix',
+                value: 'fix',
+                description: 'A bugfix',
+            },
+            {
+                name: 'feat',
+                value: 'feat',
+                description: 'A new feature',
+            },
+            {
+                name: 'refactor',
+                value: 'refactor',
+                description: 'A code change that neither fixes a bug nor adds a feature',
+            },
+            {
+                name: 'perf',
+                value: 'perf',
+                description: 'A code change that improves performance',
+            },
+            {
+                name: 'docs',
+                value: 'docs',
+                description: 'Documentation only changes',
+            },
+            {
+                name: 'style',
+                value: 'style',
+                description: 'Code style (semicolon, indentation, white-space, formatting, ...)',
+            },
+            {
+                name: 'test',
+                value: 'test',
+                description: 'add/change/delete tests',
+            },
+            {
+                name: 'chore',
+                value: 'chore',
+                description: "Other changes that don't modify src or test files",
+            },
+            {
+                name: 'build',
+                value: 'build',
+                description: 'build system (npm, git, VSCode, tsconfig, angular.json, ...)',
+            },
+            {
+                name: 'ci',
+                value: 'ci',
+                description: 'CI configuration (GitHub, GitLab, RenovateBot, ...)',
+            },
+            {
+                name: 'revert',
+                value: 'revert',
+                description: 'Reverts a previous commit',
+            },
+        ],
+    });
+}
+export function askForScope() {
+    return input({
+        message: 'scope?',
+        validate: (value) => {
+            if (value.length > 20) {
+                return `Your text is ${value.length - 20} char(s) too long.`;
+            }
+            else {
+                return true;
+            }
+        },
+    });
+}
+export function askForDescription() {
+    return input({
+        message: 'description?',
+        validate: (value) => {
+            if (value.length > 70) {
+                return `Your text is ${value.length - 70} char(s) too long.`;
+            }
+            else if (value.length < 3) {
+                return `Your text is ${3 - value.length} char(s) too short.`;
+            }
+            else {
+                return true;
+            }
+        },
+    });
+}
+export function askForBody() {
+    return input({
+        message: 'body?',
+    });
+}
+export function askForIssue() {
+    return input({
+        message: 'issue?',
+        validate: (value) => {
+            const regularExpression = /^\d+$/;
+            if (value.length > 0 && !regularExpression.test(value)) {
+                return 'Your issue is not a number.';
+            }
+            else {
+                return true;
+            }
+        },
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4s1/conventional-commit-creator",
-  "version": "3.0.0",
+  "version": "3.2.0-dev.0",
   "description": "Conventional Commit Creator",
   "keywords": [
     "conventional commit",
@@ -28,24 +28,25 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsc",
-    "build:dev": "pnpm run build --project tsconfig.dev.json",
+    "build:dev": "rm -rf dist && tsc --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",
+    "start:dev": "ts-node --esm src/index.ts",
     "test": "echo no tests",
     "test:cov": "pnpm run test --coverage",
     "test:watch": "pnpm run test --watch"
   },
   "prettier": "@4s1/eslint-config",
   "dependencies": {
-    "prompts": "2.4.2"
+    "@inquirer/input": "1.0.3",
+    "@inquirer/select": "1.0.3"
   },
   "devDependencies": {
     "@4s1/eslint-config": "6.5.0",
     "@4s1/ts-config": "4.3.2",
-    "@types/node": "18.16.2",
+    "@types/node": "18.16.3",
     "@types/prompts": "2.4.4",
     "eslint": "8.39.0",
     "prettier": "2.8.8",