Skip to content

Commit c926cce

Browse files
authored
Merge pull request #6 from TheoBrigitte/rename-chlog
Rename to chlog
2 parents dc7ddfe + 48f9023 commit c926cce

File tree

5 files changed

+16
-15
lines changed

5 files changed

+16
-15
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
node_modules

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ Default parameters use the `CHANGELOG.md` file in the current directory, this ca
3838
The `fmt` command parses and formats the changelog file to adhere to the keep a changelog format.
3939

4040
```shell
41-
changelog-parser fmt
41+
chlog fmt
4242
```
4343

4444
This command exits with a non-zero status code if the changelog format is invalid.
4545

4646
```shell
47-
changelog-parser fmt --silent || echo "Invalid changelog format"
47+
chlog fmt --silent || echo "Invalid changelog format"
4848
```
4949

5050
Changes can be written back to the file with the `--write` flag.
@@ -54,7 +54,7 @@ Changes can be written back to the file with the `--write` flag.
5454
The `init` command initializes a new changelog file.
5555

5656
```shell
57-
changelog-parser init
57+
chlog init
5858
```
5959

6060
This command creates a new changelog file with the following content:
@@ -82,8 +82,8 @@ This example uses default values, but title, description, url, and initial relea
8282
The `add` command adds a new change to the changelog file.
8383

8484
```shell
85-
changelog-parser add --type added "New feature"
86-
changelog-parser add --type security "Fix security issue"
85+
chlog add --type added "New feature"
86+
chlog add --type security "Fix security issue"
8787
```
8888

8989
Those commands add the following content to the changelog file:
@@ -103,7 +103,7 @@ Those commands add the following content to the changelog file:
103103
The `release` command adds a new release to the changelog file.
104104

105105
```shell
106-
changelog-parser release 1.0.0
106+
chlog release 1.0.0
107107
```
108108

109109
This command adds the following content to the changelog file:
@@ -131,7 +131,7 @@ A date can be specified with the `--date` flag.
131131
The `list` command lists all releases in the changelog file.
132132

133133
```shell
134-
changelog-parser list
134+
chlog list
135135
```
136136

137137
This command prints the following content:
@@ -146,7 +146,7 @@ This command prints the following content:
146146
The `show` command shows all changes in a release.
147147

148148
```shell
149-
changelog-parser show 1.0.0
149+
chlog show 1.0.0
150150
```
151151

152152
This command prints the following content:
@@ -168,7 +168,7 @@ This command prints the following content:
168168
The `merge` command merges two (or more) changelog files.
169169

170170
```shell
171-
changelog-parser merge other/CHANGELOG.md
171+
chlog merge other/CHANGELOG.md
172172
```
173173

174174
This command merges the content from `other/CHANGELOG.md` latest release into the current changelog file.

package-lock.json

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"description": "CLI tool to parse and manage changelog files",
3-
"name": "changelog-parser",
3+
"name": "chlog",
44
"bin": {
5-
"changelog-parser": "index.js"
5+
"chlog": "index.js"
66
},
77
"main": "index.js",
88
"dependencies": {

src/main.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ function main() {
3232

3333
// Define the main program
3434
program
35-
.name("changelog-parser")
35+
.name("chlog")
3636
.description("A command-line tool to parse and manipulate changelog files")
3737
.version("0.1.0")
3838

0 commit comments

Comments
 (0)