Compare commits
14 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 63a6c9feab | |||
| 8cb67f2cfd | |||
| 8dbe266e39 | |||
| 58f4dde9c9 | |||
| 9586a567de | |||
| 6c663cf7fc | |||
| 535a62857c | |||
| 03f68e2912 | |||
| 71925553c1 | |||
| 53bb1437a0 | |||
| 92f8126abf | |||
| 5080d71fb8 | |||
| 56ad837b82 | |||
| 003c943a74 |
3
.rczrc.json
Normal file
3
.rczrc.json
Normal file
@@ -0,0 +1,3 @@
|
||||
{
|
||||
"scopes": ["commands", "changelog", "readme", "release", "config"]
|
||||
}
|
||||
23
CHANGELOG.md
23
CHANGELOG.md
@@ -2,6 +2,29 @@
|
||||
|
||||
Generation of this changelog is based on commits
|
||||
|
||||
## 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
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "@resultium/rcz",
|
||||
"version": "1.4.0",
|
||||
"version": "1.5.2",
|
||||
"description": "Resultium commit standardization library, based on conventional commits",
|
||||
"main": "./dist/index.js",
|
||||
"bin": {
|
||||
|
||||
49
src/index.ts
49
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;
|
||||
}
|
||||
@@ -39,8 +51,10 @@ 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 amend = options.amend ? true : false;
|
||||
|
||||
const config = await GetConfig();
|
||||
|
||||
@@ -51,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");
|
||||
@@ -99,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",
|
||||
},
|
||||
],
|
||||
});
|
||||
|
||||
@@ -192,14 +213,24 @@ program
|
||||
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
|
||||
@@ -434,9 +465,9 @@ program
|
||||
const testRegex = new RegExp(
|
||||
`(${
|
||||
config?.types?.map((type) => type.value).join("|") ||
|
||||
"feat|fix|build|ci|docs|perf|refactor"
|
||||
"feat|fix|build|ci|docs|perf|refactor|chore"
|
||||
})(\\((${
|
||||
config?.scopes?.join("|") || "..*"
|
||||
config?.scopes ? [...config?.scopes, "release"].join("|") : "..*"
|
||||
})\\))?!?: .* ?(\\(..*\\))?((\n\n..*)?(\n\n..*)?)?`,
|
||||
"gm"
|
||||
);
|
||||
|
||||
Reference in New Issue
Block a user