chore(release): v1.7.0

Reviewed-on: technology/rcz#9

.rczrc

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

.rczrc.json

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

.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

@@ -0,0 +1,117 @@
+# Changelog
+
+Generation of this changelog is based on commits
+
+## v1.7.0
+
+### Features
+
+- [f4a7a0d2b] - **commands**: add release script customizability (#12)
+- [c80d76325] - **config**: add auto-signing options
+- [498c830e3] - change tag message schema (#11)
+
+## v1.6.0
+
+### Features
+
+- [a5626dbc5] - improve default 'stage all changes' behavior
+
+### Miscellaneous
+
+- [4c892e8b1] - **changelog**: generate for v1.5.2
+
+## v1.5.2
+
+### Fixes
+
+- [8cb67f2cf] - **commands**: incorrect regex generation with specified scopes
+
+## v1.5.1
+
+### Fixes
+
+- [6c663cf7f] - **commands**: allow chore type in validation regex
+
+## 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
 {
@@ -33,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.0.0",
+  "version": "1.7.0",
   "description": "Resultium commit standardization library, based on conventional commits",
   "main": "./dist/index.js",
   "bin": {
@@ -28,10 +28,12 @@
   "dependencies": {
     "@clack/prompts": "^0.7.0",
     "commander": "^11.0.0",
+    "semver": "^7.5.4",
     "simple-git": "^3.19.1"
   },
   "devDependencies": {
     "@types/node": "^20.5.1",
+    "@types/semver": "^7.5.0",
     "typescript": "^5.1.6"
   }
 }

pnpm-lock.yaml

@@ -11,6 +11,9 @@ dependencies:
   commander:
     specifier: ^11.0.0
     version: 11.0.0
+  semver:
+    specifier: ^7.5.4
+    version: 7.5.4
   simple-git:
     specifier: ^3.19.1
     version: 3.19.1
@@ -19,6 +22,9 @@ devDependencies:
   '@types/node':
     specifier: ^20.5.1
     version: 20.5.1
+  '@types/semver':
+    specifier: ^7.5.0
+    version: 7.5.0
   typescript:
     specifier: ^5.1.6
     version: 5.1.6
@@ -58,6 +64,10 @@ packages:
     resolution: {integrity: sha512-4tT2UrL5LBqDwoed9wZ6N3umC4Yhz3W3FloMmiiG4JwmUJWpie0c7lcnUNd4gtMKuDEO4wRVS8B6Xa0uMRsMKg==}
     dev: true
 
+  /@types/semver@7.5.0:
+    resolution: {integrity: sha512-G8hZ6XJiHnuhQKR7ZmysCeJWE08o8T0AXtk5darsCaTVsYZhhgUrq53jizaR2FvsoeCwJhlmwTjkXBY5Pn/ZHw==}
+    dev: true
+
   /commander@11.0.0:
     resolution: {integrity: sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==}
     engines: {node: '>=16'}
@@ -75,6 +85,13 @@ packages:
       ms: 2.1.2
     dev: false
 
+  /lru-cache@6.0.0:
+    resolution: {integrity: sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA==}
+    engines: {node: '>=10'}
+    dependencies:
+      yallist: 4.0.0
+    dev: false
+
   /ms@2.1.2:
     resolution: {integrity: sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==}
     dev: false
@@ -83,6 +100,14 @@ packages:
     resolution: {integrity: sha512-1fygroTLlHu66zi26VoTDv8yRgm0Fccecssto+MhsZ0D/DGW2sm8E8AjW7NU5VVTRt5GxbeZ5qBuJr+HyLYkjQ==}
     dev: false
 
+  /semver@7.5.4:
+    resolution: {integrity: sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA==}
+    engines: {node: '>=10'}
+    hasBin: true
+    dependencies:
+      lru-cache: 6.0.0
+    dev: false
+
   /simple-git@3.19.1:
     resolution: {integrity: sha512-Ck+rcjVaE1HotraRAS8u/+xgTvToTuoMkT9/l9lvuP5jftwnYUp6DwuJzsKErHgfyRk8IB8pqGHWEbM3tLgV1w==}
     dependencies:
@@ -102,3 +127,7 @@ packages:
     engines: {node: '>=14.17'}
     hasBin: true
     dev: true
+
+  /yallist@4.0.0:
+    resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==}
+    dev: false

src/index.ts

@@ -12,9 +12,10 @@ import {
 } from "@clack/prompts";
 import fs from "fs";
 import path from "path";
-import { Config } from "./types";
+import { CommitStack, Config } from "./types";
 import simpleGit from "simple-git";
 import { Command } from "commander";
+import semver from "semver";
 
 const GetConfig = async () => {
   if (fs.existsSync(path.join(process.cwd(), ".rczrc"))) {
@@ -23,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;
   }
@@ -32,14 +45,19 @@ const program = new Command();
 program
   .name("rcz")
   .description("Resultium commit standardization command-line interface")
-  .version("1.0.0");
+  .version("1.7.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 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"))) {
@@ -47,10 +65,14 @@ 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: (await simpleGit().diff(["--cached"])).toString()
+            ? false
+            : true,
+        });
 
     if (isCancel(stageAll)) {
       cancel("Commit creation cancelled");
@@ -95,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",
+        },
       ],
     });
 
