chore(release): v1.11.0

Reviewed-on: technology/rcz#9

.rcz/config.json

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

.rcz/onrelease.js

@@ -0,0 +1,22 @@
+const fs = require("fs");
+const { execSync } = require("child_process");
+
+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);
+
+execSync(
+  `rcz changelog --show-hashes --unreleased-as v${__NEW_VERSION__} > CHANGELOG.md`
+);

.rcz/postrelease.js

@@ -0,0 +1,7 @@
+const { execSync } = require("child_process");
+
+execSync(`git push -u origin main --tags`);
+
+execSync(`pnpm run build`);
+
+execSync(`pnpm publish`);

.rczrc.json

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

.vscode/settings.json

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

CHANGELOG.md

@@ -1,87 +1,122 @@
 # Changelog
-
 Generation of this changelog is based on commits
-
+## v1.11.0
-## v1.5.0
+### Features
-
+- [30a7e0b28] - **commands**: add --sudo option to commit command (#16)
+## v1.10.1
+### Fixes
+- [782894dae] - **commands**: failure to cancel commit creation
+### Miscellaneous
+- [ebfa3859f] - **release**: v1.10.1
+## v1.10.0
+### Features
+- [d707aaffe] - **config**: allow RCZ configs to be located in a folder (#15)
+- [4de93ef3e] - **commands**: check for updates upon commit creation (#13)
+- [83d655931] - **commands**: warn on >250 line commits, improve text (#13)
+- [f371102a8] - **commands**: add aliases to main commands
+### Miscellaneous
+- [399f65dab] - **release**: v1.10.0
+- [28e1caf28] - push to main post release
+## v1.9.0
+### Features
+- [4c60f62e7] - **config**: add post-release event file
+### Miscellaneous
+- [7963d78e5] - **release**: v1.9.0
+## v1.8.0
+### Features
+- [1e8bfd04d] - **commands**: add option to change unreleased change title
+### Fixes
+- [8e460614f] - **commands**: have unreleased section for changelog
+### Miscellaneous
+- [357036d02] - **release**: v1.8.0
+## 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
-- [8ab631549] - **commands**: add the ability to return code only for validation command
+### 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

@@ -34,6 +34,37 @@ You can create an `.rczrc`, `.rczrc.json` or `rcz.config.json` file in your root
       "value": "chore",
       "hint": "a routine action"
     }
-  ]
+  ],
+  "autoSignCommits": false,
+  "autoSignReleases": true
 }
 ```
+
+### On-release event
+
+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.
+
+### Post-release event
+
+Same as for onRelease you can also create a postRelease file which gets run after the tag and commit get created. Same as for onRelease file you are provided with `__NEW_VERSION__` and `__IS_SIGNED__`

cspell.json

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

package.json

@@ -1,39 +1,39 @@
 {
-    "name": "@resultium/rcz",
+  "name": "@resultium/rcz",
-    "version": "1.5.1",
+  "version": "1.11.0",
-    "description": "Resultium commit standardization library, based on conventional commits",
+  "description": "Resultium commit standardization library, based on conventional commits",
-    "main": "./dist/index.js",
+  "main": "./dist/index.js",
-    "bin": {
+  "bin": {
-        "rcz": "./dist/index.js"
+    "rcz": "./dist/index.js"
-    },
+  },
-    "files": [
+  "files": [
-        "dist"
+    "dist"
-    ],
+  ],
-    "scripts": {
+  "scripts": {
-        "build": "tsc"
+    "build": "tsc"
-    },
+  },
-    "repository": {
+  "repository": {
-        "type": "git",
+    "type": "git",
-        "url": "https://git.resultium.net/technology/rcz.git"
+    "url": "https://git.resultium.net/technology/rcz.git"
-    },
+  },
-    "keywords": [
+  "keywords": [
-        "conventional",
+    "conventional",
-        "commits"
+    "commits"
-    ],
+  ],
-    "author": {
+  "author": {
-        "name": "Resultium",
+    "name": "Resultium",
-        "email": "contact@resultium.io",
+    "email": "contact@resultium.io",
-        "url": "https://www.resultium.io"
+    "url": "https://www.resultium.io"
-    },
+  },
-    "dependencies": {
+  "dependencies": {
-        "@clack/prompts": "^0.7.0",
+    "@clack/prompts": "^0.7.0",
-        "commander": "^11.0.0",
+    "commander": "^11.1.0",
-        "semver": "^7.5.4",
+    "semver": "^7.5.4",
-        "simple-git": "^3.19.1"
+    "simple-git": "^3.21.0"
-    },
+  },
-    "devDependencies": {
+  "devDependencies": {
-        "@types/node": "^20.5.1",
+    "@types/node": "^20.10.4",
-        "@types/semver": "^7.5.0",
+    "@types/semver": "^7.5.6",
-        "typescript": "^5.1.6"
+    "typescript": "^5.3.3"
-    }
+  }
-}
+}

pnpm-lock.yaml

@@ -9,25 +9,25 @@ dependencies:
     specifier: ^0.7.0
     version: 0.7.0
   commander:
-    specifier: ^11.0.0
+    specifier: ^11.1.0
-    version: 11.0.0
+    version: 11.1.0
   semver:
     specifier: ^7.5.4
     version: 7.5.4
   simple-git:
-    specifier: ^3.19.1
+    specifier: ^3.21.0
-    version: 3.19.1
+    version: 3.21.0
 
 devDependencies:
   '@types/node':
-    specifier: ^20.5.1
+    specifier: ^20.10.4
-    version: 20.5.1
+    version: 20.10.4
   '@types/semver':
-    specifier: ^7.5.0
+    specifier: ^7.5.6
-    version: 7.5.0
+    version: 7.5.6
   typescript:
-    specifier: ^5.1.6
+    specifier: ^5.3.3
-    version: 5.1.6
+    version: 5.3.3
 
 packages:
 
@@ -60,16 +60,18 @@ packages:
     resolution: {integrity: sha512-GaHYm+c0O9MjZRu0ongGBRbinu8gVAMd2UZjji6jVmqKtZluZnptXGWhz1E8j8D2HJ3f/yMxKAUC0b+57wncIw==}
     dev: false
 
-  /@types/node@20.5.1:
+  /@types/node@20.10.4:
-    resolution: {integrity: sha512-4tT2UrL5LBqDwoed9wZ6N3umC4Yhz3W3FloMmiiG4JwmUJWpie0c7lcnUNd4gtMKuDEO4wRVS8B6Xa0uMRsMKg==}
+    resolution: {integrity: sha512-D08YG6rr8X90YB56tSIuBaddy/UXAA9RKJoFvrsnogAum/0pmjkgi4+2nx96A330FmioegBWmEYQ+syqCFaveg==}
+    dependencies:
+      undici-types: 5.26.5
     dev: true
 
-  /@types/semver@7.5.0:
+  /@types/semver@7.5.6:
-    resolution: {integrity: sha512-G8hZ6XJiHnuhQKR7ZmysCeJWE08o8T0AXtk5darsCaTVsYZhhgUrq53jizaR2FvsoeCwJhlmwTjkXBY5Pn/ZHw==}
+    resolution: {integrity: sha512-dn1l8LaMea/IjDoHNd9J52uBbInB796CDffS6VdIxvqYCPSG0V0DzHp76GpaWnlhg88uYyPbXCDIowa86ybd5A==}
     dev: true
 
-  /commander@11.0.0:
+  /commander@11.1.0:
-    resolution: {integrity: sha512-9HMlXtt/BNoYr8ooyjjNRdIilOTkVJXB+GhxMTtOKwk0R4j4lS4NpjuqmRxroBfnfTSHQIHQB7wryHhXarNjmQ==}
+    resolution: {integrity: sha512-yPVavfyCcRhmorC7rWlkHn15b4wDVgVmBA7kV4QVBsF7kv/9TKJAbAXVTxvTnwP8HHKjRCJDClKbciiYS7p0DQ==}
     engines: {node: '>=16'}
     dev: false
 
@@ -108,8 +110,8 @@ packages:
       lru-cache: 6.0.0
     dev: false
 
-  /simple-git@3.19.1:
+  /simple-git@3.21.0:
-    resolution: {integrity: sha512-Ck+rcjVaE1HotraRAS8u/+xgTvToTuoMkT9/l9lvuP5jftwnYUp6DwuJzsKErHgfyRk8IB8pqGHWEbM3tLgV1w==}
+    resolution: {integrity: sha512-oTzw9248AF5bDTMk9MrxsRzEzivMlY+DWH0yWS4VYpMhNLhDWnN06pCtaUyPnqv/FpsdeNmRqmZugMABHRPdDA==}
     dependencies:
       '@kwsites/file-exists': 1.1.1
       '@kwsites/promise-deferred': 1.1.1
@@ -122,12 +124,16 @@ packages:
     resolution: {integrity: sha512-bLGGlR1QxBcynn2d5YmDX4MGjlZvy2MRBDRNHLJ8VI6l6+9FUiyTFNJ0IveOSP0bcXgVDPRcfGqA0pjaqUpfVg==}
     dev: false
 
-  /typescript@5.1.6:
+  /typescript@5.3.3:
-    resolution: {integrity: sha512-zaWCozRZ6DLEWAWFrVDz1H6FVXzUSfTy5FUMWsQlU8Ym5JP9eO4xkTIROFCQvhQf61z6O/G6ugw3SgAnvvm+HA==}
+    resolution: {integrity: sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==}
     engines: {node: '>=14.17'}
     hasBin: true
     dev: true
 
+  /undici-types@5.26.5:
+    resolution: {integrity: sha512-JlCMO+ehdEIKqlFxk6IfVoAUVmgz7cU7zD/h9XZ0qzeosSHmUJVOzSQvvYSYWXkFXC+IfLKSIffhv0sVZup6pA==}
+    dev: true
+
   /yallist@4.0.0:
     resolution: {integrity: sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A==}
     dev: false

src/index.ts

@@ -16,6 +16,8 @@ import { CommitStack, Config } from "./types";
 import simpleGit from "simple-git";
 import { Command } from "commander";
 import semver from "semver";
+import { execSync } from "child_process";
+import { tmpdir } from "os";
 
 const GetConfig = async () => {
   if (fs.existsSync(path.join(process.cwd(), ".rczrc"))) {
@@ -36,28 +38,109 @@ const GetConfig = async () => {
         await fs.promises.readFile(path.join(process.cwd(), "rcz.config.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;
   }
 };
+
+const GetOnReleaseScript = async () => {
+  if (fs.existsSync(path.join(process.cwd(), ".rcz.onrelease.js"))) {
+    return (
+      await fs.promises.readFile(path.join(process.cwd(), ".rcz.onrelease.js"))
+    ).toString();
+  } else if (fs.existsSync(path.join(process.cwd(), ".rcz", "onrelease.js"))) {
+    return (
+      await fs.promises.readFile(
+        path.join(process.cwd(), ".rcz", "onrelease.js")
+      )
+    ).toString();
+  } else {
+    return null;
+  }
+};
+
+const GetPostReleaseScript = async () => {
+  if (fs.existsSync(path.join(process.cwd(), ".rcz.postrelease.js"))) {
+    return (
+      await fs.promises.readFile(
+        path.join(process.cwd(), ".rcz.postrelease.js")
+      )
+    ).toString();
+  } else if (
+    fs.existsSync(path.join(process.cwd(), ".rcz", "postrelease.js"))
+  ) {
+    return (
+      await fs.promises.readFile(
+        path.join(process.cwd(), ".rcz", "postrelease.js")
+      )
+    ).toString();
+  } else {
+    return null;
+  }
+};
+
+const CheckForUpdates = async () => {
+  const updateText =
+    "You are running on an outdated version of Resultium Commitizen, in order to update run\n\nnpm install -g @resultium/rcz@latest";
+
+  const cachedVersion = fs.existsSync(path.join(tmpdir(), "rcz-server-version"))
+    ? (await fs.promises.readFile(path.join(tmpdir(), "rcz-server-version")))
+      .toString()
+      .trim()
+    : null;
+  const localVersion = execSync("rcz --version").toString().trim();
+
+  // even if cached once in a while it should get newest data
+  if ((cachedVersion && Math.random() < 0.1) || cachedVersion === null) {
+    const isOnline = (await fetch("https://icanhazip.com")).status === 200;
+    if (!isOnline) return;
+
+    const serverVersion = execSync("npm show @resultium/rcz version")
+      .toString()
+      .trim();
+
+    fs.promises.writeFile(
+      path.join(tmpdir(), "rcz-server-version"),
+      serverVersion
+    );
+
+    if (semver.gt(serverVersion, localVersion)) note(updateText);
+  } else if (cachedVersion) {
+    if (semver.gt(cachedVersion, localVersion)) note(updateText);
+  }
+};
+
 const program = new Command();
 
 program
   .name("rcz")
   .description("Resultium commit standardization command-line interface")
-  .version("1.4.0");
+  .version("1.11.0");
 
 program
   .command("commit")
+  .alias("c")
   .description("Create a conventional commit")
   .option("-S, --sign", "sign the commit")
   .option("--amend", "amend commit message to the last commit")
+  .option("--sudo", "remove any validation")
   .action(async (options) => {
-    const sign = options.sign ? true : false;
+    await CheckForUpdates();
-    const amend = options.amend ? true : false;
 
     const config = await GetConfig();
 
+    const sign = config?.autoSignCommits || options.sign ? true : false;
+    const amend = options.amend ? true : false;
+    const sudo = options.sudo ? true : false;
+
     intro("Creating a conventional commit");
 
     if (!fs.existsSync(path.join(process.cwd(), ".git"))) {
@@ -68,15 +151,41 @@ program
     const stageAll = amend
       ? null
       : await confirm({
-          message: "Stage all changes?",
+        message: "Stage all changes?",
-          initialValue: true,
+        initialValue: (await simpleGit().diff(["--cached"])).toString()
-        });
+          ? false
+          : true,
+      });
 
     if (isCancel(stageAll)) {
       cancel("Commit creation cancelled");
       process.exit(0);
     }
 
+    const changedLines = (
+      (
+        await simpleGit().diff(["--numstat", stageAll ? "HEAD" : "--cached"])
+      ).match(/\d+/gm) || []
+    ).reduce((partialSum, num) => partialSum + Number(num), 0);
+
+    if (changedLines > 250 && !sudo) {
+      const proceedCommitting = await confirm({
+        message:
+          "You are about to commit changes to more than 250 lines, are you sure you want to proceed?",
+        initialValue: false,
+      });
+
+      if (isCancel(proceedCommitting)) {
+        cancel("Commit creation cancelled");
+        process.exit(0);
+      }
+
+      if (!proceedCommitting) {
+        cancel("Cancelled, please split this commit into smaller ones");
+        process.exit(0);
+      }
+    }
+
     const type: string | symbol = await select({
       message: "Choose a commit type",
       options: config?.types || [
@@ -88,7 +197,7 @@ program
         {
           label: "fix",
           value: "fix",
-          hint: "bug fix",
+          hint: "functionality bug fix",
         },
         {
           label: "build",
@@ -129,12 +238,22 @@ program
     }
 
     const scope: string | symbol = await text({
-      message: "Input a scope (e.g. router, forms, core) or leave empty",
+      message:
+        "Input a scope (subsystem which change is relevant to e.g. router, forms, core) or leave empty",
+      placeholder: "router",
       validate: (value) => {
+        if (sudo) {
+          return
+        }
+
         if (config?.scopes && value) {
           if (!config?.scopes.includes(value))
             return "This scope is not allowed by local configuration";
         }
+
+        if (value.includes(" ")) {
+          return "Must not include a space";
+        }
       },
     });
 
@@ -145,7 +264,12 @@ program
 
     const message = await text({
       message: `Briefly describe made changes in imperative tense, maximum length 50`,
+      placeholder: "warn upon suspicious router requests",
       validate: (value) => {
+        if (sudo) {
+          return
+        }
+
         if (value.length > 50) {
           return "Your message is too long";
         }
@@ -158,7 +282,9 @@ program
     }
 
     const body = await text({
-      message: `Insert a commit body, recommended length 100, can be left empty`,
+      message: `Insert a commit body (motivation or elaboration for the change), can be left empty`,
+      placeholder:
+        "improves regex for suspicious character check in router requests",
     });
 
     if (isCancel(body)) {
@@ -168,6 +294,7 @@ program
 
     const footer = await text({
       message: `Insert commit footer, can be left empty, e.g. Acked-by: @johndoe`,
+      placeholder: "Acked-by: @security",
     });
 
     if (isCancel(footer)) {
@@ -204,11 +331,9 @@ program
       process.exit(0);
     }
 
-    const commitMessage = `${type.toString()}${
+    const commitMessage = `${type.toString()}${scope ? `(${scope.toString()})` : ``
-      scope ? `(${scope.toString()})` : ``
+      }${isBreaking ? "!" : ""}: ${message.toString()}${resolvesIssue ? ` (${issue?.toString()})` : ``
-    }${isBreaking ? "!" : ""}: ${message.toString()}${
+      }${body ? `\n\n${body}` : ``}${footer ? `\n\n${footer}` : ``}`;
-      resolvesIssue ? ` (${issue?.toString()})` : ``
-    }${body ? `\n\n${body}` : ``}${footer ? `\n\n${footer}` : ``}`;
 
     if (stageAll) {
       await simpleGit()
@@ -227,20 +352,25 @@ program
     note(commitMessage);
 
     outro(
-      `Finished ${
+      `Finished ${amend ? "amending" : "creating"
-        amend ? "amending" : "creating"
       } a conventional commit, feel free to push`
     );
   });
 
 program
   .command("changelog")
