standard-changelog 7.0.1 → 8.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -18,7 +18,7 @@
18
18
  [node-url]: https://nodejs.org
19
19
 
20
20
  [deps]: https://img.shields.io/librariesio/release/npm/standard-changelog
21
- [deps-url]: https://libraries.io/npm/standard-changelog/tree
21
+ [deps-url]: https://libraries.io/npm/standard-changelog
22
22
 
23
23
  [size]: https://packagephobia.com/badge?p=standard-changelog
24
24
  [size-url]: https://packagephobia.com/result?p=standard-changelog
@@ -31,15 +31,6 @@
31
31
 
32
32
  An opinionated approach to CHANGELOG generation using angular commit conventions.
33
33
 
34
- <hr />
35
- <a href="#install">Install</a>
36
- <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
37
- <a href="#usage">Usage</a>
38
- <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
39
- <a href="#js-api">JS API</a>
40
- <br />
41
- <hr />
42
-
43
34
  ## Install
44
35
 
45
36
  ```bash
@@ -59,19 +50,9 @@ standard-changelog
59
50
 
60
51
  The above generates a changelog based on commits since the last semver tag that match the pattern of a "Feature", "Fix", "Performance Improvement" or "Breaking Changes".
61
52
 
62
- **your first release:**
63
-
64
- If you're using this tool for the first time and want to generate new content in CHANGELOG.md, you can run:
65
-
66
- ```sh
67
- standard-changelog --first-release
68
- ```
69
-
70
- **advanced topics:**
71
-
72
53
  All available command line parameters can be listed using CLI: `standard-changelog --help`.
73
54
 
74
- ## JS API
55
+ JS API is also available:
75
56
 
76
57
  ```js
77
58
  import { StandardChangelog } from 'standard-changelog'
@@ -82,17 +63,11 @@ const generator = new StandardChangelog()
82
63
  generator
83
64
  .writeStream()
84
65
  .pipe(process.stdout)
85
-
86
- // or
87
-
88
- for await (const chunk of generator.write()) {
89
- console.log(chunk)
90
- }
91
66
  ```
92
67
 
93
- StandardChangelog is a class based on ConventionalChangelog and with preloaded angular preset.
68
+ ## Documentation
94
69
 
95
- See the [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog/README.md#js-api) JS API docs.
70
+ For comprehensive guides, CLI options, and API reference, visit the [documentation website](https://conventional-changelog.js.org/standard-changelog/).
96
71
 
97
72
  ## License
98
73
 
package/dist/cli.js CHANGED
@@ -27,10 +27,12 @@ const cli = meow(`
27
27
  -l, --lerna-package Generate a changelog for a specific lerna package (:pkg-name@1.0.0)
28
28
  -t, --tag-prefix Tag prefix to consider when reading the tags
29
29
  --commit-path Generate a changelog scoped to a specific directory
30
+ --from Start commit range from a specific tag or sha
31
+ --to End commit range at a specific tag or sha
30
32
  `, {
31
33
  importMeta: import.meta,
32
34
  booleanDefault: undefined,
33
35
  flags
34
36
  });
35
37
  await runProgram(new StandardChangelog(process.cwd()), cli.flags);
36
- //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQ0EsT0FBTyxJQUFJLE1BQU0sTUFBTSxDQUFBO0FBQ3ZCLE9BQU8sRUFDTCxLQUFLLEVBQ0wsVUFBVSxFQUNYLE1BQU0sd0JBQXdCLENBQUE7QUFDL0IsT0FBTyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sWUFBWSxDQUFBO0FBRTlDLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztDQXlCaEIsRUFBRTtJQUNELFVBQVUsRUFBRSxNQUFNLENBQUMsSUFBSTtJQUN2QixjQUFjLEVBQUUsU0FBUztJQUN6QixLQUFLO0NBQ04sQ0FBQyxDQUFBO0FBRUYsTUFBTSxVQUFVLENBQ2QsSUFBSSxpQkFBaUIsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUMsRUFDcEMsR0FBRyxDQUFDLEtBQUssQ0FDVixDQUFBIn0=
38
+ //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vc3JjL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiO0FBQ0EsT0FBTyxJQUFJLE1BQU0sTUFBTSxDQUFBO0FBQ3ZCLE9BQU8sRUFDTCxLQUFLLEVBQ0wsVUFBVSxFQUNYLE1BQU0sd0JBQXdCLENBQUE7QUFDL0IsT0FBTyxFQUFFLGlCQUFpQixFQUFFLE1BQU0sWUFBWSxDQUFBO0FBRTlDLE1BQU0sR0FBRyxHQUFHLElBQUksQ0FBQzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0NBMkJoQixFQUFFO0lBQ0QsVUFBVSxFQUFFLE9BQU8sSUFBSTtJQUN2QixjQUFjLEVBQUUsU0FBUztJQUN6QixLQUFLO0NBQ04sQ0FBQyxDQUFBO0FBRUYsTUFBTSxVQUFVLENBQ2QsSUFBSSxpQkFBaUIsQ0FBQyxPQUFPLENBQUMsR0FBRyxFQUFFLENBQUMsRUFDcEMsR0FBRyxDQUFDLEtBQUssQ0FDVixDQUFBIn0=
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAA;AAC/E,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AAG9D,cAAc,wBAAwB,CAAA;AAEtC,qBAAa,iBAAkB,SAAQ,qBAAqB;gBAC9C,cAAc,EAAE,MAAM,GAAG,qBAAqB;CAK3D"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAA;AAC/E,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AAG9D,cAAc,wBAAwB,CAAA;AAEtC,qBAAa,iBAAkB,SAAQ,qBAAqB;IAC1D,YAAY,cAAc,EAAE,MAAM,GAAG,qBAAqB,EAIzD;CACF"}
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "standard-changelog",
3
3
  "type": "module",
4
- "version": "7.0.1",
4
+ "version": "8.0.1",
5
5
  "description": "Generate a changelog from git metadata with Angular commit convention.",
6
6
  "author": "Steve Mao",
7
7
  "license": "MIT",
8
- "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/standard-changelog#readme",
8
+ "homepage": "https://conventional-changelog.js.org/standard-changelog/",
9
9
  "repository": {
10
10
  "type": "git",
11
11
  "url": "https://github.com/conventional-changelog/conventional-changelog.git",
@@ -22,10 +22,7 @@
22
22
  "log"
23
23
  ],
24
24
  "engines": {
25
- "node": ">=18"
26
- },
27
- "bin": {
28
- "standard-changelog": "./dist/cli.js"
25
+ "node": ">=22"
29
26
  },
30
27
  "exports": {
31
28
  "types": "./dist/index.d.ts",
@@ -35,9 +32,12 @@
35
32
  "dist"
36
33
  ],
37
34
  "dependencies": {
38
- "meow": "^13.0.0",
39
- "@conventional-changelog/git-client": "^2.2.0",
40
- "conventional-changelog-angular": "^8.0.0",
41
- "conventional-changelog": "^7.0.1"
35
+ "meow": "^14.0.0",
36
+ "conventional-changelog-angular": "^9.2.1",
37
+ "@conventional-changelog/git-client": "^3.0.2",
38
+ "conventional-changelog": "^8.0.1"
39
+ },
40
+ "bin": {
41
+ "standard-changelog": "./dist/cli.js"
42
42
  }
43
43
  }