@@ -141,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,
@@ -174,17 +210,301 @@ 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
+  .command("changelog")
+  .description("Outputs a markdown formatted changelog")
+  .option("--show-hashes", "show first 9 characters of commit hashes")
+  .option("--last-only", "display only latest release changes")
+  .action(async (options) => {
+    const showHashes = options.showHashes ? true : false;
+    const lastOnly = options.lastOnly ? true : false;
+
+    if ((await simpleGit().tags()).all.length === 0) {
+      return console.log(
+        "[rcz]: not even one release has yet been made, cannot make a changelog"
+      );
+    }
+
+    const commits = (await simpleGit().log()).all;
+    let lastTag = "";
+    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(
+        (await simpleGit().tags([`--contains=${commit.hash}`])).all
+      )[0]!;
+      const currentCommitStack = parsedCommitStacks.find(
+        (commitStack) => commitStack.version === tag
+      ) || {
+        version: tag || "",
+        breaking: [],
+        features: [],
+        fixes: [],
+        miscellaneous: [],
+      };
+
+      if (lastTag !== tag) {
+        parsedCommitStacks = [currentCommitStack, ...parsedCommitStacks];
+      }
+
+      if (commit.message.includes("!:")) {
+        parsedCommitStacks = [
+          {
+            ...currentCommitStack,
+            breaking: [...currentCommitStack.breaking, commit],
+          },
+          ...parsedCommitStacks.filter(
+            (commitStack) => commitStack.version !== tag
+          ),
+        ];
+      } else if (commit.message.startsWith("feat")) {
+        parsedCommitStacks = [
+          {
+            ...currentCommitStack,
+            features: [...currentCommitStack.features, commit],
+          },
+          ...parsedCommitStacks.filter(
+            (commitStack) => commitStack.version !== tag
+          ),
+        ];
+      } else if (commit.message.startsWith("fix")) {
+        parsedCommitStacks = [
+          {
+            ...currentCommitStack,
+            fixes: [...currentCommitStack.fixes, commit],
+          },
+          ...parsedCommitStacks.filter(
+            (commitStack) => commitStack.version !== tag
+          ),
+        ];
+      } else {
+        parsedCommitStacks = [
+          {
+            ...currentCommitStack,
+            miscellaneous: [...currentCommitStack.miscellaneous, commit],
+          },
+          ...parsedCommitStacks.filter(
+            (commitStack) => commitStack.version !== tag
+          ),
+        ];
+      }
+
+      lastTag = tag;
+    }
+
+    parsedCommitStacks = parsedCommitStacks.reverse();
+
+    if (lastOnly) {
+      parsedCommitStacks = [parsedCommitStacks[0]];
+    }
+
+    for (const commitStack of parsedCommitStacks) {
+      console.log(`## ${commitStack.version}`);
+
+      if (commitStack.breaking.length > 0) {
+        console.log(`### Breaking`);
+        for (const commit of commitStack.breaking) {
+          const shortHash = commit.hash.slice(0, 9);
+
+          // Selects contents between parenthesis and a semicolon, via https://stackoverflow.com/a/17779833/14544732
+          const type = /\(([^)]+)\):/.exec(commit.message)
+            ? /\(([^)]+)\):/.exec(commit.message)![1]
+            : null;
+          const firstMessageLine = commit.message.split("\n");
+          const briefMessage = firstMessageLine[0].includes(":")
+            ? firstMessageLine[0].split(":")[1].trim()
+            : firstMessageLine[0];
+
+          console.log(
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
+              type ? `**${type}**: ${briefMessage}` : briefMessage
+            }`
+          );
+        }
+      }
+
+      if (commitStack.features.length > 0) {
+        console.log(`### Features`);
+        for (const commit of commitStack.features) {
+          const shortHash = commit.hash.slice(0, 9);
+          const type = /\(([^)]+)\):/.exec(commit.message)
+            ? /\(([^)]+)\):/.exec(commit.message)![1]
+            : null;
+          const firstMessageLine = commit.message.split("\n");
+          const briefMessage = firstMessageLine[0].includes(":")
+            ? firstMessageLine[0].split(":")[1].trim()
+            : firstMessageLine[0];
+
+          console.log(
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
+              type ? `**${type}**: ${briefMessage}` : briefMessage
+            }`
+          );
+        }
+      }
+
+      if (commitStack.fixes.length > 0) {
+        console.log(`### Fixes`);
+        for (const commit of commitStack.fixes) {
+          const shortHash = commit.hash.slice(0, 9);
+          const type = /\(([^)]+)\):/.exec(commit.message)
+            ? /\(([^)]+)\):/.exec(commit.message)![1]
+            : null;
+          const firstMessageLine = commit.message.split("\n");
+          const briefMessage = firstMessageLine[0].includes(":")
+            ? firstMessageLine[0].split(":")[1].trim()
+            : firstMessageLine[0];
+
+          console.log(
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
+              type ? `**${type}**: ${briefMessage}` : briefMessage
+            }`
+          );
+        }
+      }
+
+      if (commitStack.miscellaneous.length > 0) {
+        console.log(`### Miscellaneous`);
+        for (const commit of commitStack.miscellaneous) {
+          const shortHash = commit.hash.slice(0, 9);
+          const type = /\(([^)]+)\):/.exec(commit.message)
+            ? /\(([^)]+)\):/.exec(commit.message)![1]
+            : null;
+          const firstMessageLine = commit.message.split("\n");
+          const briefMessage = firstMessageLine[0].includes(":")
+            ? firstMessageLine[0].split(":")[1].trim()
+            : firstMessageLine[0];
+
+          console.log(
+            `${showHashes ? `- [${shortHash}]` : ``} - ${
+              type ? `**${type}**: ${briefMessage}` : briefMessage
+            }`
+          );
+        }
+      }
+    }
+  });
+
+program
+  .command("release")
+  .description(
+    "Changes package.json version and creates a new commit with a tag"
+  )
+  .argument("<version>", "new version formatted in SemVer")
+  .option("-S, --sign", "sign the release commit and tag")
+  .action(async (string: string, options) => {
+    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"))
+        ).toString()
+      );
+
+      if (!packageFile) {
+        console.log("[rcz]: this directory does not have a package.json file");
+      }
+
+      packageFile.version = version;
+      await fs.promises.writeFile(
+        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`, `"v${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

@@ -1,6 +1,10 @@
+import { DefaultLogFields, ListLogLine } from "simple-git";
+
 export interface Config {
   types?: Array<Type>;
   scopes?: Array<string>;
+  autoSignCommits?: boolean;
+  autoSignReleases?: boolean;
 }
 
 export interface Type {
@@ -8,3 +12,11 @@ export interface Type {
   value: string;
   hint: string;
 }
+
+export interface CommitStack {
+  version: string;
+  breaking: Array<DefaultLogFields & ListLogLine>;
+  features: Array<DefaultLogFields & ListLogLine>;
+  fixes: Array<DefaultLogFields & ListLogLine>;
+  miscellaneous: Array<DefaultLogFields & ListLogLine>;
+}