18 Commits

Author SHA1 Message Date
4411bede02 docs: add issue templates 2023-08-24 01:30:39 +03:00
58f4dde9c9 docs(changelog): generate for v1.5.1 2023-08-23 22:53:43 +03:00
9586a567de chore(release): v1.5.1 2023-08-23 22:53:05 +03:00
6c663cf7fc fix(commands): allow chore type in validation regex 2023-08-23 22:52:54 +03:00
535a62857c docs(changelog): generate for v1.5.0 2023-08-23 22:48:52 +03:00
03f68e2912 Merge pull request 'Release v1.5.0' (#8) from develop into main
Reviewed-on: technology/rcz#8
2023-08-23 19:47:44 +00:00
71925553c1 chore(release): v1.5.0 2023-08-23 22:46:00 +03:00
53bb1437a0 fix(commands): allow chore type (#7)
allow chore type to permit validate subcommand usage together with release subcommand
2023-08-23 22:43:23 +03:00
92f8126abf feat(commands): add --amend option to commit sub-command 2023-08-22 17:43:30 +03:00
5080d71fb8 feat(config): allow more config file names
.rczrc.json and rcz.config.json can now be used as rcz configuration
2023-08-22 17:41:36 +03:00
56ad837b82 Merge pull request 'Add the ability to return only the code of validation command' (#6) from develop into main
Reviewed-on: technology/rcz#6
2023-08-21 15:37:11 +00:00
003c943a74 docs(changelog): generate for v1.4.0 2023-08-21 18:35:05 +03:00
77dfc9a73b chore(release): v1.4.0 2023-08-21 18:33:50 +03:00
8ab631549a feat(commands): add the ability to return code only for validation 2023-08-21 18:33:33 +03:00
2670f79e2f Merge pull request 'Release v1.3.0' (#5) from develop into main
Reviewed-on: technology/rcz#5
2023-08-21 15:14:26 +00:00
3afc2ed071 Merge branch 'main' into develop 2023-08-21 15:14:16 +00:00
45458d14e2 docs(changelog): generate for v1.3.0 2023-08-21 18:12:59 +03:00
d61c9ecf2e Merge pull request 'Make commit signing possible' (#3) from develop into main
Reviewed-on: technology/rcz#3
2023-08-20 15:13:30 +00:00
8 changed files with 145 additions and 19 deletions

View File

@@ -0,0 +1,20 @@
---
name: "Bug Report"
about: Report a reproducible bug or regression
title: "Bug: "
---
## Steps To Reproduce
<!-- Simple, clear, laconical, reproducible steps how to cause this bug in a development environment -->
1.
2.
## The current behavior
<!-- It is recommended to provide an image or a video, if that is not possible a very concise text would suffice -->
## The expected behavior
<!-- Describe the expected behavior -->

View File

@@ -0,0 +1,29 @@
---
name: "Feature Request"
about: Standard feature request template.
title: "Feature: "
---
## Feature summary
<!-- e.g. -->
Add legal page to the website
## The expected behavior
<!-- e.g. -->
- Ability to select a language for legal page
- Presence of a legal page in sitemap
- Ability to add different legal documents in a .md format
## Helpful resources
<!-- e.g. -->
- [Svelte Markdown on NPM](https://www.npmjs.com/package/svelte-markdown)
## Notes
First two documents are going to be Privacy Policy and Terms of Service

View File

@@ -0,0 +1,9 @@
---
name: "Task"
about: "Staff task template "
title: "Task: "
---
<!-- Describe the task here, e.g. -->
Change pricing to medium standard

View File

@@ -3,6 +3,7 @@
"commands", "commands",
"changelog", "changelog",
"readme", "readme",
"release" "release",
"config"
] ]
} }

View File

@@ -2,6 +2,36 @@
Generation of this changelog is based on commits 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
- [755da3bb5] - **commands**: add ability to write a footer
- [9311be80b] - **commands**: add commit message validation command (#4)
## v1.2.0 ## v1.2.0
### Features ### Features

View File

@@ -23,7 +23,7 @@ Resultium commit standardization library
## Configuration ## 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 ```json
{ {

View File

@@ -1,6 +1,6 @@
{ {
"name": "@resultium/rcz", "name": "@resultium/rcz",
"version": "1.3.0", "version": "1.5.1",
"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": {

View File

@@ -24,6 +24,18 @@ const GetConfig = async () => {
await fs.promises.readFile(path.join(process.cwd(), ".rczrc")) await fs.promises.readFile(path.join(process.cwd(), ".rczrc"))
).toString() ).toString()
) as Config; ) 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 { } else {
return null; return null;
} }
@@ -33,14 +45,16 @@ const program = new Command();
program program
.name("rcz") .name("rcz")
.description("Resultium commit standardization command-line interface") .description("Resultium commit standardization command-line interface")
.version("1.3.0"); .version("1.4.0");
program program
.command("commit") .command("commit")
.description("Create a conventional commit") .description("Create a conventional commit")
.option("-S, --sign", "sign the commit") .option("-S, --sign", "sign the commit")
.option("--amend", "amend commit message to the last commit")
.action(async (options) => { .action(async (options) => {
const sign = options.sign ? true : false; const sign = options.sign ? true : false;
const amend = options.amend ? true : false;
const config = await GetConfig(); const config = await GetConfig();
@@ -51,7 +65,9 @@ program
process.exit(0); process.exit(0);
} }
const stageAll = await confirm({ const stageAll = amend
? null
: await confirm({
message: "Stage all changes?", message: "Stage all changes?",
initialValue: true, initialValue: true,
}); });
@@ -99,6 +115,11 @@ program
value: "refactor", value: "refactor",
hint: "code change that neither fixes a bug nor adds a feature", 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) { if (stageAll) {
await simpleGit() await simpleGit()
.add(".") .add(".")
.commit(commitMessage, sign ? ["-S"] : []); .commit(
commitMessage,
sign ? (amend ? ["-S", "--amend"] : ["-S"]) : amend ? ["--amend"] : []
);
} else { } else {
await simpleGit().commit(commitMessage, sign ? ["-S"] : []); await simpleGit().commit(
commitMessage,
sign ? (amend ? ["-S", "--amend"] : ["-S"]) : amend ? ["--amend"] : []
);
} }
note(commitMessage); 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 program
@@ -420,9 +451,11 @@ program
.command("validate") .command("validate")
.description("Validate whether a string fits given commit conventions") .description("Validate whether a string fits given commit conventions")
.argument("[message]", "string for validation") .argument("[message]", "string for validation")
.action(async (string: string) => { .option("-C, --code-only", "return code only")
.action(async (string: string, options) => {
try { try {
const message = string || fs.readFileSync(0, "utf-8"); const message = string || fs.readFileSync(0, "utf-8");
const codeOnly = options.codeOnly ? true : false;
const config = await GetConfig(); const config = await GetConfig();
@@ -432,18 +465,22 @@ program
const testRegex = new RegExp( 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" "feat|fix|build|ci|docs|perf|refactor|chore"
})(\\((${ })(\\((${
config?.scopes?.join("|") || "..*" config?.scopes ? [...config?.scopes, "release"] : "..*"
})\\))?!?: .* ?(\\(..*\\))?((\n\n..*)?(\n\n..*)?)?`, })\\))?!?: .* ?(\\(..*\\))?((\n\n..*)?(\n\n..*)?)?`,
"gm" "gm"
); );
if (codeOnly) {
console.log(testRegex.test(message) ? 0 : 1);
} else {
console.log( console.log(
testRegex.test(message) testRegex.test(message)
? "[rcz]: valid message" ? "[rcz]: valid message"
: "[rcz]: invalid message" : "[rcz]: invalid message"
); );
}
} catch (err) { } catch (err) {
console.log("[rcz]: no stdin found"); console.log("[rcz]: no stdin found");
} }