chore(release): v1.5.1

Reviewed-on: technology/rcz#8

.rczrc

@@ -1 +0,0 @@
-{}

.rczrc.json

@@ -0,0 +1,9 @@
+{
+  "scopes": [
+    "commands",
+    "changelog",
+    "readme",
+    "release",
+    "config"
+  ]
+}

CHANGELOG.md

@@ -0,0 +1,87 @@
+# Changelog
+
+Generation of this changelog is based on commits
+
+## v1.5.0
+
+### Features
+
+- [92f8126ab] - **commands**: add --amend option to commit sub-command
+- [5080d71fb] - **config**: allow more config file names
+
+### Fixes
+
+- [53bb1437a] - **commands**: allow chore type (#7)
+
+## v1.4.0
+
+### Features
+
+- [8ab631549] - **commands**: add the ability to return code only for validation command
+
+## v1.3.0
+
+### Features
+
+- [755da3bb5] - **commands**: add ability to write a footer
+- [9311be80b] - **commands**: add commit message validation command (#4)
+
+## v1.2.0
+
+### Features
+
+- [46a52ddeb] - **commands**: add the ability to sign conventional commits (#2)
+
+## v1.1.3
+
+### Fixes
+
+- [d3cf78aac] - **commands**: incorrect formatting of changelog hashes
+
+## v1.1.2
+
+### Miscellaneous
+
+- [85649a71a] - **commands**: change changelog output text
+
+## v1.1.1
+
+### Fixes
+
+- [7a5880d21] - **commands**: incorrect changelog version generation
+
+## v1.1.0
+
+### Features
+
+- [8e5158726] - **commands**: add release and changelog commands
+
+### Miscellaneous
+
+- [b05591a31] - **release**: v1.1.0
+
+## v1.0.0
+
+### Breaking
+
+- [7ef777bb2] - use commander for command management
+
+### Miscellaneous
+
+- [b07d9aaaa] - change question formatting, improve readme
+
+## v1.0.0-alpha.1
+
+### Features
+
+- [b5ca3152c] - add support for body (#1)
+- [ce0c01347] - initial commit
+
+### Fixes
+
+- [2be2887ce] - make commit body wrap properly
+- [e9d3c5e29] - incorrect config parsing
+
+### Miscellaneous
+
+- [4e16104d6] - change intro and outro messages

README.md

@@ -17,12 +17,13 @@ Resultium commit standardization library
 
 1. Make changes to your git initialized project
 2. Run `rcz commit` in the root directory
+   - if you wish to sign your commit use `--sign` option
 3. Answer all the questions
 4. Push to remote
 
 ## Configuration
 
-You can create an `.rczrc` file in your root directory and specify available scopes and commit types
+You can create an `.rczrc`, `.rczrc.json` or `rcz.config.json` file in your root directory and specify available scopes and commit types
 
 ```json
 {

cspell.json

@@ -4,6 +4,8 @@
   "dictionaryDefinitions": [],
   "dictionaries": [],
   "words": [
+    "Acked",
+    "johndoe",
     "outro",
     "rczrc"
   ],

package.json

@@ -1,6 +1,6 @@
 {
     "name": "@resultium/rcz",
-    "version": "1.1.1",
+    "version": "1.5.1",
     "description": "Resultium commit standardization library, based on conventional commits",
     "main": "./dist/index.js",
     "bin": {

src/index.ts

@@ -24,6 +24,18 @@ const GetConfig = async () => {
         await fs.promises.readFile(path.join(process.cwd(), ".rczrc"))
       ).toString()
     ) as Config;
+  } else if (fs.existsSync(path.join(process.cwd(), ".rczrc.json"))) {
+    return JSON.parse(
+      (
+        await fs.promises.readFile(path.join(process.cwd(), ".rczrc.json"))
+      ).toString()
+    ) as Config;
+  } else if (fs.existsSync(path.join(process.cwd(), "rcz.config.json"))) {
+    return JSON.parse(
+      (
+        await fs.promises.readFile(path.join(process.cwd(), "rcz.config.json"))
+      ).toString()
+    ) as Config;
   } else {
     return null;
   }
@@ -33,12 +45,17 @@ const program = new Command();
 program
   .name("rcz")
   .description("Resultium commit standardization command-line interface")
-  .version("1.0.0");
+  .version("1.4.0");
 
 program
   .command("commit")
   .description("Create a conventional commit")
-  .action(async () => {
+  .option("-S, --sign", "sign the commit")
+  .option("--amend", "amend commit message to the last commit")
+  .action(async (options) => {
+    const sign = options.sign ? true : false;
+    const amend = options.amend ? true : false;
+
     const config = await GetConfig();
 
     intro("Creating a conventional commit");
@@ -48,10 +65,12 @@ program
       process.exit(0);
     }
 
-    const stageAll = await confirm({
-      message: "Stage all changes?",
-      initialValue: true,
-    });
+    const stageAll = amend
+      ? null
+      : await confirm({
+          message: "Stage all changes?",
+          initialValue: true,
+        });
 
     if (isCancel(stageAll)) {
       cancel("Commit creation cancelled");
@@ -96,6 +115,11 @@ program
           value: "refactor",
           hint: "code change that neither fixes a bug nor adds a feature",
         },
+        {
+          label: "chore",
+          value: "chore",
+          hint: "changes that are routinely, e.g. dependency update or a release commit",
+        },
       ],
     });
 
@@ -142,6 +166,15 @@ program
       process.exit(0);
     }
 
+    const footer = await text({
+      message: `Insert commit footer, can be left empty, e.g. Acked-by: @johndoe`,
+    });
+
+    if (isCancel(footer)) {
+      cancel("Commit creation cancelled");
+      process.exit(0);
+    }
+
     const isBreaking = await confirm({
       message: "Does this commit have breaking changes?",
       initialValue: false,
@@ -175,17 +208,29 @@ program
       scope ? `(${scope.toString()})` : ``
     }${isBreaking ? "!" : ""}: ${message.toString()}${
       resolvesIssue ? ` (${issue?.toString()})` : ``
-    }${body ? `\n\n${body}` : ``}`;
+    }${body ? `\n\n${body}` : ``}${footer ? `\n\n${footer}` : ``}`;
 
     if (stageAll) {
-      await simpleGit().add(".").commit(commitMessage);
+      await simpleGit()
+        .add(".")
+        .commit(
+          commitMessage,
+          sign ? (amend ? ["-S", "--amend"] : ["-S"]) : amend ? ["--amend"] : []
+        );
     } else {
-      await simpleGit().commit(commitMessage);
+      await simpleGit().commit(
+        commitMessage,
+        sign ? (amend ? ["-S", "--amend"] : ["-S"]) : amend ? ["--amend"] : []
+      );
     }
 
     note(commitMessage);
 
-    outro("Finished creating a conventional commit, feel free to push");
+    outro(
+      `Finished ${
+        amend ? "amending" : "creating"
+      } a conventional commit, feel free to push`
+    );
   });
 
 program
@@ -208,6 +253,7 @@ program
     let parsedCommitStacks: Array<CommitStack> = [];
 
     console.log("# Changelog");
+    console.log("Generation of this changelog is based on commits");
 
     for (const commit of commits) {
       const tag = semver.sort(
@@ -296,7 +342,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${"`"}${shortHash}${"`"}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
               type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
@@ -316,7 +362,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${"`"}${shortHash}${"`"}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
               type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
@@ -336,7 +382,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${"`"}${shortHash}${"`"}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
               type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
@@ -356,7 +402,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${"`"}${shortHash}${"`"}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
               type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
@@ -371,7 +417,9 @@ program
     "Changes package.json version and creates a new commit with a tag"
   )
   .argument("<version>", "new version formatted in SemVer")
-  .action(async (string: string) => {
+  .option("-S, --sign", "sign the release commit and tag")
+  .action(async (string: string, options) => {
+    const sign = options.sign ? true : false;
     const version = string.replace("v", "");
     const packageFile = JSON.parse(
       (
@@ -391,8 +439,51 @@ program
 
     await simpleGit()
       .add(".")
-      .commit(`chore(release): v${version}`)
-      .addTag(`v${version}`);
+      .commit(`chore(release): v${version}`, sign ? ["-S"] : [])
+      .tag(
+        sign
+          ? [`-s`, `v${version}`, `-m`, `"Version ${version}"`]
+          : [`-a`, `v${version}`, `-m`, `"Version ${version}"`]
+      );
+  });
+
+program
+  .command("validate")
+  .description("Validate whether a string fits given commit conventions")
+  .argument("[message]", "string for validation")
+  .option("-C, --code-only", "return code only")
+  .action(async (string: string, options) => {
+    try {
+      const message = string || fs.readFileSync(0, "utf-8");
+      const codeOnly = options.codeOnly ? true : false;
+
+      const config = await GetConfig();
+
+      // Regex for testing:
+      // /(build|feat|docs)(\((commands|changelog)\))?!?: .* ?(\(..*\))?((\n\n..*)?(\n\n..*)?)?/gm
+
+      const testRegex = new RegExp(
+        `(${
+          config?.types?.map((type) => type.value).join("|") ||
+          "feat|fix|build|ci|docs|perf|refactor|chore"
+        })(\\((${
+          config?.scopes ? [...config?.scopes, "release"] : "..*"
+        })\\))?!?: .* ?(\\(..*\\))?((\n\n..*)?(\n\n..*)?)?`,
+        "gm"
+      );
+
+      if (codeOnly) {
+        console.log(testRegex.test(message) ? 0 : 1);
+      } else {
+        console.log(
+          testRegex.test(message)
+            ? "[rcz]: valid message"
+            : "[rcz]: invalid message"
+        );
+      }
+    } catch (err) {
+      console.log("[rcz]: no stdin found");
+    }
   });
 
 program.parse();