chore(release): v1.7.0

Reviewed-on: technology/rcz#9

.rczrc.json

@@ -1,9 +1,3 @@
 {
-  "scopes": [
-    "commands",
-    "changelog",
-    "readme",
-    "release",
-    "config"
-  ]
+  "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

@@ -2,6 +2,36 @@
 
 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

README.md

@@ -34,6 +34,31 @@ 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
 }
 ```
+
+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,14 +0,0 @@
-{
-  "version": "0.2",
-  "ignorePaths": [],
-  "dictionaryDefinitions": [],
-  "dictionaries": [],
-  "words": [
-    "Acked",
-    "johndoe",
-    "outro",
-    "rczrc"
-  ],
-  "ignoreWords": [],
-  "import": []
-}

package.json

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

src/index.ts

@@ -45,7 +45,7 @@ const program = new Command();
 program
   .name("rcz")
   .description("Resultium commit standardization command-line interface")
-  .version("1.4.0");
+  .version("1.7.0");
 
 program
   .command("commit")
@@ -53,11 +53,11 @@ program
   .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();
 
+    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"))) {
@@ -69,7 +69,9 @@ program
       ? null
       : await confirm({
           message: "Stage all changes?",
-          initialValue: true,
+          initialValue: (await simpleGit().diff(["--cached"])).toString()
+            ? false
+            : true,
         });
 
     if (isCancel(stageAll)) {
@@ -419,8 +421,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"))
@@ -436,14 +456,15 @@ 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}"`]
-          : [`-a`, `v${version}`, `-m`, `"Version ${version}"`]
+          ? [`-s`, `v${version}`, `-m`, `"v${version}"`]
+          : [`-a`, `v${version}`, `-m`, `"v${version}"`]
       );
   });
 
@@ -467,7 +488,7 @@ program
           config?.types?.map((type) => type.value).join("|") ||
           "feat|fix|build|ci|docs|perf|refactor|chore"
         })(\\((${
-          config?.scopes ? [...config?.scopes, "release"] : "..*"
+          config?.scopes ? [...config?.scopes, "release"].join("|") : "..*"
         })\\))?!?: .* ?(\\(..*\\))?((\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 {