chore(release): v1.8.0

Reviewed-on: technology/rcz#9

.rczrc

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

.rczrc.json

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

.rczrc.onrelease.js

@@ -0,0 +1,17 @@
+const fs = require("fs");
+
+const packageFile = fs.readFileSync("./package.json").toString();
+const newPackageFile = packageFile.replace(
+  /"version": "[0-9]+.[0-9]+.[0-9]+"/,
+  `"version": "${__NEW_VERSION__}"`
+);
+
+fs.writeFileSync("./package.json", newPackageFile);
+
+const indexFile = fs.readFileSync("./src/index.ts").toString();
+const newIndexFile = indexFile.replace(
+  /version\("[0-9]+\.[0-9]+\.[0-9]+"\)/,
+  `version("${__NEW_VERSION__}")`
+);
+
+fs.writeFileSync("./src/index.ts", newIndexFile);

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "cSpell.words": [
+    "Acked",
+    "johndoe",
+    "onrelease",
+    "outro",
+    "rczrc",
+    "Resultium"
+  ]
+}

CHANGELOG.md

@@ -1,57 +1,98 @@
 # Changelog
-
 Generation of this changelog is based on commits
-
+## v1.8.0
+### Features
+- [1e8bfd04d] - **commands**: add option to change unreleased change title
+### Fixes
+- [8e460614f] - **commands**: have unreleased section for changelog
+## v1.7.0
+### Features
+- [f4a7a0d2b] - **commands**: add release script customizability (#12)
+- [c80d76325] - **config**: add auto-signing options
+- [498c830e3] - change tag message schema (#11)
+### Miscellaneous
+- [d1099c1e6] - **release**: v1.7.0
+## v1.6.0
+### Features
+- [a5626dbc5] - improve default 'stage all changes' behavior
+### Miscellaneous
+- [f51bb88de] - **release**: v1.6.0
+- [4c892e8b1] - **changelog**: generate for v1.5.2
+## v1.5.2
+### Fixes
+- [8cb67f2cf] - **commands**: incorrect regex generation with specified scopes
+### Miscellaneous
+- [63a6c9fea] - **release**: v1.5.2
+- [8dbe266e3] - Merge pull request 'Allow chore type in validation regex' (#9) from develop into main
+- [58f4dde9c] - **changelog**: generate for v1.5.1
+## v1.5.1
+### Fixes
+- [6c663cf7f] - **commands**: allow chore type in validation regex
+### Miscellaneous
+- [9586a567d] - **release**: v1.5.1
+- [535a62857] - **changelog**: generate for v1.5.0
+- [03f68e291] - Merge pull request 'Release v1.5.0' (#8) from develop into main
+## 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)
+### Miscellaneous
+- [71925553c] - **release**: v1.5.0
+- [56ad837b8] - Merge pull request 'Add the ability to return only the code of validation command' (#6) from develop into main
+- [003c943a7] - **changelog**: generate for v1.4.0
+## v1.4.0
+### Features
+- [8ab631549] - **commands**: add the ability to return code only for validation
+### Miscellaneous
+- [77dfc9a73] - **release**: v1.4.0
+- [2670f79e2] - Merge pull request 'Release v1.3.0' (#5) from develop into main
+- [3afc2ed07] - Merge branch 'main' into develop
+- [45458d14e] - **changelog**: generate for v1.3.0
+- [d61c9ecf2] - Merge pull request 'Make commit signing possible' (#3) from develop into main
+## v1.3.0
+### Features
+- [755da3bb5] - **commands**: add ability to write a footer
+- [9311be80b] - **commands**: add commit message validation command (#4)
+### Miscellaneous
+- [f3c55fac3] - **release**: v1.3.0
+- [8816db86f] - **changelog**: generate
+## v1.2.0
+### Features
+- [46a52ddeb] - **commands**: add the ability to sign conventional commits (#2)
+### Miscellaneous
+- [c69db8f4b] - **release**: v1.2.0
+- [37a1d0b25] - **changelog**: regenerate to have hashes reference
+- [2ac0307c8] - **changelog**: generate
 ## v1.1.3
-
 ### Fixes
-
 - [d3cf78aac] - **commands**: incorrect formatting of changelog hashes
-
+### Miscellaneous
+- [66db26931] - **release**: v1.1.3
+- [605055eb7] - **changelog**: generate
 ## v1.1.2
-
 ### Miscellaneous
-
+- [e4ba7dab5] - **release**: v1.1.2
 - [85649a71a] - **commands**: change changelog output text
-
+- [d30071e3d] - **changelog**: generate changelog
 ## v1.1.1
-
-### Fixes
-
-- [7a5880d21] - **commands**: incorrect changelog version generation
-
-## v1.1.0
-
 ### Features
-
 - [8e5158726] - **commands**: add release and changelog commands
-
+### Fixes
+- [7a5880d21] - **commands**: incorrect changelog version generation
 ### Miscellaneous
-
+- [06f349c75] - **release**: v1.1.1
 - [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
-
+- [b07d9aaaa] - change question formatting, improve readme
 - [4e16104d6] - change intro and outro messages

README.md

@@ -23,7 +23,7 @@ Resultium commit standardization library
 
 ## 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
 {
@@ -34,6 +34,31 @@ You can create an `.rczrc` file in your root directory and specify available sco
       "value": "chore",
       "hint": "a routine action"
     }
-  ]
+  ],
+  "autoSignCommits": false,
+  "autoSignReleases": true
 }
 ```
+
+You are also able to create an onRelease event file, that is going to run before creation of a git tag and a release commit, when `rcz release` is run. The file is to be named `.rczrc.onrelease.js`. A sample can be seen below.
+
+```js
+const fs = require("fs"); // Require fileSystem
+
+const packageFile = fs.readFileSync("./package.json").toString(); // Get package.json contents from the current working directory
+const newPackageFile = packageFile.replace(
+  /"version": "[0-9]+.[0-9]+.[0-9]+"/,
+  `"version": "${__NEW_VERSION__}"`
+); // Use RegExp to replace package.json version
+
+fs.writeFileSync("./package.json", newPackageFile); // Write to package.json file its new content
+
+const indexFile = fs.readFileSync("./src/index.ts").toString(); // Get index.ts file from source code directory
+const newIndexFile = indexFile.replace(/version\("[0-9]+\.[0-9]+\.[0-9]+"\)/); // Replace class function call content with the new version
+
+fs.writeFileSync("./src/index.ts", newIndexFile); // Write to source code index file
+```
+
+In your onRelease file you are provided with `__NEW_VERSION__` constant string which is the new version submitted in `rcz release` and `__IS_SIGNED__` constant which is a boolean telling whether the release (it's commit and tag) is going to be signed.
+
+Bear in mind, **this script is going to be executed through `eval()` with no sanitation**, be careful with whatever you write.

cspell.json

@@ -1,12 +0,0 @@
-{
-  "version": "0.2",
-  "ignorePaths": [],
-  "dictionaryDefinitions": [],
-  "dictionaries": [],
-  "words": [
-    "outro",
-    "rczrc"
-  ],
-  "ignoreWords": [],
-  "import": []
-}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@resultium/rcz",
-    "version": "1.2.0",
+  "version": "1.8.0",
   "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,17 +45,19 @@ const program = new Command();
 program
   .name("rcz")
   .description("Resultium commit standardization command-line interface")
-  .version("1.0.0");
+  .version("1.8.0");
 
 program
   .command("commit")
   .description("Create a conventional commit")
   .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 config = await GetConfig();
 
+    const sign = config?.autoSignCommits || options.sign ? true : false;
+    const amend = options.amend ? true : false;
+
     intro("Creating a conventional commit");
 
     if (!fs.existsSync(path.join(process.cwd(), ".git"))) {
@@ -51,9 +65,13 @@ program
       process.exit(0);
     }
 
-    const stageAll = await confirm({
+    const stageAll = amend
+      ? null
+      : await confirm({
           message: "Stage all changes?",
-      initialValue: true,
+          initialValue: (await simpleGit().diff(["--cached"])).toString()
+            ? false
+            : true,
         });
 
     if (isCancel(stageAll)) {
@@ -99,6 +117,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",
+        },
       ],
     });
 
@@ -145,6 +168,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,
@@ -178,19 +210,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, sign ? ["-S"] : []);
+        .commit(
+          commitMessage,
+          sign ? (amend ? ["-S", "--amend"] : ["-S"]) : amend ? ["--amend"] : []
+        );
     } else {
-      await simpleGit().commit(commitMessage, sign ? ["-S"] : []);
+      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
@@ -198,9 +240,14 @@ program
   .description("Outputs a markdown formatted changelog")
   .option("--show-hashes", "show first 9 characters of commit hashes")
   .option("--last-only", "display only latest release changes")
+  .option(
+    "--unreleased-as <version>",
+    "show unreleased changes as different version"
+  )
   .action(async (options) => {
     const showHashes = options.showHashes ? true : false;
     const lastOnly = options.lastOnly ? true : false;
+    const unreleased = options.unreleasedAs || "Unreleased";
 
     if ((await simpleGit().tags()).all.length === 0) {
       return console.log(
@@ -216,13 +263,15 @@ program
     console.log("Generation of this changelog is based on commits");
 
     for (const commit of commits) {
-      const tag = semver.sort(
+      const tag =
+        semver.sort(
           (await simpleGit().tags([`--contains=${commit.hash}`])).all
-      )[0]!;
+        )[0]! || unreleased;
+
       const currentCommitStack = parsedCommitStacks.find(
         (commitStack) => commitStack.version === tag
       ) || {
-        version: tag || "",
+        version: tag || unreleased,
         breaking: [],
         features: [],
         fixes: [],
@@ -379,8 +428,26 @@ program
   .argument("<version>", "new version formatted in SemVer")
   .option("-S, --sign", "sign the release commit and tag")
   .action(async (string: string, options) => {
-    const sign = options.sign ? true : false;
+    const config = await GetConfig();
+
+    const sign = config?.autoSignReleases || options.sign ? true : false;
     const version = string.replace("v", "");
+
+    const onReleaseFile = (
+      await fs.promises.readFile(
+        path.join(process.cwd(), ".rczrc.onrelease.js")
+      )
+    ).toString();
+
+    if (onReleaseFile) {
+      const releaseScript = `
+        const __NEW_VERSION__ = "${version}";
+        const __IS_SIGNED__ = ${sign};
+
+        ${onReleaseFile}`;
+
+      eval(releaseScript);
+    } else {
       const packageFile = JSON.parse(
         (
           await fs.promises.readFile(path.join(process.cwd(), "package.json"))
@@ -396,15 +463,55 @@ program
         path.join(process.cwd(), "package.json"),
         JSON.stringify(packageFile, null, 4)
       );
+    }
 
     await simpleGit()
       .add(".")
       .commit(`chore(release): v${version}`, sign ? ["-S"] : [])
       .tag(
         sign
-          ? [`-s`, `v${version}`, `-m`, `"Version ${version}"`]
+          ? [`-s`, `v${version}`, `-m`, `"v${version}"`]
-          : [`-a`, `v${version}`, `-m`, `"Version ${version}"`]
+          : [`-a`, `v${version}`, `-m`, `"v${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"].join("|") : "..*"
+        })\\))?!?: .* ?(\\(..*\\))?((\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();

src/types.ts

@@ -3,6 +3,8 @@ import { DefaultLogFields, ListLogLine } from "simple-git";
 export interface Config {
   types?: Array<Type>;
   scopes?: Array<string>;
+  autoSignCommits?: boolean;
+  autoSignReleases?: boolean;
 }
 
 export interface Type {