@4s1/conventional-commit-creator 0.7.0 → 0.10.1

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.10.1](https://gitlab.com/4s1/conventional-commit-creator/compare/v0.10.0...v0.10.1) (2021-12-18)
+
+
+### Bug Fixes
+
+* add check if current dir is a git repository ([#4](https://gitlab.com/4s1/conventional-commit-creator/issues/4)) ([75d34be](https://gitlab.com/4s1/conventional-commit-creator/commit/75d34be610e1ef6500d970f8c32464da0bf2d6a3))
+* add missing await statement and rename function ([04892a0](https://gitlab.com/4s1/conventional-commit-creator/commit/04892a0e1a9566c0b53895036792001a8e42b00f))
+
+## [0.10.0](https://gitlab.com/4s1/conventional-commit-creator/compare/v0.9.0...v0.10.0) (2021-12-15)
+
+## [0.9.0](https://gitlab.com/4s1/conventional-commit-creator/compare/v0.8.0...v0.9.0) (2021-12-10)
+
+## [0.8.0](https://gitlab.com/4s1/conventional-commit-creator/compare/v0.7.0...v0.8.0) (2021-11-18)
+
+
+### Features
+
+* add hack for redmine at work ([538273e](https://gitlab.com/4s1/conventional-commit-creator/commit/538273e997c074bb28c877571b68e82a9d3fff52))
+
 ## [0.7.0](https://gitlab.com/4s1/conventional-commit-creator/compare/v0.6.0...v0.7.0) (2021-11-18)
 
 

package/README.md

@@ -1,12 +1,18 @@
 # 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).
+
+![Usage](https://gitlab.com/4s1/conventional-commit-creator/-/raw/main/_docs/usage.gif 'Usage')
+
 ## Install
 
 ```bash
-npm install -g --registry=https://gitlab.com/api/v4/packages/npm/ @4s1/conventional-commit-creator
+# Install globally
+npm install -g @4s1/conventional-commit-creator
 ```
 
-## Run
+## Usage
 
 ```bash
 conventional-commit-creator

package/dist/index.js

@@ -64,28 +64,38 @@ const questions = [
     },
 ];
 async function main() {
+    if (!(await isCurrentDirUnderGitControl())) {
+        console.error('Current directory is not a git repository.');
+        process.exit(0);
+    }
     if (!(await haveStagedChanges())) {
         console.error('Nothing to commit');
         process.exit(0);
     }
-    const data = await (0, prompts_1.default)(questions, {
+    const data = (await (0, prompts_1.default)(questions, {
         onCancel: () => {
             console.error('Aborted');
             process.exit(1);
         },
-    });
-    const msg = createMsg(data);
+    }));
+    const msg = await createMsg(data);
     await commit(msg);
     console.info('done');
 }
-function createMsg(data) {
+async function createMsg(data) {
     let msg = `${data.type.trim()}`;
     if (data.scope) {
         msg += `(${data.scope.trim()})`;
     }
     msg += `: ${data.description.trim()}`;
     if (data.issue) {
-        msg += ` #${data.issue}`;
+        // Hack to support Redmine ticket linking at work.
+        if (!(await isWork())) {
+            msg += ` (#${data.issue})`;
+        }
+        else {
+            msg += ` [refs #${data.issue}]`;
+        }
     }
     return msg;
 }
@@ -99,6 +109,15 @@ async function commit(msg) {
         process.exit(1);
     }
 }
+async function isCurrentDirUnderGitControl() {
+    try {
+        const result = await execute('git rev-parse --is-inside-work-tree');
+        return result === 'true';
+    }
+    catch (err) {
+        return false;
+    }
+}
 async function haveStagedChanges() {
     try {
         const staged = await execute('git diff --cached');
@@ -109,6 +128,16 @@ async function haveStagedChanges() {
         process.exit(1);
     }
 }
+async function isWork() {
+    try {
+        const output = await execute('git remote -v');
+        return output.includes('intra.bender:');
+    }
+    catch (err) {
+        console.error(err);
+        process.exit(1);
+    }
+}
 async function execute(cmd) {
     return new Promise((resolve, reject) => {
         (0, child_process_1.exec)(cmd, (err, stdout) => {

package/package.json

@@ -1,7 +1,11 @@
 {
   "name": "@4s1/conventional-commit-creator",
-  "version": "0.7.0",
+  "version": "0.10.1",
   "description": "Conventional Commit Creator",
+  "keywords": [
+    "conventional commit",
+    "4s1"
+  ],
   "bugs": {
     "url": "https://gitlab.com/4s1/conventional-commit-creator/issues"
   },
@@ -36,22 +40,32 @@
     "release:patch": "pnpm run release -- --release-as patch",
     "start": "node dist/index.js",
     "start:dev": "ts-node src/index.ts",
-    "test": "echo no tests"
+    "test": "jest",
+    "test:cov": "pnpm run test -- --coverage",
+    "test:watch": "pnpm run test -- --watch"
   },
   "prettier": "@4s1/eslint-config",
   "dependencies": {
     "prompts": "^2.4.2"
   },
   "devDependencies": {
-    "@4s1/eslint-config": "3.2.2",
-    "@4s1/ts-config": "1.3.0",
-    "@types/node": "14.17.33",
+    "@4s1/eslint-config": "3.4.0",
+    "@4s1/ts-config": "1.4.0",
+    "@commitlint/cli": "15.0.0",
+    "@commitlint/config-conventional": "15.0.0",
+    "@types/jest": "27.0.3",
+    "@types/node": "14.18.1",
     "@types/prompts": "2.4.0",
-    "eslint": "8.2.0",
+    "eslint": "8.5.0",
     "husky": "7.0.4",
-    "prettier": "2.4.1",
+    "jest": "27.4.5",
+    "prettier": "2.5.1",
     "standard-version": "9.3.2",
+    "ts-jest": "27.1.2",
     "ts-node": "10.4.0",
-    "typescript": "4.4.4"
+    "typescript": "4.5.4"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }