@yarn-tool/changelog 3.0.2 → 3.0.4

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/CHANGELOG.md CHANGED
@@ -3,6 +3,58 @@
3
3
  All notable changes to this project will be documented in this file.
4
4
  See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5
5
 
6
+ ## [3.0.4](https://github.com/bluelovers/ws-yarn-workspaces/compare/@yarn-tool/changelog@3.0.3...@yarn-tool/changelog@3.0.4) (2026-03-02)
7
+
8
+
9
+ ### BREAKING CHANGES
10
+
11
+ * **release:** 核心工具鏈套件升級
12
+ - @lazy-node/semver-simple-parse v4.0.0
13
+ - @yarn-tool/require-resolve v4.0.0
14
+ - @yarn-tool/resolve-package v3.0.0
15
+ - @yarn-tool/get-pkg-bin v3.0.0
16
+ - @yarn-tool/check-pkg-bin v4.0.0
17
+
18
+ 更新所有工作區套件以使用相容的主要版本,並重構
19
+ npm-package-arg-util 以抽離 _parsePackageNameCore 核心函式。
20
+
21
+
22
+
23
+ ### 📚 Documentation
24
+
25
+ * **changelog,ws-changed,ws-root-changelog:** 新增完整雙語文件與 JSDoc 註解 ([d2274c6](https://github.com/bluelovers/ws-yarn-workspaces/commit/d2274c6d30ca30fd5d6bbf2900ac85fbf602f3ee))
26
+
27
+
28
+ ### 🛠 Build System
29
+
30
+ * update build ([ff772db](https://github.com/bluelovers/ws-yarn-workspaces/commit/ff772dbdef672ec3cd1fb7c9ca5709404f11d76d))
31
+
32
+
33
+ ### ♻️ Chores
34
+
35
+ * Add test config and global types for tsdx ([88a8df6](https://github.com/bluelovers/ws-yarn-workspaces/commit/88a8df6eef5dc59d9e0d9268b21706dceb5ab2a1))
36
+ * add __root.ts test utility to workspace packages ([a771727](https://github.com/bluelovers/ws-yarn-workspaces/commit/a7717278883c86d9ed8ab89f42070d3385c173a7))
37
+ * **deps:** 升級路徑與檔案系統相關依賴版本 ([78d395b](https://github.com/bluelovers/ws-yarn-workspaces/commit/78d395b5469feecc85f250ca2d8b4977161e7618))
38
+ * **deps:** 更新依賴版本並將腳本執行從 yarn 遷移至 node --run ([389e581](https://github.com/bluelovers/ws-yarn-workspaces/commit/389e581a07cf803dc34c8402b4d3f69af0016b8c))
39
+ * **deps:** 升級多項依賴套件版本 ([1382602](https://github.com/bluelovers/ws-yarn-workspaces/commit/1382602ca94ff236b251fd1481b6332468de4621))
40
+
41
+
42
+ ### 📌 Dependencies
43
+
44
+ * **release:** 主要版本升級與跨套件相依更新 ([2a24889](https://github.com/bluelovers/ws-yarn-workspaces/commit/2a248893f3667704d1ba0de12544091abf5d341e))
45
+
46
+
47
+
48
+ ## [3.0.3](https://github.com/bluelovers/ws-yarn-workspaces/compare/@yarn-tool/changelog@3.0.2...@yarn-tool/changelog@3.0.3) (2025-09-07)
49
+
50
+
51
+
52
+ ### 📌 Dependencies
53
+
54
+ * fix and update deps avoid use yargs@18 ([5ed9a5c](https://github.com/bluelovers/ws-yarn-workspaces/commit/5ed9a5cd953eeebd28d4ee970e99bed6fb966317))
55
+
56
+
57
+
6
58
  ## [3.0.2](https://github.com/bluelovers/ws-yarn-workspaces/compare/@yarn-tool/changelog@3.0.1...@yarn-tool/changelog@3.0.2) (2024-05-03)
7
59
 
8
60
 
package/README.md CHANGED
@@ -1,12 +1,98 @@
1
- # README.md
1
+ # @yarn-tool/changelog
2
2
 
3
-
3
+ Generate and update CHANGELOG.md using conventional commits for monorepo workspaces.
4
4
 
5
- ## install
5
+ ## Features
6
+
7
+ - **Conventional Commits**: Automatically generate changelogs from conventional commit messages
8
+ - **Monorepo Support**: Works seamlessly with Lerna and Yarn workspaces
9
+ - **CLI Tool**: Easy-to-use command line interface
10
+ - **Version Recommendation**: Analyze commits to recommend next version
11
+ - **Independent/Root Modes**: Support both independent and fixed versioning modes
12
+
13
+ ## Install
6
14
 
7
15
  ```bash
16
+ # Using yarn
8
17
  yarn add @yarn-tool/changelog
18
+
19
+ # Using yarn-tool
9
20
  yarn-tool add @yarn-tool/changelog
21
+
22
+ # Using yt (alias)
10
23
  yt add @yarn-tool/changelog
11
24
  ```
12
25
 
26
+ ## CLI Usage
27
+
28
+ ```bash
29
+ # Generate changelog for current package
30
+ changelog
31
+
32
+ # Specify preset
33
+ changelog --preset conventional-changelog-angular
34
+
35
+ # Specify tag prefix
36
+ changelog --tag-prefix v
37
+
38
+ # Specify type (independent or root)
39
+ changelog --type independent
40
+ ```
41
+
42
+ ## API Usage
43
+
44
+ ### Update Changelog
45
+
46
+ ```typescript
47
+ import { updateChangelogByCwd } from '@yarn-tool/changelog';
48
+
49
+ updateChangelogByCwd(process.cwd(), {
50
+ changelogPreset: '@bluelovers/conventional-changelog-bluelovers',
51
+ tagPrefix: 'v',
52
+ type: 'independent',
53
+ }).then(data => {
54
+ console.log(`Updated ${data.logPath}`);
55
+ console.log(`New version: ${data.version}`);
56
+ });
57
+ ```
58
+
59
+ ### Recommend Version
60
+
61
+ ```typescript
62
+ import { recommendVersion } from '@yarn-tool/changelog';
63
+
64
+ recommendVersion(pkg, {
65
+ changelogPreset: 'conventional-changelog-angular',
66
+ type: 'independent',
67
+ }).then(version => {
68
+ console.log(`Recommended version: ${version}`);
69
+ });
70
+ ```
71
+
72
+ ## Options
73
+
74
+ | Option | Type | Default | Description |
75
+ |--------|------|---------|-------------|
76
+ | `preset` | `string` | `@bluelovers/conventional-changelog-bluelovers` | Changelog preset to use |
77
+ | `tag-prefix` | `string` | `v` | Tag prefix for version tags |
78
+ | `type` | `string` | `independent` | Changelog type: `independent` or `root` |
79
+ | `cwd` | `string` | `process.cwd()` | Working directory |
80
+
81
+ ## Supported Presets
82
+
83
+ - `@bluelovers/conventional-changelog-bluelovers`
84
+ - `conventional-changelog-angular`
85
+ - `conventional-changelog-atom`
86
+ - `conventional-changelog-codemirror`
87
+ - `conventional-changelog-ember`
88
+ - `conventional-changelog-eslint`
89
+ - And more...
90
+
91
+ ## Related
92
+
93
+ - [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog)
94
+ - [Lerna](https://lerna.js.org/)
95
+
96
+ ## License
97
+
98
+ ISC
package/bin/changelog.js CHANGED
@@ -1,5 +1,15 @@
1
1
  #!/usr/bin/env node
2
2
  "use strict";
3
+ /**
4
+ * Changelog CLI 工具
5
+ * Changelog CLI Tool
6
+ *
7
+ * 命令列介面,用於自動生成和更新套件的 CHANGELOG.md
8
+ * Command line interface for auto-generating and updating package CHANGELOG.md
9
+ *
10
+ * 基於 conventional commits 規範分析 Git 歷史記錄
11
+ * Analyzes Git history based on conventional commits specification
12
+ */
3
13
  Object.defineProperty(exports, "__esModule", { value: true });
4
14
  const tslib_1 = require("tslib");
5
15
  require("v8-compile-cache");
@@ -9,6 +19,10 @@ const from_list_1 = require("../lib/lerna/from-list");
9
19
  const table_1 = require("@yarn-tool/table");
10
20
  const path_is_same_1 = require("path-is-same");
11
21
  const semver_diff_1 = require("@yarn-tool/semver-diff");
22
+ /**
23
+ * 解析命令列參數
24
+ * Parse command line arguments
25
+ */
12
26
  const argv = (0, yargs_setting_1.setupToYargs)(yargs_1.default)
13
27
  .option('cwd', {
14
28
  default: process.cwd(),
@@ -18,27 +32,67 @@ const argv = (0, yargs_setting_1.setupToYargs)(yargs_1.default)
18
32
  .version()
19
33
  .help()
20
34
  .parseSync();
35
+ /**
36
+ * 設定選項物件
37
+ * Setup options object
38
+ */
21
39
  let options = {
40
+ /**
41
+ * Changelog 預設規範
42
+ * Changelog preset
43
+ */
22
44
  changelogPreset: argv.preset,
45
+ /**
46
+ * 標籤前綴
47
+ * Tag prefix
48
+ */
23
49
  tagPrefix: argv['tag-prefix'],
50
+ /**
51
+ * Changelog 類型 (independent 或 root)
52
+ * Changelog type (independent or root)
53
+ */
24
54
  type: argv.type || (argv['lerna-package'] ? 'independent' : 'root'),
25
55
  };
56
+ /**
57
+ * 執行 Changelog 更新
58
+ * Execute changelog update
59
+ */
26
60
  (0, from_list_1.updateChangelogByCwd)(argv.cwd, options)
27
61
  .then(data => {
62
+ /**
63
+ * 建立輸出表格
64
+ * Create output table
65
+ */
28
66
  const table = (0, table_1.createDependencyTable)({
29
67
  colAligns: ['left', 'left'],
30
68
  });
69
+ /**
70
+ * 加入基本資訊行
71
+ * Add basic info rows
72
+ */
31
73
  table.push([`rootPath`, data.rootPath]);
74
+ /**
75
+ * 若目標路徑與根路徑不同,顯示目標路徑
76
+ * Show target path if different from root path
77
+ */
32
78
  if (!(0, path_is_same_1.pathIsSame)(data.rootPath, data.cwd)) {
33
79
  table.push([`targetPath`, data.cwd]);
34
80
  }
35
81
  table.push([`changelogPreset`, data.options.changelogPreset]);
36
82
  table.push([`type`, data.options.type]);
37
83
  table.push([`tagPrefix`, data.options.tagPrefix]);
84
+ /**
85
+ * 使用顏色突顯版本差異
86
+ * Highlight version diff with colors
87
+ */
38
88
  let version = (0, semver_diff_1.colorizeDiff)(data.pkg.version, data.version);
39
89
  table.push([`package`, data.pkg.name]);
40
90
  table.push([`version`, version]);
41
91
  table.push([`file`, data.logPath]);
92
+ /**
93
+ * 輸出表格並移除行尾空格
94
+ * Output table and remove trailing spaces
95
+ */
42
96
  console.log(table.toString().replace(/ +$/g, ''));
43
97
  });
44
98
  //# sourceMappingURL=changelog.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"changelog.js","sourceRoot":"","sources":["changelog.ts"],"names":[],"mappings":";;;;AAEA,4BAA0B;AAC1B,0DAA0C;AAC1C,wDAAoD;AAEpD,sDAA8D;AAC9D,4CAAyD;AACzD,+CAA0C;AAE1C,wDAAsD;AAEtD,MAAM,IAAI,GAAG,IAAA,4BAAY,EAAC,eAAK,CAAC;KAC9B,MAAM,CAAC,KAAK,EAAE;IACd,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;IACtB,SAAS,EAAE,IAAI;CACf,CAAC;KACD,cAAc,CAAC,IAAI,CAAC;KACpB,OAAO,EAAE;KACT,IAAI,EAAE;KACN,SAAS,EAAE,CACZ;AAED,IAAI,OAAO,GAAuD;IAEjE,eAAe,EAAE,IAAI,CAAC,MAAM;IAC5B,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC;IAE7B,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;CAEnE,CAAA;AAED,IAAA,gCAAoB,EAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;KACrC,IAAI,CAAC,IAAI,CAAC,EAAE;IAEZ,MAAM,KAAK,GAAG,IAAA,6BAAqB,EAAC;QACnC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;KAC3B,CAAC,CAAC;IAEH,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEvC,IAAI,CAAC,IAAA,yBAAU,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,EACxC,CAAC;QACA,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IACrC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAA;IAC7D,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IACvC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IAEjD,IAAI,OAAO,GAAG,IAAA,0BAAY,EAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAE3D,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;IACtC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAA;IAChC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;IAElC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;AACnD,CAAC,CAAC,CACF","sourcesContent":["#!/usr/bin/env node\n\nimport 'v8-compile-cache';\nimport yargs, { Argv, Omit } from 'yargs';\nimport { setupToYargs } from '../lib/yargs-setting';\nimport { IOptionsWithType, IOptionsUpdateChangelog } from '..';\nimport { updateChangelogByCwd } from '../lib/lerna/from-list';\nimport { createDependencyTable } from '@yarn-tool/table';\nimport { pathIsSame } from 'path-is-same';\nimport { join } from 'path';\nimport { colorizeDiff } from '@yarn-tool/semver-diff';\n\nconst argv = setupToYargs(yargs)\n\t.option('cwd', {\n\t\tdefault: process.cwd(),\n\t\tnormalize: true,\n\t})\n\t.showHelpOnFail(true)\n\t.version()\n\t.help()\n\t.parseSync()\n;\n\nlet options: Partial<IOptionsWithType<IOptionsUpdateChangelog>> = {\n\n\tchangelogPreset: argv.preset,\n\ttagPrefix: argv['tag-prefix'],\n\n\ttype: argv.type || (argv['lerna-package'] ? 'independent' : 'root'),\n\n}\n\nupdateChangelogByCwd(argv.cwd, options)\n\t.then(data => {\n\n\t\tconst table = createDependencyTable({\n\t\t\tcolAligns: ['left', 'left'],\n\t\t});\n\n\t\ttable.push([`rootPath`, data.rootPath])\n\n\t\tif (!pathIsSame(data.rootPath, data.cwd))\n\t\t{\n\t\t\ttable.push([`targetPath`, data.cwd])\n\t\t}\n\n\t\ttable.push([`changelogPreset`, data.options.changelogPreset])\n\t\ttable.push([`type`, data.options.type])\n\t\ttable.push([`tagPrefix`, data.options.tagPrefix])\n\n\t\tlet version = colorizeDiff(data.pkg.version, data.version);\n\n\t\ttable.push([`package`, data.pkg.name])\n\t\ttable.push([`version`, version])\n\t\ttable.push([`file`, data.logPath])\n\n\t\tconsole.log(table.toString().replace(/ +$/g, ''));\n\t})\n;\n"]}
1
+ {"version":3,"file":"changelog.js","sourceRoot":"","sources":["changelog.ts"],"names":[],"mappings":";;AAEA;;;;;;;;;GASG;;;AAEH,4BAA0B;AAC1B,0DAA0C;AAC1C,wDAAoD;AAEpD,sDAA8D;AAC9D,4CAAyD;AACzD,+CAA0C;AAE1C,wDAAsD;AAEtD;;;GAGG;AACH,MAAM,IAAI,GAAG,IAAA,4BAAY,EAAC,eAAK,CAAC;KAC9B,MAAM,CAAC,KAAK,EAAE;IACd,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;IACtB,SAAS,EAAE,IAAI;CACf,CAAC;KACD,cAAc,CAAC,IAAI,CAAC;KACpB,OAAO,EAAE;KACT,IAAI,EAAE;KACN,SAAS,EAAE,CACZ;AAED;;;GAGG;AACH,IAAI,OAAO,GAAuD;IAEjE;;;OAGG;IACH,eAAe,EAAE,IAAI,CAAC,MAAM;IAE5B;;;OAGG;IACH,SAAS,EAAE,IAAI,CAAC,YAAY,CAAC;IAE7B;;;OAGG;IACH,IAAI,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC;CAEnE,CAAA;AAED;;;GAGG;AACH,IAAA,gCAAoB,EAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC;KACrC,IAAI,CAAC,IAAI,CAAC,EAAE;IAEZ;;;OAGG;IACH,MAAM,KAAK,GAAG,IAAA,6BAAqB,EAAC;QACnC,SAAS,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC;KAC3B,CAAC,CAAC;IAEH;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,CAAC,UAAU,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAA;IAEvC;;;OAGG;IACH,IAAI,CAAC,IAAA,yBAAU,EAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,GAAG,CAAC,EACxC,CAAC;QACA,KAAK,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAA;IACrC,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,CAAC,iBAAiB,EAAE,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAA;IAC7D,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAA;IACvC,KAAK,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,CAAA;IAEjD;;;OAGG;IACH,IAAI,OAAO,GAAG,IAAA,0BAAY,EAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAE3D,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAA;IACtC,KAAK,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAA;IAChC,KAAK,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;IAElC;;;OAGG;IACH,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;AACnD,CAAC,CAAC,CACF","sourcesContent":["#!/usr/bin/env node\n\n/**\n * Changelog CLI 工具\n * Changelog CLI Tool\n *\n * 命令列介面,用於自動生成和更新套件的 CHANGELOG.md\n * Command line interface for auto-generating and updating package CHANGELOG.md\n *\n * 基於 conventional commits 規範分析 Git 歷史記錄\n * Analyzes Git history based on conventional commits specification\n */\n\nimport 'v8-compile-cache';\nimport yargs, { Argv, Omit } from 'yargs';\nimport { setupToYargs } from '../lib/yargs-setting';\nimport { IOptionsWithType, IOptionsUpdateChangelog } from '..';\nimport { updateChangelogByCwd } from '../lib/lerna/from-list';\nimport { createDependencyTable } from '@yarn-tool/table';\nimport { pathIsSame } from 'path-is-same';\nimport { join } from 'path';\nimport { colorizeDiff } from '@yarn-tool/semver-diff';\n\n/**\n * 解析命令列參數\n * Parse command line arguments\n */\nconst argv = setupToYargs(yargs)\n\t.option('cwd', {\n\t\tdefault: process.cwd(),\n\t\tnormalize: true,\n\t})\n\t.showHelpOnFail(true)\n\t.version()\n\t.help()\n\t.parseSync()\n;\n\n/**\n * 設定選項物件\n * Setup options object\n */\nlet options: Partial<IOptionsWithType<IOptionsUpdateChangelog>> = {\n\n\t/**\n\t * Changelog 預設規範\n\t * Changelog preset\n\t */\n\tchangelogPreset: argv.preset,\n\n\t/**\n\t * 標籤前綴\n\t * Tag prefix\n\t */\n\ttagPrefix: argv['tag-prefix'],\n\n\t/**\n\t * Changelog 類型 (independent 或 root)\n\t * Changelog type (independent or root)\n\t */\n\ttype: argv.type || (argv['lerna-package'] ? 'independent' : 'root'),\n\n}\n\n/**\n * 執行 Changelog 更新\n * Execute changelog update\n */\nupdateChangelogByCwd(argv.cwd, options)\n\t.then(data => {\n\n\t\t/**\n\t\t * 建立輸出表格\n\t\t * Create output table\n\t\t */\n\t\tconst table = createDependencyTable({\n\t\t\tcolAligns: ['left', 'left'],\n\t\t});\n\n\t\t/**\n\t\t * 加入基本資訊行\n\t\t * Add basic info rows\n\t\t */\n\t\ttable.push([`rootPath`, data.rootPath])\n\n\t\t/**\n\t\t * 若目標路徑與根路徑不同,顯示目標路徑\n\t\t * Show target path if different from root path\n\t\t */\n\t\tif (!pathIsSame(data.rootPath, data.cwd))\n\t\t{\n\t\t\ttable.push([`targetPath`, data.cwd])\n\t\t}\n\n\t\ttable.push([`changelogPreset`, data.options.changelogPreset])\n\t\ttable.push([`type`, data.options.type])\n\t\ttable.push([`tagPrefix`, data.options.tagPrefix])\n\n\t\t/**\n\t\t * 使用顏色突顯版本差異\n\t\t * Highlight version diff with colors\n\t\t */\n\t\tlet version = colorizeDiff(data.pkg.version, data.version);\n\n\t\ttable.push([`package`, data.pkg.name])\n\t\ttable.push([`version`, version])\n\t\ttable.push([`file`, data.logPath])\n\n\t\t/**\n\t\t * 輸出表格並移除行尾空格\n\t\t * Output table and remove trailing spaces\n\t\t */\n\t\tconsole.log(table.toString().replace(/ +$/g, ''));\n\t})\n;\n"]}
@@ -1,5 +1,20 @@
1
+ /**
2
+ * 基於套件列表更新 Changelog 模組
3
+ * Update Changelog Based on Package List Module
4
+ *
5
+ * 根據工作區根目錄自動查找並更新指定套件的 Changelog
6
+ * Automatically finds and updates changelog for specified package based on workspace root
7
+ */
1
8
  import { IListableRow } from 'ws-pkg-list';
2
9
  import { IOptionsWithType, IOptionsUpdateChangelog } from '../types';
10
+ /**
11
+ * 根據工作目錄更新 Changelog
12
+ * Update changelog based on working directory
13
+ *
14
+ * @param {string} [cwd] - 工作目錄 / Working directory
15
+ * @param {Partial<IOptionsWithType<IOptionsUpdateChangelog>>} [options] - 更新選項 / Update options
16
+ * @returns {Promise<object>} 包含更新結果和元資訊的物件 / Object containing update result and metadata
17
+ */
3
18
  export declare function updateChangelogByCwd(cwd?: string, options?: Partial<IOptionsWithType<IOptionsUpdateChangelog>>): Promise<{
4
19
  cwd: string;
5
20
  rootPath: string;
@@ -9,4 +24,8 @@ export declare function updateChangelogByCwd(cwd?: string, options?: Partial<IOp
9
24
  newEntry: string;
10
25
  version: string;
11
26
  }>;
27
+ /**
28
+ * 預設匯出函數
29
+ * Default export function
30
+ */
12
31
  export default updateChangelogByCwd;
@@ -1,4 +1,11 @@
1
1
  "use strict";
2
+ /**
3
+ * 基於套件列表更新 Changelog 模組
4
+ * Update Changelog Based on Package List Module
5
+ *
6
+ * 根據工作區根目錄自動查找並更新指定套件的 Changelog
7
+ * Automatically finds and updates changelog for specified package based on workspace root
8
+ */
2
9
  Object.defineProperty(exports, "__esModule", { value: true });
3
10
  exports.updateChangelogByCwd = updateChangelogByCwd;
4
11
  const tslib_1 = require("tslib");
@@ -6,23 +13,59 @@ const ws_pkg_list_1 = require("ws-pkg-list");
6
13
  const find_root_1 = require("@yarn-tool/find-root");
7
14
  const update_1 = tslib_1.__importDefault(require("./update"));
8
15
  const lodash_1 = require("lodash");
16
+ /**
17
+ * 根據工作目錄更新 Changelog
18
+ * Update changelog based on working directory
19
+ *
20
+ * @param {string} [cwd] - 工作目錄 / Working directory
21
+ * @param {Partial<IOptionsWithType<IOptionsUpdateChangelog>>} [options] - 更新選項 / Update options
22
+ * @returns {Promise<object>} 包含更新結果和元資訊的物件 / Object containing update result and metadata
23
+ */
9
24
  function updateChangelogByCwd(cwd, options) {
25
+ /**
26
+ * 查找工作區根資訊
27
+ * Find workspace root information
28
+ */
10
29
  let rootData = (0, find_root_1.findRoot)({
11
30
  cwd: cwd !== null && cwd !== void 0 ? cwd : process.cwd(),
12
31
  });
32
+ /**
33
+ * 禁止在工作區根目錄建立 Changelog
34
+ * Disallow creating changelog in workspace root
35
+ */
13
36
  if (rootData.hasWorkspace && rootData.isWorkspace) {
14
37
  throw new Error(`disallow create changelog for workspace root`);
15
38
  }
39
+ /**
40
+ * 設定實際的套件目錄
41
+ * Set actual package directory
42
+ */
16
43
  cwd = rootData.pkg;
44
+ /**
45
+ * 從路徑獲取套件資訊
46
+ * Get package info from path
47
+ */
17
48
  let pkg = (0, ws_pkg_list_1.wsPkgListableFromPaths)([
18
49
  rootData.pkg,
19
50
  ])[0];
51
+ /**
52
+ * 合併選項
53
+ * Merge options
54
+ */
20
55
  options = {
21
56
  ...options,
22
57
  };
58
+ /**
59
+ * 設定預設選項值
60
+ * Set default option values
61
+ */
23
62
  options = (0, lodash_1.defaults)(options !== null && options !== void 0 ? options : {}, {
24
63
  rootPath: rootData.root,
25
64
  });
65
+ /**
66
+ * 執行更新並返回結果
67
+ * Execute update and return result
68
+ */
26
69
  return (0, update_1.default)(pkg, options)
27
70
  .then(data => {
28
71
  return {
@@ -34,5 +77,9 @@ function updateChangelogByCwd(cwd, options) {
34
77
  };
35
78
  });
36
79
  }
80
+ /**
81
+ * 預設匯出函數
82
+ * Default export function
83
+ */
37
84
  exports.default = updateChangelogByCwd;
38
85
  //# sourceMappingURL=from-list.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"from-list.js","sourceRoot":"","sources":["from-list.ts"],"names":[],"mappings":";;AAMA,oDAoCC;;AA1CD,6CAAmE;AAEnE,oDAAgD;AAChD,8DAAuC;AACvC,mCAAkC;AAElC,SAAgB,oBAAoB,CAAC,GAAY,EAAE,OAA4D;IAE9G,IAAI,QAAQ,GAAG,IAAA,oBAAQ,EAAC;QACvB,GAAG,EAAE,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,OAAO,CAAC,GAAG,EAAE;KACzB,CAAC,CAAA;IAEF,IAAI,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,WAAW,EACjD,CAAC;QACA,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IAChE,CAAC;IAED,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;IAEnB,IAAI,GAAG,GAAG,IAAA,oCAAsB,EAAC;QAChC,QAAQ,CAAC,GAAG;KACZ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEN,OAAO,GAAG;QACT,GAAG,OAAO;KACV,CAAA;IAED,OAAO,GAAG,IAAA,iBAAQ,EAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,EAAE;QACjC,QAAQ,EAAE,QAAQ,CAAC,IAAI;KACvB,CAAC,CAAC;IAEH,OAAO,IAAA,gBAAe,EAAC,GAAG,EAAE,OAAc,CAAC;SACzC,IAAI,CAAC,IAAI,CAAC,EAAE;QACZ,OAAO;YACN,GAAG,IAAI;YACP,GAAG;YACH,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO;YACP,GAAG;SACH,CAAA;IACF,CAAC,CAAC,CACF;AACF,CAAC;AAED,kBAAe,oBAAoB,CAAA","sourcesContent":["import { IListableRow, wsPkgListableFromPaths } from 'ws-pkg-list';\nimport { IOptionsWithType, IOptionsUpdateChangelog } from '../types';\nimport { findRoot } from '@yarn-tool/find-root';\nimport updateChangelog from './update';\nimport { defaults } from 'lodash';\n\nexport function updateChangelogByCwd(cwd?: string, options?: Partial<IOptionsWithType<IOptionsUpdateChangelog>>)\n{\n\tlet rootData = findRoot({\n\t\tcwd: cwd ?? process.cwd(),\n\t})\n\n\tif (rootData.hasWorkspace && rootData.isWorkspace)\n\t{\n\t\tthrow new Error(`disallow create changelog for workspace root`)\n\t}\n\n\tcwd = rootData.pkg;\n\n\tlet pkg = wsPkgListableFromPaths([\n\t\trootData.pkg,\n\t])[0];\n\n\toptions = {\n\t\t...options,\n\t}\n\n\toptions = defaults(options ?? {}, {\n\t\trootPath: rootData.root,\n\t});\n\n\treturn updateChangelog(pkg, options as any)\n\t\t.then(data => {\n\t\t\treturn {\n\t\t\t\t...data,\n\t\t\t\tcwd,\n\t\t\t\trootPath: options.rootPath,\n\t\t\t\toptions,\n\t\t\t\tpkg,\n\t\t\t}\n\t\t})\n\t;\n}\n\nexport default updateChangelogByCwd\n"]}
1
+ {"version":3,"file":"from-list.js","sourceRoot":"","sources":["from-list.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAgBH,oDAgEC;;AA9ED,6CAAmE;AAEnE,oDAAgD;AAChD,8DAAuC;AACvC,mCAAkC;AAElC;;;;;;;GAOG;AACH,SAAgB,oBAAoB,CAAC,GAAY,EAAE,OAA4D;IAE9G;;;OAGG;IACH,IAAI,QAAQ,GAAG,IAAA,oBAAQ,EAAC;QACvB,GAAG,EAAE,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,OAAO,CAAC,GAAG,EAAE;KACzB,CAAC,CAAA;IAEF;;;OAGG;IACH,IAAI,QAAQ,CAAC,YAAY,IAAI,QAAQ,CAAC,WAAW,EACjD,CAAC;QACA,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;IAChE,CAAC;IAED;;;OAGG;IACH,GAAG,GAAG,QAAQ,CAAC,GAAG,CAAC;IAEnB;;;OAGG;IACH,IAAI,GAAG,GAAG,IAAA,oCAAsB,EAAC;QAChC,QAAQ,CAAC,GAAG;KACZ,CAAC,CAAC,CAAC,CAAC,CAAC;IAEN;;;OAGG;IACH,OAAO,GAAG;QACT,GAAG,OAAO;KACV,CAAA;IAED;;;OAGG;IACH,OAAO,GAAG,IAAA,iBAAQ,EAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAE,EAAE;QACjC,QAAQ,EAAE,QAAQ,CAAC,IAAI;KACvB,CAAC,CAAC;IAEH;;;OAGG;IACH,OAAO,IAAA,gBAAe,EAAC,GAAG,EAAE,OAAc,CAAC;SACzC,IAAI,CAAC,IAAI,CAAC,EAAE;QACZ,OAAO;YACN,GAAG,IAAI;YACP,GAAG;YACH,QAAQ,EAAE,OAAO,CAAC,QAAQ;YAC1B,OAAO;YACP,GAAG;SACH,CAAA;IACF,CAAC,CAAC,CACF;AACF,CAAC;AAED;;;GAGG;AACH,kBAAe,oBAAoB,CAAA","sourcesContent":["/**\n * 基於套件列表更新 Changelog 模組\n * Update Changelog Based on Package List Module\n *\n * 根據工作區根目錄自動查找並更新指定套件的 Changelog\n * Automatically finds and updates changelog for specified package based on workspace root\n */\n\nimport { IListableRow, wsPkgListableFromPaths } from 'ws-pkg-list';\nimport { IOptionsWithType, IOptionsUpdateChangelog } from '../types';\nimport { findRoot } from '@yarn-tool/find-root';\nimport updateChangelog from './update';\nimport { defaults } from 'lodash';\n\n/**\n * 根據工作目錄更新 Changelog\n * Update changelog based on working directory\n *\n * @param {string} [cwd] - 工作目錄 / Working directory\n * @param {Partial<IOptionsWithType<IOptionsUpdateChangelog>>} [options] - 更新選項 / Update options\n * @returns {Promise<object>} 包含更新結果和元資訊的物件 / Object containing update result and metadata\n */\nexport function updateChangelogByCwd(cwd?: string, options?: Partial<IOptionsWithType<IOptionsUpdateChangelog>>)\n{\n\t/**\n\t * 查找工作區根資訊\n\t * Find workspace root information\n\t */\n\tlet rootData = findRoot({\n\t\tcwd: cwd ?? process.cwd(),\n\t})\n\n\t/**\n\t * 禁止在工作區根目錄建立 Changelog\n\t * Disallow creating changelog in workspace root\n\t */\n\tif (rootData.hasWorkspace && rootData.isWorkspace)\n\t{\n\t\tthrow new Error(`disallow create changelog for workspace root`)\n\t}\n\n\t/**\n\t * 設定實際的套件目錄\n\t * Set actual package directory\n\t */\n\tcwd = rootData.pkg;\n\n\t/**\n\t * 從路徑獲取套件資訊\n\t * Get package info from path\n\t */\n\tlet pkg = wsPkgListableFromPaths([\n\t\trootData.pkg,\n\t])[0];\n\n\t/**\n\t * 合併選項\n\t * Merge options\n\t */\n\toptions = {\n\t\t...options,\n\t}\n\n\t/**\n\t * 設定預設選項值\n\t * Set default option values\n\t */\n\toptions = defaults(options ?? {}, {\n\t\trootPath: rootData.root,\n\t});\n\n\t/**\n\t * 執行更新並返回結果\n\t * Execute update and return result\n\t */\n\treturn updateChangelog(pkg, options as any)\n\t\t.then(data => {\n\t\t\treturn {\n\t\t\t\t...data,\n\t\t\t\tcwd,\n\t\t\t\trootPath: options.rootPath,\n\t\t\t\toptions,\n\t\t\t\tpkg,\n\t\t\t}\n\t\t})\n\t;\n}\n\n/**\n * 預設匯出函數\n * Default export function\n */\nexport default updateChangelogByCwd\n"]}
@@ -1,4 +1,26 @@
1
+ /**
2
+ * 版本推薦模組
3
+ * Version Recommendation Module
4
+ *
5
+ * 根據 conventional commits 分析推薦下一個版本號
6
+ * Recommends next version based on conventional commits analysis
7
+ */
1
8
  import { IListableRow } from 'ws-pkg-list';
2
9
  import { IOptionsRecommendVersion, IOptionsWithType } from '../types';
10
+ /**
11
+ * 推薦套件的下個版本號
12
+ * Recommend next version for package
13
+ *
14
+ * 分析 Git 歷史中的 conventional commits 來決定版本遞增類型
15
+ * Analyzes conventional commits in Git history to determine version bump type
16
+ *
17
+ * @param {IListableRow} pkg - 套件資訊 / Package information
18
+ * @param {IOptionsWithType<IOptionsRecommendVersion>} [options] - 推薦選項 / Recommendation options
19
+ * @returns {Promise<string>} 推薦的版本號 / Recommended version
20
+ */
3
21
  export declare function recommendVersion(pkg: IListableRow, options?: IOptionsWithType<IOptionsRecommendVersion>): Promise<string>;
22
+ /**
23
+ * 預設匯出推薦函數
24
+ * Default export recommendation function
25
+ */
4
26
  export default recommendVersion;
@@ -1,11 +1,41 @@
1
1
  "use strict";
2
+ /**
3
+ * 版本推薦模組
4
+ * Version Recommendation Module
5
+ *
6
+ * 根據 conventional commits 分析推薦下一個版本號
7
+ * Recommends next version based on conventional commits analysis
8
+ */
2
9
  Object.defineProperty(exports, "__esModule", { value: true });
3
10
  exports.recommendVersion = recommendVersion;
4
11
  const recommend_version_1 = require("@lerna/conventional-commits/lib/recommend-version");
5
12
  const util_1 = require("./util");
13
+ /**
14
+ * 推薦套件的下個版本號
15
+ * Recommend next version for package
16
+ *
17
+ * 分析 Git 歷史中的 conventional commits 來決定版本遞增類型
18
+ * Analyzes conventional commits in Git history to determine version bump type
19
+ *
20
+ * @param {IListableRow} pkg - 套件資訊 / Package information
21
+ * @param {IOptionsWithType<IOptionsRecommendVersion>} [options] - 推薦選項 / Recommendation options
22
+ * @returns {Promise<string>} 推薦的版本號 / Recommended version
23
+ */
6
24
  function recommendVersion(pkg, options) {
25
+ /**
26
+ * 處理並標準化選項
27
+ * Process and normalize options
28
+ */
7
29
  options = (0, util_1.handleOptions)(options);
30
+ /**
31
+ * 呼叫 @lerna/conventional-commits 獲取推薦版本
32
+ * Call @lerna/conventional-commits to get recommended version
33
+ */
8
34
  return (0, recommend_version_1.recommendVersion)(pkg, options.type, options);
9
35
  }
36
+ /**
37
+ * 預設匯出推薦函數
38
+ * Default export recommendation function
39
+ */
10
40
  exports.default = recommendVersion;
11
41
  //# sourceMappingURL=recommend.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"recommend.js","sourceRoot":"","sources":["recommend.ts"],"names":[],"mappings":";;AAKA,4CAKC;AARD,yFAA0G;AAC1G,iCAAuC;AAEvC,SAAgB,gBAAgB,CAAC,GAAiB,EAAE,OAAoD;IAEvG,OAAO,GAAG,IAAA,oBAAa,EAAC,OAAO,CAAC,CAAA;IAEhC,OAAO,IAAA,oCAAiB,EAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AACrD,CAAC;AAED,kBAAe,gBAAgB,CAAA","sourcesContent":["import { IListableRow } from 'ws-pkg-list';\nimport { IType, IOptionsRecommendVersion, IOptionsWithType, IOptionsUpdateChangelog } from '../types';\nimport { recommendVersion as _recommendVersion } from '@lerna/conventional-commits/lib/recommend-version';\nimport { handleOptions } from './util';\n\nexport function recommendVersion(pkg: IListableRow, options?: IOptionsWithType<IOptionsRecommendVersion>): Promise<string>\n{\n\toptions = handleOptions(options)\n\n\treturn _recommendVersion(pkg, options.type, options)\n}\n\nexport default recommendVersion\n"]}
1
+ {"version":3,"file":"recommend.js","sourceRoot":"","sources":["recommend.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAkBH,4CAaC;AA3BD,yFAA0G;AAC1G,iCAAuC;AAEvC;;;;;;;;;;GAUG;AACH,SAAgB,gBAAgB,CAAC,GAAiB,EAAE,OAAoD;IAEvG;;;OAGG;IACH,OAAO,GAAG,IAAA,oBAAa,EAAC,OAAO,CAAC,CAAA;IAEhC;;;OAGG;IACH,OAAO,IAAA,oCAAiB,EAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;AACrD,CAAC;AAED;;;GAGG;AACH,kBAAe,gBAAgB,CAAA","sourcesContent":["/**\n * 版本推薦模組\n * Version Recommendation Module\n *\n * 根據 conventional commits 分析推薦下一個版本號\n * Recommends next version based on conventional commits analysis\n */\n\nimport { IListableRow } from 'ws-pkg-list';\nimport { IType, IOptionsRecommendVersion, IOptionsWithType, IOptionsUpdateChangelog } from '../types';\nimport { recommendVersion as _recommendVersion } from '@lerna/conventional-commits/lib/recommend-version';\nimport { handleOptions } from './util';\n\n/**\n * 推薦套件的下個版本號\n * Recommend next version for package\n *\n * 分析 Git 歷史中的 conventional commits 來決定版本遞增類型\n * Analyzes conventional commits in Git history to determine version bump type\n *\n * @param {IListableRow} pkg - 套件資訊 / Package information\n * @param {IOptionsWithType<IOptionsRecommendVersion>} [options] - 推薦選項 / Recommendation options\n * @returns {Promise<string>} 推薦的版本號 / Recommended version\n */\nexport function recommendVersion(pkg: IListableRow, options?: IOptionsWithType<IOptionsRecommendVersion>): Promise<string>\n{\n\t/**\n\t * 處理並標準化選項\n\t * Process and normalize options\n\t */\n\toptions = handleOptions(options)\n\n\t/**\n\t * 呼叫 @lerna/conventional-commits 獲取推薦版本\n\t * Call @lerna/conventional-commits to get recommended version\n\t */\n\treturn _recommendVersion(pkg, options.type, options)\n}\n\n/**\n * 預設匯出推薦函數\n * Default export recommendation function\n */\nexport default recommendVersion\n"]}
@@ -1,4 +1,23 @@
1
+ /**
2
+ * Changelog 更新模組
3
+ * Changelog Update Module
4
+ *
5
+ * 使用 conventional commits 更新套件的 CHANGELOG.md
6
+ * Updates package CHANGELOG.md using conventional commits
7
+ */
1
8
  import { IListableRow } from 'ws-pkg-list';
2
9
  import { IOptionsUpdateChangelog, IOptionsWithType, IReturnTypeUpdateChangelog } from '../types';
10
+ /**
11
+ * 更新指定套件的 Changelog
12
+ * Update changelog for specified package
13
+ *
14
+ * @param {IListableRow} pkg - 套件資訊 / Package information
15
+ * @param {IOptionsWithType<IOptionsUpdateChangelog>} [options] - 更新選項 / Update options
16
+ * @returns {Promise<IReturnTypeUpdateChangelog>} 更新結果 / Update result
17
+ */
3
18
  export declare function updateChangelog(pkg: IListableRow, options?: IOptionsWithType<IOptionsUpdateChangelog>): Promise<IReturnTypeUpdateChangelog>;
19
+ /**
20
+ * 預設匯出更新函數
21
+ * Default export update function
22
+ */
4
23
  export default updateChangelog;
@@ -1,14 +1,41 @@
1
1
  "use strict";
2
+ /**
3
+ * Changelog 更新模組
4
+ * Changelog Update Module
5
+ *
6
+ * 使用 conventional commits 更新套件的 CHANGELOG.md
7
+ * Updates package CHANGELOG.md using conventional commits
8
+ */
2
9
  Object.defineProperty(exports, "__esModule", { value: true });
3
10
  exports.updateChangelog = updateChangelog;
4
11
  const update_changelog_1 = require("@lerna/conventional-commits/lib/update-changelog");
5
12
  const util_1 = require("./util");
6
13
  const upath2_1 = require("upath2");
14
+ /**
15
+ * 更新指定套件的 Changelog
16
+ * Update changelog for specified package
17
+ *
18
+ * @param {IListableRow} pkg - 套件資訊 / Package information
19
+ * @param {IOptionsWithType<IOptionsUpdateChangelog>} [options] - 更新選項 / Update options
20
+ * @returns {Promise<IReturnTypeUpdateChangelog>} 更新結果 / Update result
21
+ */
7
22
  function updateChangelog(pkg, options) {
8
23
  var _a;
24
+ /**
25
+ * 處理並標準化選項
26
+ * Process and normalize options
27
+ */
9
28
  options = (0, util_1.handleOptions)(options);
29
+ /**
30
+ * 設定版本號,優先使用選項中的版本,否則使用套件目前版本
31
+ * Set version, prioritize option version or use package current version
32
+ */
10
33
  let version = (_a = options.version) !== null && _a !== void 0 ? _a : pkg.version;
11
34
  options.version = version;
35
+ /**
36
+ * 呼叫 @lerna/conventional-commits 更新 Changelog
37
+ * Call @lerna/conventional-commits to update changelog
38
+ */
12
39
  return (0, update_changelog_1.updateChangelog)({
13
40
  ...pkg,
14
41
  version,
@@ -16,10 +43,18 @@ function updateChangelog(pkg, options) {
16
43
  .then((data) => {
17
44
  return {
18
45
  ...data,
46
+ /**
47
+ * 標準化日誌路徑
48
+ * Normalize log path
49
+ */
19
50
  logPath: (0, upath2_1.normalize)(data.logPath),
20
51
  version,
21
52
  };
22
53
  });
23
54
  }
55
+ /**
56
+ * 預設匯出更新函數
57
+ * Default export update function
58
+ */
24
59
  exports.default = updateChangelog;
25
60
  //# sourceMappingURL=update.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"update.js","sourceRoot":"","sources":["update.ts"],"names":[],"mappings":";;AAMA,0CAmBC;AAvBD,uFAAuG;AACvG,iCAAuC;AACvC,mCAAmC;AAEnC,SAAgB,eAAe,CAAC,GAAiB,EAAE,OAAmD;;IAErG,OAAO,GAAG,IAAA,oBAAa,EAAC,OAAO,CAAC,CAAA;IAEhC,IAAI,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,GAAG,CAAC,OAAO,CAAC;IAC7C,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1B,OAAO,IAAA,kCAAgB,EAAC;QACvB,GAAG,GAAG;QACN,OAAO;KACP,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;SACvB,IAAI,CAAC,CAAC,IAAgC,EAAE,EAAE;QAC1C,OAAO;YACN,GAAG,IAAI;YACP,OAAO,EAAE,IAAA,kBAAS,EAAC,IAAI,CAAC,OAAO,CAAC;YAChC,OAAO;SACP,CAAA;IACF,CAAC,CAAC,CACF;AACF,CAAC;AAED,kBAAe,eAAe,CAAA","sourcesContent":["import { IListableRow } from 'ws-pkg-list';\nimport { IOptionsUpdateChangelog, IOptionsWithType, IReturnTypeUpdateChangelog } from '../types';\nimport { updateChangelog as _updateChangelog } from '@lerna/conventional-commits/lib/update-changelog';\nimport { handleOptions } from './util';\nimport { normalize } from 'upath2';\n\nexport function updateChangelog(pkg: IListableRow, options?: IOptionsWithType<IOptionsUpdateChangelog>): Promise<IReturnTypeUpdateChangelog>\n{\n\toptions = handleOptions(options)\n\n\tlet version = options.version ?? pkg.version;\n\toptions.version = version;\n\n\treturn _updateChangelog({\n\t\t...pkg,\n\t\tversion,\n\t}, options.type, options)\n\t\t.then((data: IReturnTypeUpdateChangelog) => {\n\t\t\treturn {\n\t\t\t\t...data,\n\t\t\t\tlogPath: normalize(data.logPath),\n\t\t\t\tversion,\n\t\t\t}\n\t\t})\n\t;\n}\n\nexport default updateChangelog\n"]}
1
+ {"version":3,"file":"update.js","sourceRoot":"","sources":["update.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAgBH,0CAmCC;AA/CD,uFAAuG;AACvG,iCAAuC;AACvC,mCAAmC;AAEnC;;;;;;;GAOG;AACH,SAAgB,eAAe,CAAC,GAAiB,EAAE,OAAmD;;IAErG;;;OAGG;IACH,OAAO,GAAG,IAAA,oBAAa,EAAC,OAAO,CAAC,CAAA;IAEhC;;;OAGG;IACH,IAAI,OAAO,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,GAAG,CAAC,OAAO,CAAC;IAC7C,OAAO,CAAC,OAAO,GAAG,OAAO,CAAC;IAE1B;;;OAGG;IACH,OAAO,IAAA,kCAAgB,EAAC;QACvB,GAAG,GAAG;QACN,OAAO;KACP,EAAE,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;SACvB,IAAI,CAAC,CAAC,IAAgC,EAAE,EAAE;QAC1C,OAAO;YACN,GAAG,IAAI;YACP;;;eAGG;YACH,OAAO,EAAE,IAAA,kBAAS,EAAC,IAAI,CAAC,OAAO,CAAC;YAChC,OAAO;SACP,CAAA;IACF,CAAC,CAAC,CACF;AACF,CAAC;AAED;;;GAGG;AACH,kBAAe,eAAe,CAAA","sourcesContent":["/**\n * Changelog 更新模組\n * Changelog Update Module\n *\n * 使用 conventional commits 更新套件的 CHANGELOG.md\n * Updates package CHANGELOG.md using conventional commits\n */\n\nimport { IListableRow } from 'ws-pkg-list';\nimport { IOptionsUpdateChangelog, IOptionsWithType, IReturnTypeUpdateChangelog } from '../types';\nimport { updateChangelog as _updateChangelog } from '@lerna/conventional-commits/lib/update-changelog';\nimport { handleOptions } from './util';\nimport { normalize } from 'upath2';\n\n/**\n * 更新指定套件的 Changelog\n * Update changelog for specified package\n *\n * @param {IListableRow} pkg - 套件資訊 / Package information\n * @param {IOptionsWithType<IOptionsUpdateChangelog>} [options] - 更新選項 / Update options\n * @returns {Promise<IReturnTypeUpdateChangelog>} 更新結果 / Update result\n */\nexport function updateChangelog(pkg: IListableRow, options?: IOptionsWithType<IOptionsUpdateChangelog>): Promise<IReturnTypeUpdateChangelog>\n{\n\t/**\n\t * 處理並標準化選項\n\t * Process and normalize options\n\t */\n\toptions = handleOptions(options)\n\n\t/**\n\t * 設定版本號,優先使用選項中的版本,否則使用套件目前版本\n\t * Set version, prioritize option version or use package current version\n\t */\n\tlet version = options.version ?? pkg.version;\n\toptions.version = version;\n\n\t/**\n\t * 呼叫 @lerna/conventional-commits 更新 Changelog\n\t * Call @lerna/conventional-commits to update changelog\n\t */\n\treturn _updateChangelog({\n\t\t...pkg,\n\t\tversion,\n\t}, options.type, options)\n\t\t.then((data: IReturnTypeUpdateChangelog) => {\n\t\t\treturn {\n\t\t\t\t...data,\n\t\t\t\t/**\n\t\t\t\t * 標準化日誌路徑\n\t\t\t\t * Normalize log path\n\t\t\t\t */\n\t\t\t\tlogPath: normalize(data.logPath),\n\t\t\t\tversion,\n\t\t\t}\n\t\t})\n\t;\n}\n\n/**\n * 預設匯出更新函數\n * Default export update function\n */\nexport default updateChangelog\n"]}
@@ -1,2 +1,19 @@
1
+ /**
2
+ * Lerna Changelog 工具函數模組
3
+ * Lerna Changelog Utility Functions Module
4
+ *
5
+ * 處理選項的預設值和規範解析
6
+ * Handles option defaults and preset resolution
7
+ */
1
8
  import { IOptionsWithType, IOptionsUpdateChangelog, IOptionsRecommendVersion } from '../types';
9
+ /**
10
+ * 處理並標準化選項
11
+ * Process and normalize options
12
+ *
13
+ * 設定預設值並解析 changelog 預設規範
14
+ * Sets defaults and resolves changelog preset
15
+ *
16
+ * @param {IOptionsWithType<T>} [options] - 輸入選項 / Input options
17
+ * @returns {IOptionsWithType<T>} 標準化後的選項 / Normalized options
18
+ */
2
19
  export declare function handleOptions<T extends IOptionsRecommendVersion | IOptionsUpdateChangelog>(options?: IOptionsWithType<T>): IOptionsWithType<T>;
package/lib/lerna/util.js CHANGED
@@ -1,26 +1,67 @@
1
1
  "use strict";
2
+ /**
3
+ * Lerna Changelog 工具函數模組
4
+ * Lerna Changelog Utility Functions Module
5
+ *
6
+ * 處理選項的預設值和規範解析
7
+ * Handles option defaults and preset resolution
8
+ */
2
9
  Object.defineProperty(exports, "__esModule", { value: true });
3
10
  exports.handleOptions = handleOptions;
4
11
  const lodash_1 = require("lodash");
5
12
  const require_resolve_1 = require("@yarn-tool/require-resolve");
6
13
  const path_1 = require("path");
14
+ /**
15
+ * 處理並標準化選項
16
+ * Process and normalize options
17
+ *
18
+ * 設定預設值並解析 changelog 預設規範
19
+ * Sets defaults and resolves changelog preset
20
+ *
21
+ * @param {IOptionsWithType<T>} [options] - 輸入選項 / Input options
22
+ * @returns {IOptionsWithType<T>} 標準化後的選項 / Normalized options
23
+ */
7
24
  function handleOptions(options) {
8
25
  var _a, _b;
26
+ /**
27
+ * 預設的 Changelog 規範
28
+ * Default changelog preset
29
+ */
9
30
  const defaultChangelogPreset = '@bluelovers/conventional-changelog-bluelovers';
31
+ /**
32
+ * 設定預設選項值
33
+ * Set default option values
34
+ */
10
35
  options = (0, lodash_1.defaults)(options !== null && options !== void 0 ? options : {}, {
11
36
  type: 'independent',
12
37
  changelogPreset: void 0,
13
38
  tagPrefix: 'v',
14
39
  });
40
+ /**
41
+ * 確保 type 有有效值
42
+ * Ensure type has valid value
43
+ */
15
44
  if (typeof options.type !== 'string' || !options.type.length) {
16
45
  options.type = 'independent';
17
46
  }
47
+ /**
48
+ * 確保 tagPrefix 為字串
49
+ * Ensure tagPrefix is string
50
+ */
18
51
  if (typeof options.tagPrefix !== 'string') {
19
52
  options.tagPrefix = 'v';
20
53
  }
54
+ /**
55
+ * 處理空的 changelogPreset
56
+ * Handle empty changelogPreset
57
+ */
21
58
  if (typeof options.changelogPreset !== 'string' || !options.changelogPreset.length || !Boolean(options.changelogPreset)) {
22
59
  options.changelogPreset = void 0;
23
60
  }
61
+ /**
62
+ * 解析預設規範的路徑
63
+ * Resolve default preset path
64
+ */
24
65
  if (!options.changelogPreset || options.changelogPreset === defaultChangelogPreset) {
25
66
  options.changelogPreset = (_a = (0, require_resolve_1.requireResolveExtra)(defaultChangelogPreset, {
26
67
  includeGlobal: true,
@@ -30,9 +71,20 @@ function handleOptions(options) {
30
71
  ],
31
72
  }).result) !== null && _a !== void 0 ? _a : options.changelogPreset;
32
73
  }
74
+ /**
75
+ * 若仍未設定,使用 angular 作為後備
76
+ * Fallback to angular if still not set
77
+ */
33
78
  (_b = options.changelogPreset) !== null && _b !== void 0 ? _b : (options.changelogPreset = 'conventional-changelog-angular');
34
79
  return options;
35
80
  }
81
+ /**
82
+ * 嘗試載入指定模組
83
+ * Try to require specified module
84
+ *
85
+ * @param {IChangelogPreset} name - 模組名稱 / Module name
86
+ * @returns {any} 模組導出內容 / Module exports
87
+ */
36
88
  function tryRequire(name) {
37
89
  try {
38
90
  return (0, require_resolve_1.requireResolveCore)(name, {
@@ -1 +1 @@
1
- {"version":3,"file":"util.js","sourceRoot":"","sources":["util.ts"],"names":[],"mappings":";;AAWA,sCAuCC;AA3CD,mCAAkC;AAClC,gEAAqF;AACrF,+BAA4B;AAE5B,SAAgB,aAAa,CAA+D,OAA6B;;IAExH,MAAM,sBAAsB,GAAG,+CAAwD,CAAC;IAExF,OAAO,GAAG,IAAA,iBAAQ,EAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAU,EAAkC;QACzE,IAAI,EAAE,aAAa;QACnB,eAAe,EAAE,KAAK,CAAC;QACvB,SAAS,EAAE,GAAG;KACd,CAAC,CAAA;IAEF,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAC5D,CAAC;QACA,OAAO,CAAC,IAAI,GAAG,aAAa,CAAA;IAC7B,CAAC;IAED,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ,EACzC,CAAC;QACA,OAAO,CAAC,SAAS,GAAG,GAAG,CAAA;IACxB,CAAC;IAED,IAAI,OAAO,OAAO,CAAC,eAAe,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EACvH,CAAC;QACA,OAAO,CAAC,eAAe,GAAG,KAAK,CAAC,CAAC;IAClC,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,KAAK,sBAAsB,EAClF,CAAC;QACA,OAAO,CAAC,eAAe,GAAG,MAAA,IAAA,qCAAmB,EAAC,sBAAsB,EAAE;YACrE,aAAa,EAAE,IAAI;YACnB,uBAAuB,EAAE,IAAI;YAC7B,KAAK,EAAE;gBACN,IAAA,WAAI,EAAC,SAAS,EAAE,OAAO,CAAC;aACxB;SACD,CAAC,CAAC,MAAM,mCAAI,OAAO,CAAC,eAAe,CAAC;IACtC,CAAC;IAED,MAAA,OAAO,CAAC,eAAe,oCAAvB,OAAO,CAAC,eAAe,GAAK,gCAAgC,EAAC;IAE7D,OAAO,OAAO,CAAA;AACf,CAAC;AAED,SAAS,UAAU,CAAC,IAAsB;IAEzC,IACA,CAAC;QACA,OAAO,IAAA,oCAAkB,EAAC,IAAI,EAAE;YAC/B,aAAa,EAAE,IAAI;YACnB,uBAAuB,EAAE,IAAI;SAC7B,CAAC,CAAA;IACH,CAAC;IACD,OAAO,GAAG,EACV,CAAC;QACA,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EACnC,CAAC;YACA,MAAM,IAAI,GAAG,CAAA;QACd,CAAC;IACF,CAAC;AACF,CAAC","sourcesContent":["import {\n\tIOptionsWithType,\n\tIOptionsUpdateChangelog,\n\tIOptionsRecommendVersion,\n\tIOptionsBaseCore,\n\tIChangelogPreset, IOptionsBase,\n} from '../types';\nimport { defaults } from 'lodash';\nimport { requireResolveExtra, requireResolveCore } from '@yarn-tool/require-resolve';\nimport { join } from 'path';\n\nexport function handleOptions<T extends IOptionsRecommendVersion | IOptionsUpdateChangelog>(options?: IOptionsWithType<T>): IOptionsWithType<T>\n{\n\tconst defaultChangelogPreset = '@bluelovers/conventional-changelog-bluelovers' as const;\n\n\toptions = defaults(options ?? {} as null, <IOptionsWithType<IOptionsBase>>{\n\t\ttype: 'independent',\n\t\tchangelogPreset: void 0,\n\t\ttagPrefix: 'v',\n\t})\n\n\tif (typeof options.type !== 'string' || !options.type.length)\n\t{\n\t\toptions.type = 'independent'\n\t}\n\n\tif (typeof options.tagPrefix !== 'string')\n\t{\n\t\toptions.tagPrefix = 'v'\n\t}\n\n\tif (typeof options.changelogPreset !== 'string' || !options.changelogPreset.length || !Boolean(options.changelogPreset))\n\t{\n\t\toptions.changelogPreset = void 0;\n\t}\n\n\tif (!options.changelogPreset || options.changelogPreset === defaultChangelogPreset)\n\t{\n\t\toptions.changelogPreset = requireResolveExtra(defaultChangelogPreset, {\n\t\t\tincludeGlobal: true,\n\t\t\tincludeCurrentDirectory: true,\n\t\t\tpaths: [\n\t\t\t\tjoin(__dirname, '../..'),\n\t\t\t],\n\t\t}).result ?? options.changelogPreset;\n\t}\n\n\toptions.changelogPreset ??= 'conventional-changelog-angular';\n\n\treturn options\n}\n\nfunction tryRequire(name: IChangelogPreset)\n{\n\ttry\n\t{\n\t\treturn requireResolveCore(name, {\n\t\t\tincludeGlobal: true,\n\t\t\tincludeCurrentDirectory: true,\n\t\t})\n\t}\n\tcatch (err)\n\t{\n\t\tif (err.code !== \"MODULE_NOT_FOUND\")\n\t\t{\n\t\t\tthrow new err\n\t\t}\n\t}\n}\n"]}
1
+ {"version":3,"file":"util.js","sourceRoot":"","sources":["util.ts"],"names":[],"mappings":";AAAA;;;;;;GAMG;;AAuBH,sCAmEC;AAjFD,mCAAkC;AAClC,gEAAqF;AACrF,+BAA4B;AAE5B;;;;;;;;;GASG;AACH,SAAgB,aAAa,CAA+D,OAA6B;;IAExH;;;OAGG;IACH,MAAM,sBAAsB,GAAG,+CAAwD,CAAC;IAExF;;;OAGG;IACH,OAAO,GAAG,IAAA,iBAAQ,EAAC,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,EAAU,EAAkC;QACzE,IAAI,EAAE,aAAa;QACnB,eAAe,EAAE,KAAK,CAAC;QACvB,SAAS,EAAE,GAAG;KACd,CAAC,CAAA;IAEF;;;OAGG;IACH,IAAI,OAAO,OAAO,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAC5D,CAAC;QACA,OAAO,CAAC,IAAI,GAAG,aAAa,CAAA;IAC7B,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO,OAAO,CAAC,SAAS,KAAK,QAAQ,EACzC,CAAC;QACA,OAAO,CAAC,SAAS,GAAG,GAAG,CAAA;IACxB,CAAC;IAED;;;OAGG;IACH,IAAI,OAAO,OAAO,CAAC,eAAe,KAAK,QAAQ,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,MAAM,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,eAAe,CAAC,EACvH,CAAC;QACA,OAAO,CAAC,eAAe,GAAG,KAAK,CAAC,CAAC;IAClC,CAAC;IAED;;;OAGG;IACH,IAAI,CAAC,OAAO,CAAC,eAAe,IAAI,OAAO,CAAC,eAAe,KAAK,sBAAsB,EAClF,CAAC;QACA,OAAO,CAAC,eAAe,GAAG,MAAA,IAAA,qCAAmB,EAAC,sBAAsB,EAAE;YACrE,aAAa,EAAE,IAAI;YACnB,uBAAuB,EAAE,IAAI;YAC7B,KAAK,EAAE;gBACN,IAAA,WAAI,EAAC,SAAS,EAAE,OAAO,CAAC;aACxB;SACD,CAAC,CAAC,MAAM,mCAAI,OAAO,CAAC,eAAe,CAAC;IACtC,CAAC;IAED;;;OAGG;IACH,MAAA,OAAO,CAAC,eAAe,oCAAvB,OAAO,CAAC,eAAe,GAAK,gCAAgC,EAAC;IAE7D,OAAO,OAAO,CAAA;AACf,CAAC;AAED;;;;;;GAMG;AACH,SAAS,UAAU,CAAC,IAAsB;IAEzC,IACA,CAAC;QACA,OAAO,IAAA,oCAAkB,EAAC,IAAI,EAAE;YAC/B,aAAa,EAAE,IAAI;YACnB,uBAAuB,EAAE,IAAI;SAC7B,CAAC,CAAA;IACH,CAAC;IACD,OAAO,GAAG,EACV,CAAC;QACA,IAAI,GAAG,CAAC,IAAI,KAAK,kBAAkB,EACnC,CAAC;YACA,MAAM,IAAI,GAAG,CAAA;QACd,CAAC;IACF,CAAC;AACF,CAAC","sourcesContent":["/**\n * Lerna Changelog 工具函數模組\n * Lerna Changelog Utility Functions Module\n *\n * 處理選項的預設值和規範解析\n * Handles option defaults and preset resolution\n */\n\nimport {\n\tIOptionsWithType,\n\tIOptionsUpdateChangelog,\n\tIOptionsRecommendVersion,\n\tIOptionsBaseCore,\n\tIChangelogPreset, IOptionsBase,\n} from '../types';\nimport { defaults } from 'lodash';\nimport { requireResolveExtra, requireResolveCore } from '@yarn-tool/require-resolve';\nimport { join } from 'path';\n\n/**\n * 處理並標準化選項\n * Process and normalize options\n *\n * 設定預設值並解析 changelog 預設規範\n * Sets defaults and resolves changelog preset\n *\n * @param {IOptionsWithType<T>} [options] - 輸入選項 / Input options\n * @returns {IOptionsWithType<T>} 標準化後的選項 / Normalized options\n */\nexport function handleOptions<T extends IOptionsRecommendVersion | IOptionsUpdateChangelog>(options?: IOptionsWithType<T>): IOptionsWithType<T>\n{\n\t/**\n\t * 預設的 Changelog 規範\n\t * Default changelog preset\n\t */\n\tconst defaultChangelogPreset = '@bluelovers/conventional-changelog-bluelovers' as const;\n\n\t/**\n\t * 設定預設選項值\n\t * Set default option values\n\t */\n\toptions = defaults(options ?? {} as null, <IOptionsWithType<IOptionsBase>>{\n\t\ttype: 'independent',\n\t\tchangelogPreset: void 0,\n\t\ttagPrefix: 'v',\n\t})\n\n\t/**\n\t * 確保 type 有有效值\n\t * Ensure type has valid value\n\t */\n\tif (typeof options.type !== 'string' || !options.type.length)\n\t{\n\t\toptions.type = 'independent'\n\t}\n\n\t/**\n\t * 確保 tagPrefix 為字串\n\t * Ensure tagPrefix is string\n\t */\n\tif (typeof options.tagPrefix !== 'string')\n\t{\n\t\toptions.tagPrefix = 'v'\n\t}\n\n\t/**\n\t * 處理空的 changelogPreset\n\t * Handle empty changelogPreset\n\t */\n\tif (typeof options.changelogPreset !== 'string' || !options.changelogPreset.length || !Boolean(options.changelogPreset))\n\t{\n\t\toptions.changelogPreset = void 0;\n\t}\n\n\t/**\n\t * 解析預設規範的路徑\n\t * Resolve default preset path\n\t */\n\tif (!options.changelogPreset || options.changelogPreset === defaultChangelogPreset)\n\t{\n\t\toptions.changelogPreset = requireResolveExtra(defaultChangelogPreset, {\n\t\t\tincludeGlobal: true,\n\t\t\tincludeCurrentDirectory: true,\n\t\t\tpaths: [\n\t\t\t\tjoin(__dirname, '../..'),\n\t\t\t],\n\t\t}).result ?? options.changelogPreset;\n\t}\n\n\t/**\n\t * 若仍未設定,使用 angular 作為後備\n\t * Fallback to angular if still not set\n\t */\n\toptions.changelogPreset ??= 'conventional-changelog-angular';\n\n\treturn options\n}\n\n/**\n * 嘗試載入指定模組\n * Try to require specified module\n *\n * @param {IChangelogPreset} name - 模組名稱 / Module name\n * @returns {any} 模組導出內容 / Module exports\n */\nfunction tryRequire(name: IChangelogPreset)\n{\n\ttry\n\t{\n\t\treturn requireResolveCore(name, {\n\t\t\tincludeGlobal: true,\n\t\t\tincludeCurrentDirectory: true,\n\t\t})\n\t}\n\tcatch (err)\n\t{\n\t\tif (err.code !== \"MODULE_NOT_FOUND\")\n\t\t{\n\t\t\tthrow new err\n\t\t}\n\t}\n}\n"]}
package/lib/types.d.ts CHANGED
@@ -1,28 +1,115 @@
1
1
  /**
2
+ * Changelog 類型定義模組
3
+ * Changelog Type Definitions Module
4
+ *
5
+ * 定義 conventional changelog 相關的介面和類型
6
+ * Defines interfaces and types for conventional changelog
7
+ *
2
8
  * Created by user on 2020/6/15.
3
9
  */
4
10
  import { ITSRequireAtLeastOne } from 'ts-type';
11
+ /**
12
+ * 預設的 Changelog 規範類型
13
+ * Changelog preset types
14
+ *
15
+ * 支援的預設規範:angular, atom, codemirror 等
16
+ * Supported presets: angular, atom, codemirror, etc.
17
+ */
5
18
  export type IChangelogPreset = string | "conventional-changelog-angular" | "@bluelovers/conventional-changelog-bluelovers";
19
+ /**
20
+ * Changelog 類型
21
+ * Changelog type
22
+ *
23
+ * - independent: 獨立版本模式 (每個套件有自己的版本)
24
+ * - root: 根目錄模式 (所有套件共用一個版本)
25
+ */
6
26
  export type IType = "independent" | "root" | string;
27
+ /**
28
+ * 基礎選項核心介面
29
+ * Base options core interface
30
+ */
7
31
  export interface IOptionsBaseCore {
32
+ /**
33
+ * 使用的 Changelog 預設規範
34
+ * Changelog preset to use
35
+ */
8
36
  changelogPreset?: IChangelogPreset;
37
+ /**
38
+ * 工作區根目錄路徑
39
+ * Workspace root path
40
+ */
9
41
  rootPath?: string;
10
42
  }
43
+ /**
44
+ * 基礎選項介面
45
+ * Base options interface
46
+ */
11
47
  export interface IOptionsBase extends IOptionsBaseCore {
48
+ /**
49
+ * 標籤前綴,預設為 'v'
50
+ * Tag prefix, default is 'v'
51
+ */
12
52
  tagPrefix?: string | 'v';
13
53
  }
54
+ /**
55
+ * 輸入選項類型
56
+ * Input options type
57
+ *
58
+ * 至少需要設定 changelogPreset 或 rootPath 其中一個
59
+ * At least one of changelogPreset or rootPath must be set
60
+ */
14
61
  export type IOptionsInput = IOptionsBase & ITSRequireAtLeastOne<IOptionsBaseCore>;
62
+ /**
63
+ * 更新 Changelog 的選項
64
+ * Options for updating changelog
65
+ */
15
66
  export type IOptionsUpdateChangelog = IOptionsInput & {
67
+ /**
68
+ * 指定版本號,若未提供則使用套件目前的版本
69
+ * Specify version number, uses package current version if not provided
70
+ */
16
71
  version?: string;
17
72
  };
73
+ /**
74
+ * 推薦版本的選項
75
+ * Options for recommending version
76
+ */
18
77
  export type IOptionsRecommendVersion = IOptionsInput & {
78
+ /**
79
+ * 預發布版本識別碼 (如: alpha, beta, rc)
80
+ * Prerelease identifier (e.g., alpha, beta, rc)
81
+ */
19
82
  prereleaseId?: string;
20
83
  };
84
+ /**
85
+ * 帶有類型的選項
86
+ * Options with type
87
+ */
21
88
  export type IOptionsWithType<T extends Record<any, any>> = T & {
89
+ /**
90
+ * Changelog 類型 (independent | root)
91
+ * Changelog type (independent | root)
92
+ */
22
93
  type?: IType;
23
94
  };
95
+ /**
96
+ * 更新 Changelog 的返回類型
97
+ * Return type for updating changelog
98
+ */
24
99
  export interface IReturnTypeUpdateChangelog {
100
+ /**
101
+ * Changelog 檔案路徑
102
+ * Changelog file path
103
+ */
25
104
  logPath: string;
105
+ /**
106
+ * 新增的 Changelog 內容
107
+ * New changelog entry content
108
+ */
26
109
  newEntry: string;
110
+ /**
111
+ * 版本號
112
+ * Version number
113
+ */
27
114
  version: string;
28
115
  }
package/lib/types.js CHANGED
@@ -1,5 +1,11 @@
1
1
  "use strict";
2
2
  /**
3
+ * Changelog 類型定義模組
4
+ * Changelog Type Definitions Module
5
+ *
6
+ * 定義 conventional changelog 相關的介面和類型
7
+ * Defines interfaces and types for conventional changelog
8
+ *
3
9
  * Created by user on 2020/6/15.
4
10
  */
5
11
  Object.defineProperty(exports, "__esModule", { value: true });
package/lib/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":";AAAA;;GAEG","sourcesContent":["/**\n * Created by user on 2020/6/15.\n */\n\nimport { ITSRequireAtLeastOne } from 'ts-type';\n\nexport type IChangelogPreset = string | \"conventional-changelog-angular\" | \"@bluelovers/conventional-changelog-bluelovers\";\nexport type IType = \"independent\" | \"root\" | string\n\nexport interface IOptionsBaseCore\n{\n\tchangelogPreset?: IChangelogPreset,\n\trootPath?: string,\n}\n\nexport interface IOptionsBase extends IOptionsBaseCore\n{\n\ttagPrefix?: string | 'v',\n}\n\nexport type IOptionsInput = IOptionsBase & ITSRequireAtLeastOne<IOptionsBaseCore>;\n\nexport type IOptionsUpdateChangelog = IOptionsInput & {\n\tversion?: string,\n}\n\nexport type IOptionsRecommendVersion = IOptionsInput & {\n\tprereleaseId?: string,\n}\n\nexport type IOptionsWithType<T extends Record<any, any>> = T & {\n\ttype?: IType,\n}\n\nexport interface IReturnTypeUpdateChangelog\n{\n\tlogPath: string;\n\tnewEntry: string;\n\tversion: string;\n}\n"]}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["types.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG","sourcesContent":["/**\n * Changelog 類型定義模組\n * Changelog Type Definitions Module\n *\n * 定義 conventional changelog 相關的介面和類型\n * Defines interfaces and types for conventional changelog\n *\n * Created by user on 2020/6/15.\n */\n\nimport { ITSRequireAtLeastOne } from 'ts-type';\n\n/**\n * 預設的 Changelog 規範類型\n * Changelog preset types\n *\n * 支援的預設規範:angular, atom, codemirror 等\n * Supported presets: angular, atom, codemirror, etc.\n */\nexport type IChangelogPreset = string | \"conventional-changelog-angular\" | \"@bluelovers/conventional-changelog-bluelovers\";\n\n/**\n * Changelog 類型\n * Changelog type\n *\n * - independent: 獨立版本模式 (每個套件有自己的版本)\n * - root: 根目錄模式 (所有套件共用一個版本)\n */\nexport type IType = \"independent\" | \"root\" | string\n\n/**\n * 基礎選項核心介面\n * Base options core interface\n */\nexport interface IOptionsBaseCore\n{\n\t/**\n\t * 使用的 Changelog 預設規範\n\t * Changelog preset to use\n\t */\n\tchangelogPreset?: IChangelogPreset,\n\n\t/**\n\t * 工作區根目錄路徑\n\t * Workspace root path\n\t */\n\trootPath?: string,\n}\n\n/**\n * 基礎選項介面\n * Base options interface\n */\nexport interface IOptionsBase extends IOptionsBaseCore\n{\n\t/**\n\t * 標籤前綴,預設為 'v'\n\t * Tag prefix, default is 'v'\n\t */\n\ttagPrefix?: string | 'v',\n}\n\n/**\n * 輸入選項類型\n * Input options type\n *\n * 至少需要設定 changelogPreset 或 rootPath 其中一個\n\t * At least one of changelogPreset or rootPath must be set\n */\nexport type IOptionsInput = IOptionsBase & ITSRequireAtLeastOne<IOptionsBaseCore>;\n\n/**\n * 更新 Changelog 的選項\n * Options for updating changelog\n */\nexport type IOptionsUpdateChangelog = IOptionsInput & {\n\t/**\n\t * 指定版本號,若未提供則使用套件目前的版本\n\t * Specify version number, uses package current version if not provided\n\t */\n\tversion?: string,\n}\n\n/**\n * 推薦版本的選項\n * Options for recommending version\n */\nexport type IOptionsRecommendVersion = IOptionsInput & {\n\t/**\n\t * 預發布版本識別碼 (如: alpha, beta, rc)\n\t * Prerelease identifier (e.g., alpha, beta, rc)\n\t */\n\tprereleaseId?: string,\n}\n\n/**\n * 帶有類型的選項\n * Options with type\n */\nexport type IOptionsWithType<T extends Record<any, any>> = T & {\n\t/**\n\t * Changelog 類型 (independent | root)\n\t * Changelog type (independent | root)\n\t */\n\ttype?: IType,\n}\n\n/**\n * 更新 Changelog 的返回類型\n * Return type for updating changelog\n */\nexport interface IReturnTypeUpdateChangelog\n{\n\t/**\n\t * Changelog 檔案路徑\n\t * Changelog file path\n\t */\n\tlogPath: string;\n\n\t/**\n\t * 新增的 Changelog 內容\n\t * New changelog entry content\n\t */\n\tnewEntry: string;\n\n\t/**\n\t * 版本號\n\t * Version number\n\t */\n\tversion: string;\n}\n"]}
@@ -1,8 +1,21 @@
1
1
  /**
2
+ * Yargs CLI 設定模組
3
+ * Yargs CLI Configuration Module
4
+ *
5
+ * 設定 changelog 命令列工具的參數選項
6
+ * Configures CLI argument options for changelog tool
7
+ *
2
8
  * Created by user on 2020/6/15.
3
9
  */
4
10
  import { Argv } from 'yargs';
5
11
  import { IYargsSync } from '@yarn-tool/types';
12
+ /**
13
+ * 設定 yargs 參數選項
14
+ * Setup yargs argument options
15
+ *
16
+ * @param {Argv<T>} yargs - Yargs 實例 / Yargs instance
17
+ * @returns {IYargsSync<typeof _return>} 設定後的 Yargs 實例 / Configured yargs instance
18
+ */
6
19
  export declare function setupToYargs<T>(yargs: Argv<T>): IYargsSync<Argv<T & {
7
20
  preset: string;
8
21
  } & {
@@ -14,4 +27,8 @@ export declare function setupToYargs<T>(yargs: Argv<T>): IYargsSync<Argv<T & {
14
27
  } & {
15
28
  cwd: string;
16
29
  }>>;
30
+ /**
31
+ * 預設匯出設定函數
32
+ * Default export setup function
33
+ */
17
34
  export default setupToYargs;
@@ -1,35 +1,72 @@
1
1
  "use strict";
2
2
  /**
3
+ * Yargs CLI 設定模組
4
+ * Yargs CLI Configuration Module
5
+ *
6
+ * 設定 changelog 命令列工具的參數選項
7
+ * Configures CLI argument options for changelog tool
8
+ *
3
9
  * Created by user on 2020/6/15.
4
10
  */
5
11
  Object.defineProperty(exports, "__esModule", { value: true });
6
12
  exports.setupToYargs = setupToYargs;
13
+ /**
14
+ * 設定 yargs 參數選項
15
+ * Setup yargs argument options
16
+ *
17
+ * @param {Argv<T>} yargs - Yargs 實例 / Yargs instance
18
+ * @returns {IYargsSync<typeof _return>} 設定後的 Yargs 實例 / Configured yargs instance
19
+ */
7
20
  function setupToYargs(yargs) {
8
21
  const _return = yargs
22
+ /**
23
+ * 預設規範選項
24
+ * Preset option
25
+ */
9
26
  .option('preset', {
10
27
  desc: `Name of the preset you want to use. Must be one of the following:\n@bluelovers/conventional-changelog-bluelovers, angular, atom, codemirror, ember, eslint, express, jquery, jscs or jshint`,
11
28
  alias: ['p', 'changelogPreset'],
12
29
  string: true,
13
30
  })
31
+ /**
32
+ * Lerna 套件模式選項
33
+ * Lerna package mode option
34
+ */
14
35
  .option('lerna-package', {
15
36
  desc: `Generate a changelog for a specific lerna package (:pkg-name@1.0.0)`,
16
37
  alias: 'l',
17
38
  boolean: true,
18
39
  default: true,
19
40
  })
41
+ /**
42
+ * Changelog 類型選項
43
+ * Changelog type option
44
+ */
20
45
  .option('type', {
21
46
  string: true,
22
47
  })
48
+ /**
49
+ * 標籤前綴選項
50
+ * Tag prefix option
51
+ */
23
52
  .option('tag-prefix', {
24
53
  desc: `Tag prefix to consider when reading the tags`,
25
54
  alias: 't',
26
55
  string: true,
27
56
  })
57
+ /**
58
+ * 工作目錄選項
59
+ * Working directory option
60
+ */
28
61
  .option('cwd', {
29
62
  default: process.cwd(),
30
63
  normalize: true,
31
64
  });
32
65
  return _return;
33
66
  }
67
+ /**
68
+ * 預設匯出設定函數
69
+ * Default export setup function
70
+ */
34
71
  exports.default = setupToYargs;
35
72
  //# sourceMappingURL=yargs-setting.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"yargs-setting.js","sourceRoot":"","sources":["yargs-setting.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAKH,oCA6BC;AA7BD,SAAgB,YAAY,CAAI,KAAc;IAE7C,MAAM,OAAO,GAAG,KAAK;SACnB,MAAM,CAAC,QAAQ,EAAE;QACjB,IAAI,EAAE,6LAA6L;QACnM,KAAK,EAAE,CAAC,GAAG,EAAE,iBAAiB,CAAC;QAC/B,MAAM,EAAE,IAAI;KACZ,CAAC;SACD,MAAM,CAAC,eAAe,EAAE;QACxB,IAAI,EAAE,qEAAqE;QAC3E,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,IAAI;KACb,CAAC;SACD,MAAM,CAAC,MAAM,EAAE;QACf,MAAM,EAAE,IAAI;KACZ,CAAC;SACD,MAAM,CAAC,YAAY,EAAE;QACrB,IAAI,EAAE,8CAA8C;QACpD,KAAK,EAAE,GAAG;QACV,MAAM,EAAE,IAAI;KACZ,CAAC;SACD,MAAM,CAAC,KAAK,EAAE;QACd,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;QACtB,SAAS,EAAE,IAAI;KACf,CAAC,CACF;IAED,OAAO,OAA4C,CAAA;AACpD,CAAC;AAED,kBAAe,YAAY,CAAA","sourcesContent":["/**\n * Created by user on 2020/6/15.\n */\n\nimport { Arguments, Argv, Omit } from 'yargs';\nimport { IYargsSync, IYargsUnPackArgv } from '@yarn-tool/types';\n\nexport function setupToYargs<T>(yargs: Argv<T>)\n{\n\tconst _return = yargs\n\t\t.option('preset', {\n\t\t\tdesc: `Name of the preset you want to use. Must be one of the following:\\n@bluelovers/conventional-changelog-bluelovers, angular, atom, codemirror, ember, eslint, express, jquery, jscs or jshint`,\n\t\t\talias: ['p', 'changelogPreset'],\n\t\t\tstring: true,\n\t\t})\n\t\t.option('lerna-package', {\n\t\t\tdesc: `Generate a changelog for a specific lerna package (:pkg-name@1.0.0)`,\n\t\t\talias: 'l',\n\t\t\tboolean: true,\n\t\t\tdefault: true,\n\t\t})\n\t\t.option('type', {\n\t\t\tstring: true,\n\t\t})\n\t\t.option('tag-prefix', {\n\t\t\tdesc: `Tag prefix to consider when reading the tags`,\n\t\t\talias: 't',\n\t\t\tstring: true,\n\t\t})\n\t\t.option('cwd', {\n\t\t\tdefault: process.cwd(),\n\t\t\tnormalize: true,\n\t\t})\n\t;\n\n\treturn _return as any as IYargsSync<typeof _return>\n}\n\nexport default setupToYargs\n"]}
1
+ {"version":3,"file":"yargs-setting.js","sourceRoot":"","sources":["yargs-setting.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;AAYH,oCAiDC;AAxDD;;;;;;GAMG;AACH,SAAgB,YAAY,CAAI,KAAc;IAE7C,MAAM,OAAO,GAAG,KAAK;QACpB;;;WAGG;SACF,MAAM,CAAC,QAAQ,EAAE;QACjB,IAAI,EAAE,6LAA6L;QACnM,KAAK,EAAE,CAAC,GAAG,EAAE,iBAAiB,CAAC;QAC/B,MAAM,EAAE,IAAI;KACZ,CAAC;QACF;;;WAGG;SACF,MAAM,CAAC,eAAe,EAAE;QACxB,IAAI,EAAE,qEAAqE;QAC3E,KAAK,EAAE,GAAG;QACV,OAAO,EAAE,IAAI;QACb,OAAO,EAAE,IAAI;KACb,CAAC;QACF;;;WAGG;SACF,MAAM,CAAC,MAAM,EAAE;QACf,MAAM,EAAE,IAAI;KACZ,CAAC;QACF;;;WAGG;SACF,MAAM,CAAC,YAAY,EAAE;QACrB,IAAI,EAAE,8CAA8C;QACpD,KAAK,EAAE,GAAG;QACV,MAAM,EAAE,IAAI;KACZ,CAAC;QACF;;;WAGG;SACF,MAAM,CAAC,KAAK,EAAE;QACd,OAAO,EAAE,OAAO,CAAC,GAAG,EAAE;QACtB,SAAS,EAAE,IAAI;KACf,CAAC,CACF;IAED,OAAO,OAA4C,CAAA;AACpD,CAAC;AAED;;;GAGG;AACH,kBAAe,YAAY,CAAA","sourcesContent":["/**\n * Yargs CLI 設定模組\n * Yargs CLI Configuration Module\n *\n * 設定 changelog 命令列工具的參數選項\n * Configures CLI argument options for changelog tool\n *\n * Created by user on 2020/6/15.\n */\n\nimport { Arguments, Argv, Omit } from 'yargs';\nimport { IYargsSync, IYargsUnPackArgv } from '@yarn-tool/types';\n\n/**\n * 設定 yargs 參數選項\n * Setup yargs argument options\n *\n * @param {Argv<T>} yargs - Yargs 實例 / Yargs instance\n * @returns {IYargsSync<typeof _return>} 設定後的 Yargs 實例 / Configured yargs instance\n */\nexport function setupToYargs<T>(yargs: Argv<T>)\n{\n\tconst _return = yargs\n\t\t/**\n\t\t * 預設規範選項\n\t\t * Preset option\n\t\t */\n\t\t.option('preset', {\n\t\t\tdesc: `Name of the preset you want to use. Must be one of the following:\\n@bluelovers/conventional-changelog-bluelovers, angular, atom, codemirror, ember, eslint, express, jquery, jscs or jshint`,\n\t\t\talias: ['p', 'changelogPreset'],\n\t\t\tstring: true,\n\t\t})\n\t\t/**\n\t\t * Lerna 套件模式選項\n\t\t * Lerna package mode option\n\t\t */\n\t\t.option('lerna-package', {\n\t\t\tdesc: `Generate a changelog for a specific lerna package (:pkg-name@1.0.0)`,\n\t\t\talias: 'l',\n\t\t\tboolean: true,\n\t\t\tdefault: true,\n\t\t})\n\t\t/**\n\t\t * Changelog 類型選項\n\t\t * Changelog type option\n\t\t */\n\t\t.option('type', {\n\t\t\tstring: true,\n\t\t})\n\t\t/**\n\t\t * 標籤前綴選項\n\t\t * Tag prefix option\n\t\t */\n\t\t.option('tag-prefix', {\n\t\t\tdesc: `Tag prefix to consider when reading the tags`,\n\t\t\talias: 't',\n\t\t\tstring: true,\n\t\t})\n\t\t/**\n\t\t * 工作目錄選項\n\t\t * Working directory option\n\t\t */\n\t\t.option('cwd', {\n\t\t\tdefault: process.cwd(),\n\t\t\tnormalize: true,\n\t\t})\n\t;\n\n\treturn _return as any as IYargsSync<typeof _return>\n}\n\n/**\n * 預設匯出設定函數\n * Default export setup function\n */\nexport default setupToYargs\n"]}
package/package.json CHANGED
@@ -1,7 +1,20 @@
1
1
  {
2
2
  "name": "@yarn-tool/changelog",
3
- "version": "3.0.2",
4
- "description": "",
3
+ "version": "3.0.4",
4
+ "description": "Generate and update CHANGELOG.md using conventional commits for monorepo workspaces",
5
+ "keywords": [
6
+ "changelog",
7
+ "conventional-commits",
8
+ "lerna",
9
+ "monorepo",
10
+ "workspaces",
11
+ "yarn",
12
+ "yarn-tool",
13
+ "semver",
14
+ "release",
15
+ "git",
16
+ "cli"
17
+ ],
5
18
  "homepage": "https://github.com/bluelovers/ws-yarn-workspaces/tree/master/packages/@yarn-tool/changelog#readme",
6
19
  "bugs": {
7
20
  "url": "https://github.com/bluelovers/ws-yarn-workspaces/issues"
@@ -46,19 +59,19 @@
46
59
  "dependencies": {
47
60
  "@bluelovers/conventional-changelog-bluelovers": "*",
48
61
  "@lerna/conventional-commits": "^6.4.1",
49
- "@yarn-tool/find-root": "^2.0.14",
50
- "@yarn-tool/require-resolve": "^3.0.1",
51
- "@yarn-tool/semver-diff": "^2.0.12",
52
- "@yarn-tool/table": "^2.0.14",
53
- "@yarn-tool/types": "^1.0.16",
54
- "lodash": "^4.17.21",
55
- "path-is-same": "^1.0.25",
62
+ "@yarn-tool/find-root": "^2.0.16",
63
+ "@yarn-tool/require-resolve": "^4.0.1",
64
+ "@yarn-tool/semver-diff": "^2.0.14",
65
+ "@yarn-tool/table": "^2.0.16",
66
+ "@yarn-tool/types": "^1.0.17",
67
+ "lodash": "^4.17.23",
68
+ "path-is-same": "^1.0.29",
56
69
  "ts-type": "^3.0.1",
57
70
  "tslib": ">=2",
58
- "upath2": "^3.1.19",
71
+ "upath2": "^3.1.23",
59
72
  "v8-compile-cache": "^2.4.0",
60
- "ws-pkg-list": "^3.0.2",
61
- "yargs": "*"
73
+ "ws-pkg-list": "^3.0.4",
74
+ "yargs": "<18 >=17.7.2"
62
75
  },
63
76
  "peerDependencies": {
64
77
  "@bluelovers/conventional-changelog-bluelovers": "*"
@@ -66,5 +79,5 @@
66
79
  "publishConfig": {
67
80
  "access": "public"
68
81
  },
69
- "gitHead": "089606f66f3c5501a8f3fdfc42e5a85b57f4d0e9"
82
+ "gitHead": "ae9b0817b25b1019ba68c88e541bbffc7d84047c"
70
83
  }