+  .alias("ch")
   .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(
@@ -256,13 +386,15 @@ program
     console.log("Generation of this changelog is based on commits");
 
     for (const commit of commits) {
-      const tag = semver.sort(
+      const tag =
-        (await simpleGit().tags([`--contains=${commit.hash}`])).all
+        semver.sort(
-      )[0]!;
+          (await simpleGit().tags([`--contains=${commit.hash}`])).all
+        )[0]! || unreleased;
+
       const currentCommitStack = parsedCommitStacks.find(
         (commitStack) => commitStack.version === tag
       ) || {
-        version: tag || "",
+        version: tag || unreleased,
         breaking: [],
         features: [],
         fixes: [],
@@ -342,8 +474,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${shortHash}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${type ? `**${type}**: ${briefMessage}` : briefMessage
-              type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
         }
@@ -362,8 +493,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${shortHash}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${type ? `**${type}**: ${briefMessage}` : briefMessage
-              type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
         }
@@ -382,8 +512,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${shortHash}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${type ? `**${type}**: ${briefMessage}` : briefMessage
-              type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
         }
@@ -402,8 +531,7 @@ program
             : firstMessageLine[0];
 
           console.log(
-            `${showHashes ? `- [${shortHash}]` : ``} - ${
+            `${showHashes ? `- [${shortHash}]` : ``} - ${type ? `**${type}**: ${briefMessage}` : briefMessage
-              type ? `**${type}**: ${briefMessage}` : briefMessage
             }`
           );
         }
@@ -413,38 +541,66 @@ program
 
 program
   .command("release")
+  .alias("rel")
   .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 sign = options.sign ? true : false;
+    const config = await GetConfig();
+
+    const sign = config?.autoSignReleases || options.sign ? true : false;
     const version = string.replace("v", "");
-    const packageFile = JSON.parse(
-      (
-        await fs.promises.readFile(path.join(process.cwd(), "package.json"))
-      ).toString()
-    );
 
-    if (!packageFile) {
+    const onReleaseFile = await GetOnReleaseScript();
-      console.log("[rcz]: this directory does not have a package.json file");
+
+    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)
+      );
     }
 
-    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`, `"Version ${version}"`]
+          ? [`-s`, `v${version}`, `-m`, `"v${version}"`]
-          : [`-a`, `v${version}`, `-m`, `"Version ${version}"`]
+          : [`-a`, `v${version}`, `-m`, `"v${version}"`]
       );
+
+    const postReleaseFile = await GetPostReleaseScript();
+
+    if (postReleaseFile) {
+      const postReleaseScript = `
+        const __NEW_VERSION__ = "${version}";
+        const __IS_SIGNED__ = ${sign};
+
+        ${postReleaseFile}`;
+
+      eval(postReleaseScript);
+    }
   });
 
 program
@@ -463,11 +619,9 @@ program
       // /(build|feat|docs)(\((commands|changelog)\))?!?: .* ?(\(..*\))?((\n\n..*)?(\n\n..*)?)?/gm
 
       const testRegex = new RegExp(
-        `(${
+        `(${config?.types?.map((type) => type.value).join("|") ||
-          config?.types?.map((type) => type.value).join("|") ||
+        "feat|fix|build|ci|docs|perf|refactor|chore"
-          "feat|fix|build|ci|docs|perf|refactor|chore"
+        })(\\((${config?.scopes ? [...config?.scopes, "release"].join("|") : "..*"
-        })(\\((${
-          config?.scopes ? [...config?.scopes, "release"] : "..*"
         })\\))?!?: .* ?(\\(..*\\))?((\n\n..*)?(\n\n..*)?)?`,
         "gm"
       );

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 {