@4s1/conventional-commit-creator 2.0.0 → 2.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Steffen (4s1)
+Copyright (c) 2023 Steffen (4s1)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,7 +1,3 @@
-[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=4s1_conventional-commit-creator&metric=bugs)](https://sonarcloud.io/project/issues?id=4s1_conventional-commit-creator&resolved=false&types=BUG)
-[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=4s1_conventional-commit-creator&metric=vulnerabilities)](https://sonarcloud.io/project/issues?id=4s1_conventional-commit-creator&resolved=false&types=VULNERABILITY)
-[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=4s1_conventional-commit-creator&metric=code_smells)](https://sonarcloud.io/project/issues?id=4s1_conventional-commit-creator&resolved=false&types=CODE_SMELL)
-
 # Conventional Commit Creator
 
 This CLI application assists in creating commit messages that are conform to the conventional commit style.

package/dist/git.js

@@ -34,13 +34,16 @@ export class Git {
     async commit(msg) {
         console.info('committing ...');
         try {
-            await this.execute(`git commit -m "${msg}"`);
+            await this.execute(`git commit -m "${this.encodeMessage(msg)}"`);
         }
         catch (err) {
             console.error(err);
             process.exit(1);
         }
     }
+    encodeMessage(msg) {
+        return msg.replaceAll('"', '\\"');
+    }
     execute(cmd) {
         return new Promise((resolve, reject) => {
             exec(cmd, (err, stdout) => {
@@ -53,4 +56,3 @@ export class Git {
         });
     }
 }
-//# sourceMappingURL=git.js.map

package/dist/index.js

@@ -95,4 +95,3 @@ async function createMsg(data, isWork) {
     return msg;
 }
 main().catch(console.error);
-//# sourceMappingURL=index.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@4s1/conventional-commit-creator",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "description": "Conventional Commit Creator",
   "keywords": [
     "conventional commit",
@@ -29,9 +29,9 @@
   "scripts": {
     "build": "rm -rf dist && tsc",
     "build:dev": "pnpm run build -- --project tsconfig.dev.json",
-    "format": "prettier --write .",
     "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",
@@ -40,21 +40,20 @@
   },
   "prettier": "@4s1/eslint-config",
   "dependencies": {
-    "prompts": "^2.4.2"
+    "prompts": "2.4.2"
   },
   "devDependencies": {
-    "@4s1/eslint-config": "4.3.0",
-    "@4s1/ts-config": "3.0.1",
-    "@types/node": "18.11.18",
-    "@types/prompts": "2.4.2",
-    "eslint": "8.31.0",
-    "prettier": "2.8.2",
+    "@4s1/eslint-config": "6.5.0",
+    "@4s1/ts-config": "4.1.1",
+    "@types/node": "18.15.11",
+    "@types/prompts": "2.4.4",
+    "eslint": "8.38.0",
+    "prettier": "2.8.7",
     "ts-node": "10.9.1",
-    "typescript": "4.9.4"
+    "typescript": "5.0.4"
   },
   "engines": {
-    "node": "18",
-    "pnpm": "7"
+    "node": "18"
   },
   "publishConfig": {
     "access": "public"

package/dist/git.d.ts

@@ -1,8 +0,0 @@
-export declare class Git {
-    isCurrentDirUnderGitControl(): Promise<boolean>;
-    haveStagedChanges(): Promise<boolean>;
-    isAtWork(): Promise<boolean>;
-    commit(msg: string): Promise<void>;
-    private execute;
-}
-//# sourceMappingURL=git.d.ts.map

package/dist/git.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"git.d.ts","sourceRoot":"","sources":["../src/git.ts"],"names":[],"mappings":"AAEA,qBAAa,GAAG;IACD,2BAA2B,IAAI,OAAO,CAAC,OAAO,CAAC;IAU/C,iBAAiB,IAAI,OAAO,CAAC,OAAO,CAAC;IAWrC,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC;IAU5B,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAU/C,OAAO,CAAC,OAAO;CAWhB"}

package/dist/git.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"git.js","sourceRoot":"","sources":["../src/git.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAiB,MAAM,oBAAoB,CAAC;AAEzD,MAAM,OAAO,GAAG;IACP,KAAK,CAAC,2BAA2B;QACtC,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,qCAAqC,CAAC,CAAC;YACzE,OAAO,MAAM,CAAC,IAAI,EAAE,KAAK,MAAM,CAAC;SACjC;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEM,KAAK,CAAC,iBAAiB;QAC5B,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC,CAAC;YACjE,OAAO,MAAM,KAAK,EAAE,CAAC;SACtB;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;YAC5B,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEM,KAAK,CAAC,QAAQ;QACnB,IAAI;YACF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;YACnD,OAAO,MAAM,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;SACzC;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW;QAC7B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC/B,IAAI;YACF,MAAM,IAAI,CAAC,OAAO,CAAC,kBAAkB,GAAG,GAAG,CAAC,CAAC;SAC9C;QAAC,OAAO,GAAG,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACnB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;IACH,CAAC;IAEO,OAAO,CAAC,GAAW;QACzB,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAyB,EAAE,MAAc,EAAE,EAAE;gBACtD,IAAI,GAAG,EAAE;oBACP,MAAM,CAAC,GAAG,CAAC,CAAC;oBACZ,OAAO;iBACR;gBACD,OAAO,CAAC,MAAM,CAAC,CAAC;YAClB,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["import { exec, ExecException } from 'node:child_process';\n\nexport class Git {\n  public async isCurrentDirUnderGitControl(): Promise<boolean> {\n    try {\n      const result = await this.execute('git rev-parse --is-inside-work-tree');\n      return result.trim() === 'true';\n    } catch (err) {\n      console.error(err);\n      return false;\n    }\n  }\n\n  public async haveStagedChanges(): Promise<boolean> {\n    try {\n      const staged = await this.execute('git diff --cached | head -5');\n      return staged !== '';\n    } catch (err) {\n      console.error(err);\n      console.log('return false');\n      return false;\n    }\n  }\n\n  public async isAtWork(): Promise<boolean> {\n    try {\n      const output = await this.execute('git remote -v');\n      return output.includes('intra.bender:');\n    } catch (err) {\n      console.error(err);\n      return false;\n    }\n  }\n\n  public async commit(msg: string): Promise<void> {\n    console.info('committing ...');\n    try {\n      await this.execute(`git commit -m \"${msg}\"`);\n    } catch (err) {\n      console.error(err);\n      process.exit(1);\n    }\n  }\n\n  private execute(cmd: string): Promise<string> {\n    return new Promise((resolve, reject) => {\n      exec(cmd, (err: ExecException | null, stdout: string) => {\n        if (err) {\n          reject(err);\n          return;\n        }\n        resolve(stdout);\n      });\n    });\n  }\n}\n"]}

package/dist/index.d.ts

@@ -1,3 +0,0 @@
-#!/usr/bin/env node
-export {};
-//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":""}

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAEA,OAAO,OAAyB,MAAM,SAAS,CAAC;AAChD,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAS/B,iGAAiG;AACjG,MAAM,SAAS,GAAmB;IAChC;QACE,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE;YACP,EAAE,KAAK,EAAE,qBAAqB,EAAE,KAAK,EAAE,KAAK,EAAE;YAC9C,EAAE,KAAK,EAAE,0BAA0B,EAAE,KAAK,EAAE,MAAM,EAAE;YACpD,EAAE,KAAK,EAAE,sEAAsE,EAAE,KAAK,EAAE,UAAU,EAAE;YACpG,EAAE,KAAK,EAAE,oDAAoD,EAAE,KAAK,EAAE,MAAM,EAAE;YAC9E,EAAE,KAAK,EAAE,uCAAuC,EAAE,KAAK,EAAE,MAAM,EAAE;YACjE,EAAE,KAAK,EAAE,8EAA8E,EAAE,KAAK,EAAE,OAAO,EAAE;YACzG,EAAE,KAAK,EAAE,oCAAoC,EAAE,KAAK,EAAE,MAAM,EAAE;YAC9D,EAAE,KAAK,EAAE,8DAA8D,EAAE,KAAK,EAAE,OAAO,EAAE;YACzF,EAAE,KAAK,EAAE,2DAA2D,EAAE,KAAK,EAAE,OAAO,EAAE;YACtF,EAAE,KAAK,EAAE,gEAAgE,EAAE,KAAK,EAAE,IAAI,EAAE;YACxF,EAAE,KAAK,EAAE,sCAAsC,EAAE,KAAK,EAAE,QAAQ,EAAE;SACnE;KACF;IACD;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,QAAQ;QACjB,QAAQ,EAAE,CAAC,KAAa,EAAoB,EAAE;YAC5C,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE;gBACrB,OAAO,gBAAgB,KAAK,CAAC,MAAM,GAAG,EAAE,oBAAoB,CAAC;aAC9D;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC;KACF;IACD;QACE,IAAI,EAAE,MAAM;QACZ,IAAI,EAAE,aAAa;QACnB,OAAO,EAAE,cAAc;QACvB,QAAQ,EAAE,CAAC,KAAa,EAAoB,EAAE;YAC5C,IAAI,KAAK,CAAC,MAAM,GAAG,EAAE,EAAE;gBACrB,OAAO,gBAAgB,KAAK,CAAC,MAAM,GAAG,EAAE,oBAAoB,CAAC;aAC9D;iBAAM,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC3B,OAAO,gBAAgB,CAAC,GAAG,KAAK,CAAC,MAAM,qBAAqB,CAAC;aAC9D;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC;KACF;IACD;QACE,IAAI,EAAE,QAAQ;QACd,IAAI,EAAE,OAAO;QACb,OAAO,EAAE,QAAQ;KAClB;CACF,CAAC;AAEF,KAAK,UAAU,IAAI;IACjB,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;IAEtB,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,2BAA2B,EAAE,CAAC,EAAE;QAC9C,OAAO,CAAC,KAAK,CAAC,4CAA4C,CAAC,CAAC;QAC5D,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,iBAAiB,EAAE,CAAC,EAAE;QACpC,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,CAAC;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,MAAM,IAAI,GAAG,CAAC,MAAM,OAAO,CAAC,SAAS,EAAE;QACrC,QAAQ,EAAE,GAAG,EAAE;YACb,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACzB,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAClB,CAAC;KACF,CAAC,CAAe,CAAC;IAElB,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,QAAQ,EAAE,CAAC;IACtC,MAAM,GAAG,GAAG,MAAM,SAAS,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;IAC5C,MAAM,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;AACvB,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,IAAgB,EAAE,MAAe;IACxD,IAAI,GAAG,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,CAAC;IAEhC,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,GAAG,IAAI,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,GAAG,CAAC;KACjC;IAED,GAAG,IAAI,KAAK,IAAI,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;IAEtC,IAAI,IAAI,CAAC,KAAK,EAAE;QACd,kDAAkD;QAClD,IAAI,CAAC,MAAM,EAAE;YACX,GAAG,IAAI,MAAM,IAAI,CAAC,KAAK,GAAG,CAAC;SAC5B;aAAM;YACL,GAAG,IAAI,WAAW,IAAI,CAAC,KAAK,GAAG,CAAC;SACjC;KACF;IAED,OAAO,GAAG,CAAC;AACb,CAAC;AAED,IAAI,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC","sourcesContent":["#!/usr/bin/env node\n\nimport prompts, { PromptObject } from 'prompts';\nimport { Git } from './git.js';\n\ntype promptType = {\n  type: string;\n  scope?: string;\n  description: string;\n  issue?: number;\n};\n\n// https://kapeli.com/cheat_sheets/Conventional_Commits.docset/Contents/Resources/Documents/index\nconst questions: PromptObject[] = [\n  {\n    type: 'select',\n    name: 'type',\n    message: 'type?',\n    choices: [\n      { title: 'fix      - A bugfix', value: 'fix' },\n      { title: 'feat     - A new feature', value: 'feat' },\n      { title: 'refactor - A code change that neither fixes a bug nor adds a feature', value: 'refactor' },\n      { title: 'perf     - A code change that improves performance', value: 'perf' },\n      { title: 'docs     - Documentation only changes', value: 'docs' },\n      { title: 'style    - Code style (semicolon, indentation, white-space, formatting, ...)', value: 'style' },\n      { title: 'test     - add/change/delete tests', value: 'test' },\n      { title: \"chore    - Other changes that don't modify src or test files\", value: 'chore' },\n      { title: 'build    - build system (npm, git, VSCode, tsconfig, ...)', value: 'build' },\n      { title: 'ci       - CI configuration (GitHub, GitLab, RenovateBot, ...)', value: 'ci' },\n      { title: 'revert   - Reverts a previous commit', value: 'revert' },\n    ],\n  },\n  {\n    type: 'text',\n    name: 'scope',\n    message: 'scope?',\n    validate: (value: string): string | boolean => {\n      if (value.length > 30) {\n        return `Your text is ${value.length - 30} char(s) too long.`;\n      } else {\n        return true;\n      }\n    },\n  },\n  {\n    type: 'text',\n    name: 'description',\n    message: 'description?',\n    validate: (value: string): string | boolean => {\n      if (value.length > 80) {\n        return `Your text is ${value.length - 80} char(s) too long.`;\n      } else if (value.length < 3) {\n        return `Your text is ${3 - value.length} char(s) too short.`;\n      } else {\n        return true;\n      }\n    },\n  },\n  {\n    type: 'number',\n    name: 'issue',\n    message: 'issue?',\n  },\n];\n\nasync function main(): Promise<void> {\n  const git = new Git();\n\n  if (!(await git.isCurrentDirUnderGitControl())) {\n    console.error('Current directory is not a git repository.');\n    process.exit(0);\n  }\n\n  if (!(await git.haveStagedChanges())) {\n    console.error('Nothing to commit');\n    process.exit(0);\n  }\n\n  const data = (await prompts(questions, {\n    onCancel: () => {\n      console.error('Aborted');\n      process.exit(1);\n    },\n  })) as promptType;\n\n  const isAtWork = await git.isAtWork();\n  const msg = await createMsg(data, isAtWork);\n  await git.commit(msg);\n  console.info('done');\n}\n\nasync function createMsg(data: promptType, isWork: boolean): Promise<string> {\n  let msg = `${data.type.trim()}`;\n\n  if (data.scope) {\n    msg += `(${data.scope.trim()})`;\n  }\n\n  msg += `: ${data.description.trim()}`;\n\n  if (data.issue) {\n    // Hack to support Redmine ticket linking at work.\n    if (!isWork) {\n      msg += ` (#${data.issue})`;\n    } else {\n      msg += ` [refs #${data.issue}]`;\n    }\n  }\n\n  return msg;\n}\n\nmain().catch(console.error);\n"]}