@shell-shock/preset-cli 0.9.13 → 0.9.15

package/dist/packages/plugin-changelog/dist/index.cjs

@@ -1,14 +1,15 @@
 const require_runtime = require('../../../_virtual/_rolldown/runtime.cjs');
 const require_changelog_command = require('./components/changelog-command.cjs');
 require('./components/index.cjs');
+const require_resolve_changelog = require('./helpers/resolve-changelog.cjs');
 let _alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
 let _powerlines_plugin_alloy_render = require("@powerlines/plugin-alloy/render");
 let _shell_shock_core_plugin_utils = require("@shell-shock/core/plugin-utils");
 let _stryke_path_join = require("@stryke/path/join");
+let powerlines_plugin_utils = require("powerlines/plugin-utils");
 let _stryke_type_checks_is_set_string = require("@stryke/type-checks/is-set-string");
 let defu = require("defu");
 defu = require_runtime.__toESM(defu);
-let powerlines_plugin_utils = require("powerlines/plugin-utils");
 
 //#region ../plugin-changelog/dist/index.mjs
 /**
@@ -19,30 +20,41 @@ const plugin = (options = {}) => {
 		name: "shell-shock:changelog",
 		config() {
 			this.debug("Providing default configuration for the Shell Shock `changelog` plugin.");
-			return { changelog: (0, defu.default)({ command: { name: (0, _stryke_type_checks_is_set_string.isSetString)(options.command) ? options.command : "changelog" } }, options, { file: (0, _stryke_path_join.joinPaths)("{root}", "CHANGELOG.md") }) };
+			return { changelog: (0, defu.default)({
+				file: require_resolve_changelog.resolveChangelog(this, options),
+				command: { name: (0, _stryke_type_checks_is_set_string.isSetString)(options.command) ? options.command : "changelog" }
+			}, options) };
 		},
 		configResolved() {
 			this.debug("Adding the CLI changelog commands to the application context.");
-			this.config.changelog.file = (0, powerlines_plugin_utils.replacePathTokens)(this, this.config.changelog.file);
-			this.inputs ??= [];
-			if (this.inputs.some((input) => input.id === this.config.changelog.command.name)) this.info("The `changelog` command already exists in the commands list. If you would like the changelog command to be managed by the `@shell-shock/plugin-changelog` package, please remove or rename the command.");
-			else this.inputs.push({
-				id: this.config.changelog.command.name,
-				path: this.config.changelog.command.name,
-				segments: [this.config.changelog.command.name],
-				title: "Changelog",
-				icon: "🗃",
-				tags: ["Utility"],
-				description: `Display the ${(0, _shell_shock_core_plugin_utils.getAppTitle)(this)} changelog.`,
-				entry: {
-					file: (0, _stryke_path_join.joinPaths)(this.entryPath, "changelog", "index.ts"),
-					input: { file: (0, _stryke_path_join.joinPaths)(this.entryPath, "changelog", "command.ts") }
-				},
-				isVirtual: false,
-				...this.config.changelog.command
-			});
+			if ((0, _stryke_type_checks_is_set_string.isSetString)(this.config.changelog.file)) {
+				this.config.changelog.file = (0, powerlines_plugin_utils.replacePathTokens)(this, this.config.changelog.file);
+				if (!this.fs.existsSync(this.config.changelog.file)) {
+					this.warn(`The changelog file could not be found at the resolved path: ${this.config.changelog.file}. The \`${this.config.changelog.command.name}\` command will not be added to the application. Please ensure that the changelog file exists at the specified path or adjust the \`changelog.file\` option to point to the correct location.`);
+					return;
+				}
+				this.inputs ??= [];
+				if (this.inputs.some((input) => input.id === this.config.changelog.command.name)) this.info("The `changelog` command already exists in the commands list. If you would like the changelog command to be managed by the `@shell-shock/plugin-changelog` package, please remove or rename the command.");
+				else this.inputs.push({
+					id: this.config.changelog.command.name,
+					path: this.config.changelog.command.name,
+					segments: [this.config.changelog.command.name],
+					title: "Changelog",
+					icon: "🗃",
+					tags: ["Utility"],
+					description: `Display the ${(0, _shell_shock_core_plugin_utils.getAppTitle)(this)} changelog.`,
+					entry: {
+						file: (0, _stryke_path_join.joinPaths)(this.entryPath, "changelog", "index.ts"),
+						input: { file: (0, _stryke_path_join.joinPaths)(this.entryPath, "changelog", "command.ts") }
+					},
+					isVirtual: false,
+					source: "changelog-plugin",
+					...this.config.changelog.command
+				});
+			}
 		},
 		async prepare() {
+			if ((0, _stryke_type_checks_is_set_string.isSetString)(this.config.changelog.file) && !this.fs.existsSync(this.config.changelog.file)) return;
 			this.debug("Rendering changelog command module for the Shell Shock `changelog` plugin.");
 			return (0, _powerlines_plugin_alloy_render.render)(this, (0, _alloy_js_core_jsx_runtime.createComponent)(require_changelog_command.ChangelogCommand, {}));
 		}

package/dist/packages/plugin-changelog/dist/index.mjs

@@ -1,12 +1,13 @@
 import { ChangelogCommand } from "./components/changelog-command.mjs";
 import "./components/index.mjs";
+import { resolveChangelog } from "./helpers/resolve-changelog.mjs";
 import { createComponent } from "@alloy-js/core/jsx-runtime";
 import { render } from "@powerlines/plugin-alloy/render";
 import { getAppTitle } from "@shell-shock/core/plugin-utils";
 import { joinPaths } from "@stryke/path/join";
+import { replacePathTokens } from "powerlines/plugin-utils";
 import { isSetString } from "@stryke/type-checks/is-set-string";
 import defu from "defu";
-import { replacePathTokens } from "powerlines/plugin-utils";
 
 //#region ../plugin-changelog/dist/index.mjs
 /**
@@ -17,30 +18,41 @@ const plugin = (options = {}) => {
 		name: "shell-shock:changelog",
 		config() {
 			this.debug("Providing default configuration for the Shell Shock `changelog` plugin.");
-			return { changelog: defu({ command: { name: isSetString(options.command) ? options.command : "changelog" } }, options, { file: joinPaths("{root}", "CHANGELOG.md") }) };
+			return { changelog: defu({
+				file: resolveChangelog(this, options),
+				command: { name: isSetString(options.command) ? options.command : "changelog" }
+			}, options) };
 		},
 		configResolved() {
 			this.debug("Adding the CLI changelog commands to the application context.");
-			this.config.changelog.file = replacePathTokens(this, this.config.changelog.file);
-			this.inputs ??= [];
-			if (this.inputs.some((input) => input.id === this.config.changelog.command.name)) this.info("The `changelog` command already exists in the commands list. If you would like the changelog command to be managed by the `@shell-shock/plugin-changelog` package, please remove or rename the command.");
-			else this.inputs.push({
-				id: this.config.changelog.command.name,
-				path: this.config.changelog.command.name,
-				segments: [this.config.changelog.command.name],
-				title: "Changelog",
-				icon: "🗃",
-				tags: ["Utility"],
-				description: `Display the ${getAppTitle(this)} changelog.`,
-				entry: {
-					file: joinPaths(this.entryPath, "changelog", "index.ts"),
-					input: { file: joinPaths(this.entryPath, "changelog", "command.ts") }
-				},
-				isVirtual: false,
-				...this.config.changelog.command
-			});
+			if (isSetString(this.config.changelog.file)) {
+				this.config.changelog.file = replacePathTokens(this, this.config.changelog.file);
+				if (!this.fs.existsSync(this.config.changelog.file)) {
+					this.warn(`The changelog file could not be found at the resolved path: ${this.config.changelog.file}. The \`${this.config.changelog.command.name}\` command will not be added to the application. Please ensure that the changelog file exists at the specified path or adjust the \`changelog.file\` option to point to the correct location.`);
+					return;
+				}
+				this.inputs ??= [];
+				if (this.inputs.some((input) => input.id === this.config.changelog.command.name)) this.info("The `changelog` command already exists in the commands list. If you would like the changelog command to be managed by the `@shell-shock/plugin-changelog` package, please remove or rename the command.");
+				else this.inputs.push({
+					id: this.config.changelog.command.name,
+					path: this.config.changelog.command.name,
+					segments: [this.config.changelog.command.name],
+					title: "Changelog",
+					icon: "🗃",
+					tags: ["Utility"],
+					description: `Display the ${getAppTitle(this)} changelog.`,
+					entry: {
+						file: joinPaths(this.entryPath, "changelog", "index.ts"),
+						input: { file: joinPaths(this.entryPath, "changelog", "command.ts") }
+					},
+					isVirtual: false,
+					source: "changelog-plugin",
+					...this.config.changelog.command
+				});
+			}
 		},
 		async prepare() {
+			if (isSetString(this.config.changelog.file) && !this.fs.existsSync(this.config.changelog.file)) return;
 			this.debug("Rendering changelog command module for the Shell Shock `changelog` plugin.");
 			return render(this, createComponent(ChangelogCommand, {}));
 		}

package/dist/packages/plugin-changelog/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":[],"sources":["../../../../../plugin-changelog/dist/index.mjs"],"sourcesContent":["import { ChangelogCommand } from \"./components/changelog-command.mjs\";\nimport \"./components/index.mjs\";\nimport { createComponent } from \"@alloy-js/core/jsx-runtime\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport defu from \"defu\";\nimport { replacePathTokens } from \"powerlines/plugin-utils\";\n\n//#region src/index.tsx\n/**\n* The Changelog - Shell Shock plugin to add version check functionality and changelog commands to a Shell Shock application.\n*/\nconst plugin = (options = {}) => {\n\treturn {\n\t\tname: \"shell-shock:changelog\",\n\t\tconfig() {\n\t\t\tthis.debug(\"Providing default configuration for the Shell Shock `changelog` plugin.\");\n\t\t\treturn { changelog: defu({ command: { name: isSetString(options.command) ? options.command : \"changelog\" } }, options, { file: joinPaths(\"{root}\", \"CHANGELOG.md\") }) };\n\t\t},\n\t\tconfigResolved() {\n\t\t\tthis.debug(\"Adding the CLI changelog commands to the application context.\");\n\t\t\tthis.config.changelog.file = replacePathTokens(this, this.config.changelog.file);\n\t\t\tthis.inputs ??= [];\n\t\t\tif (this.inputs.some((input) => input.id === this.config.changelog.command.name)) this.info(\"The `changelog` command already exists in the commands list. If you would like the changelog command to be managed by the `@shell-shock/plugin-changelog` package, please remove or rename the command.\");\n\t\t\telse this.inputs.push({\n\t\t\t\tid: this.config.changelog.command.name,\n\t\t\t\tpath: this.config.changelog.command.name,\n\t\t\t\tsegments: [this.config.changelog.command.name],\n\t\t\t\ttitle: \"Changelog\",\n\t\t\t\ticon: \"🗃\",\n\t\t\t\ttags: [\"Utility\"],\n\t\t\t\tdescription: `Display the ${getAppTitle(this)} changelog.`,\n\t\t\t\tentry: {\n\t\t\t\t\tfile: joinPaths(this.entryPath, \"changelog\", \"index.ts\"),\n\t\t\t\t\tinput: { file: joinPaths(this.entryPath, \"changelog\", \"command.ts\") }\n\t\t\t\t},\n\t\t\t\tisVirtual: false,\n\t\t\t\t...this.config.changelog.command\n\t\t\t});\n\t\t},\n\t\tasync prepare() {\n\t\t\tthis.debug(\"Rendering changelog command module for the Shell Shock `changelog` plugin.\");\n\t\t\treturn render(this, createComponent(ChangelogCommand, {}));\n\t\t}\n\t};\n};\n\n//#endregion\nexport { plugin as default, plugin };\n//# sourceMappingURL=index.mjs.map"],"mappings":";;;;;;;;;;;;;;AAcA,MAAM,UAAU,UAAU,EAAE,KAAK;AAChC,QAAO;EACN,MAAM;EACN,SAAS;AACR,QAAK,MAAM,0EAA0E;AACrF,UAAO,EAAE,WAAW,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,QAAQ,QAAQ,GAAG,QAAQ,UAAU,aAAa,EAAE,EAAE,SAAS,EAAE,MAAM,UAAU,UAAU,eAAe,EAAE,CAAC,EAAE;;EAExK,iBAAiB;AAChB,QAAK,MAAM,gEAAgE;AAC3E,QAAK,OAAO,UAAU,OAAO,kBAAkB,MAAM,KAAK,OAAO,UAAU,KAAK;AAChF,QAAK,WAAW,EAAE;AAClB,OAAI,KAAK,OAAO,MAAM,UAAU,MAAM,OAAO,KAAK,OAAO,UAAU,QAAQ,KAAK,CAAE,MAAK,KAAK,0MAA0M;OACjS,MAAK,OAAO,KAAK;IACrB,IAAI,KAAK,OAAO,UAAU,QAAQ;IAClC,MAAM,KAAK,OAAO,UAAU,QAAQ;IACpC,UAAU,CAAC,KAAK,OAAO,UAAU,QAAQ,KAAK;IAC9C,OAAO;IACP,MAAM;IACN,MAAM,CAAC,UAAU;IACjB,aAAa,eAAe,YAAY,KAAK,CAAC;IAC9C,OAAO;KACN,MAAM,UAAU,KAAK,WAAW,aAAa,WAAW;KACxD,OAAO,EAAE,MAAM,UAAU,KAAK,WAAW,aAAa,aAAa,EAAE;KACrE;IACD,WAAW;IACX,GAAG,KAAK,OAAO,UAAU;IACzB,CAAC;;EAEH,MAAM,UAAU;AACf,QAAK,MAAM,6EAA6E;AACxF,UAAO,OAAO,MAAM,gBAAgB,kBAAkB,EAAE,CAAC,CAAC;;EAE3D"}
+{"version":3,"file":"index.mjs","names":[],"sources":["../../../../../plugin-changelog/dist/index.mjs"],"sourcesContent":["import { ChangelogCommand } from \"./components/changelog-command.mjs\";\nimport \"./components/index.mjs\";\nimport { resolveChangelog } from \"./helpers/resolve-changelog.mjs\";\nimport { createComponent } from \"@alloy-js/core/jsx-runtime\";\nimport { render } from \"@powerlines/plugin-alloy/render\";\nimport { getAppTitle } from \"@shell-shock/core/plugin-utils\";\nimport { joinPaths } from \"@stryke/path/join\";\nimport { isSetString } from \"@stryke/type-checks/is-set-string\";\nimport defu from \"defu\";\nimport { replacePathTokens } from \"powerlines/plugin-utils\";\n\n//#region src/index.tsx\n/**\n* The Changelog - Shell Shock plugin to add version check functionality and changelog commands to a Shell Shock application.\n*/\nconst plugin = (options = {}) => {\n\treturn {\n\t\tname: \"shell-shock:changelog\",\n\t\tconfig() {\n\t\t\tthis.debug(\"Providing default configuration for the Shell Shock `changelog` plugin.\");\n\t\t\treturn { changelog: defu({\n\t\t\t\tfile: resolveChangelog(this, options),\n\t\t\t\tcommand: { name: isSetString(options.command) ? options.command : \"changelog\" }\n\t\t\t}, options) };\n\t\t},\n\t\tconfigResolved() {\n\t\t\tthis.debug(\"Adding the CLI changelog commands to the application context.\");\n\t\t\tif (isSetString(this.config.changelog.file)) {\n\t\t\t\tthis.config.changelog.file = replacePathTokens(this, this.config.changelog.file);\n\t\t\t\tif (!this.fs.existsSync(this.config.changelog.file)) {\n\t\t\t\t\tthis.warn(`The changelog file could not be found at the resolved path: ${this.config.changelog.file}. The \\`${this.config.changelog.command.name}\\` command will not be added to the application. Please ensure that the changelog file exists at the specified path or adjust the \\`changelog.file\\` option to point to the correct location.`);\n\t\t\t\t\treturn;\n\t\t\t\t}\n\t\t\t\tthis.inputs ??= [];\n\t\t\t\tif (this.inputs.some((input) => input.id === this.config.changelog.command.name)) this.info(\"The `changelog` command already exists in the commands list. If you would like the changelog command to be managed by the `@shell-shock/plugin-changelog` package, please remove or rename the command.\");\n\t\t\t\telse this.inputs.push({\n\t\t\t\t\tid: this.config.changelog.command.name,\n\t\t\t\t\tpath: this.config.changelog.command.name,\n\t\t\t\t\tsegments: [this.config.changelog.command.name],\n\t\t\t\t\ttitle: \"Changelog\",\n\t\t\t\t\ticon: \"🗃\",\n\t\t\t\t\ttags: [\"Utility\"],\n\t\t\t\t\tdescription: `Display the ${getAppTitle(this)} changelog.`,\n\t\t\t\t\tentry: {\n\t\t\t\t\t\tfile: joinPaths(this.entryPath, \"changelog\", \"index.ts\"),\n\t\t\t\t\t\tinput: { file: joinPaths(this.entryPath, \"changelog\", \"command.ts\") }\n\t\t\t\t\t},\n\t\t\t\t\tisVirtual: false,\n\t\t\t\t\tsource: \"changelog-plugin\",\n\t\t\t\t\t...this.config.changelog.command\n\t\t\t\t});\n\t\t\t}\n\t\t},\n\t\tasync prepare() {\n\t\t\tif (isSetString(this.config.changelog.file) && !this.fs.existsSync(this.config.changelog.file)) return;\n\t\t\tthis.debug(\"Rendering changelog command module for the Shell Shock `changelog` plugin.\");\n\t\t\treturn render(this, createComponent(ChangelogCommand, {}));\n\t\t}\n\t};\n};\n\n//#endregion\nexport { plugin as default, plugin };\n//# sourceMappingURL=index.mjs.map"],"mappings":";;;;;;;;;;;;;;;AAeA,MAAM,UAAU,UAAU,EAAE,KAAK;AAChC,QAAO;EACN,MAAM;EACN,SAAS;AACR,QAAK,MAAM,0EAA0E;AACrF,UAAO,EAAE,WAAW,KAAK;IACxB,MAAM,iBAAiB,MAAM,QAAQ;IACrC,SAAS,EAAE,MAAM,YAAY,QAAQ,QAAQ,GAAG,QAAQ,UAAU,aAAa;IAC/E,EAAE,QAAQ,EAAE;;EAEd,iBAAiB;AAChB,QAAK,MAAM,gEAAgE;AAC3E,OAAI,YAAY,KAAK,OAAO,UAAU,KAAK,EAAE;AAC5C,SAAK,OAAO,UAAU,OAAO,kBAAkB,MAAM,KAAK,OAAO,UAAU,KAAK;AAChF,QAAI,CAAC,KAAK,GAAG,WAAW,KAAK,OAAO,UAAU,KAAK,EAAE;AACpD,UAAK,KAAK,+DAA+D,KAAK,OAAO,UAAU,KAAK,UAAU,KAAK,OAAO,UAAU,QAAQ,KAAK,+LAA+L;AAChV;;AAED,SAAK,WAAW,EAAE;AAClB,QAAI,KAAK,OAAO,MAAM,UAAU,MAAM,OAAO,KAAK,OAAO,UAAU,QAAQ,KAAK,CAAE,MAAK,KAAK,0MAA0M;QACjS,MAAK,OAAO,KAAK;KACrB,IAAI,KAAK,OAAO,UAAU,QAAQ;KAClC,MAAM,KAAK,OAAO,UAAU,QAAQ;KACpC,UAAU,CAAC,KAAK,OAAO,UAAU,QAAQ,KAAK;KAC9C,OAAO;KACP,MAAM;KACN,MAAM,CAAC,UAAU;KACjB,aAAa,eAAe,YAAY,KAAK,CAAC;KAC9C,OAAO;MACN,MAAM,UAAU,KAAK,WAAW,aAAa,WAAW;MACxD,OAAO,EAAE,MAAM,UAAU,KAAK,WAAW,aAAa,aAAa,EAAE;MACrE;KACD,WAAW;KACX,QAAQ;KACR,GAAG,KAAK,OAAO,UAAU;KACzB,CAAC;;;EAGJ,MAAM,UAAU;AACf,OAAI,YAAY,KAAK,OAAO,UAAU,KAAK,IAAI,CAAC,KAAK,GAAG,WAAW,KAAK,OAAO,UAAU,KAAK,CAAE;AAChG,QAAK,MAAM,6EAA6E;AACxF,UAAO,OAAO,MAAM,gBAAgB,kBAAkB,EAAE,CAAC,CAAC;;EAE3D"}

package/dist/packages/plugin-changelog/dist/types/plugin.d.cts

@@ -7,6 +7,54 @@ interface ChangelogPluginOptions {
   /**
    * The path to the changelog file to read when executing the `changelog` command. This can be an absolute path or a path relative to the application's root directory.
    *
+   * @remarks
+   * If not provided, the plugin will attempt to resolve the changelog file by looking for common changelog file names (e.g., `CHANGELOG.md`, `RELEASE-NOTES.md`, etc.) in the application's root directory. If a specific file name is provided but cannot be found, it will fall back to looking for common changelog file names. If no valid changelog file can be resolved, the `changelog` command will not be added to the application. The following list of common changelog file names will be used for resolution:
+   * - `CHANGELOG.md`
+   * - `changelog.md`
+   * - `Changelog.md`
+   * - `CHANGELOG.markdown`
+   * - `changelog.markdown`
+   * - `Changelog.markdown`
+   * - `CHANGELOG.txt`
+   * - `changelog.txt`
+   * - `Changelog.txt`
+   * - `RELEASE-NOTES.md`
+   * - `release-notes.md`
+   * - `Release-Notes.md`
+   * - `RELEASE-NOTES.markdown`
+   * - `release-notes.markdown`
+   * - `Release-Notes.markdown`
+   * - `RELEASE-NOTES.txt`
+   * - `release-notes.txt`
+   * - `Release-Notes.txt`
+   * - `RELEASE_NOTES.md`
+   * - `release_notes.md`
+   * - `Release_Notes.md`
+   * - `RELEASE_NOTES.markdown`
+   * - `release_notes.markdown`
+   * - `Release_Notes.markdown`
+   * - `RELEASE_NOTES.txt`
+   * - `release_notes.txt`
+   * - `Release_Notes.txt`
+   * - `RELEASES.md`
+   * - `releases.md`
+   * - `Releases.md`
+   * - `RELEASES.markdown`
+   * - `releases.markdown`
+   * - `Releases.markdown`
+   * - `RELEASES.txt`
+   * - `releases.txt`
+   * - `Releases.txt`
+   * - `HISTORY.md`
+   * - `history.md`
+   * - `History.md`
+   * - `HISTORY.markdown`
+   * - `history.markdown`
+   * - `History.markdown`
+   * - `HISTORY.txt`
+   * - `history.txt`
+   * - `History.txt`
+   *
    * @defaultValue "\{root\}/CHANGELOG.md"
    */
   file?: string;

package/dist/packages/plugin-changelog/dist/types/plugin.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.cts","names":["CommandConfig","Context","ResolvedConfig","UserConfig","RequiredKeys","ChangelogPluginOptions","Partial","file","command","ChangelogPluginUserConfig","changelog","ChangelogPluginResolvedConfig","Omit","Required","ChangelogPluginContext","TResolvedConfig"],"sources":["../../../../../../plugin-changelog/dist/types/plugin.d.cts"],"mappings":";;;;;UAIUK,sBAAAA;EAAsB;;;;;EAM9BE,IAAAA;EASkBP;;;AAAa;;;;;EAA/BQ,OAAAA,GAAUF,OAAAA,CAAQN,aAAAA;AAAAA;AAAAA,KAEfS,yBAAAA,GAA4BN,UAAAA;EAIE;AAAA;;EAAjCO,SAAAA,EAAWL,sBAAAA;AAAAA;AAAAA,KAERM,6BAAAA,GAAgCT,cAAAA;EAIfU;;;EAApBF,SAAAA,EAAWG,QAAAA,CAASD,IAAAA,CAAKP,sBAAAA;IAIdD;;;IAATI,OAAAA,EAASJ,YAAAA,CAAaE,OAAAA,CAAQN,aAAAA;EAAAA;AAAAA;AAAAA,KAG7Bc,sBAAAA,yBAA+CH,6BAAAA,GAAgCA,6BAAAA,IAAiCV,OAAAA,CAAQc,eAAAA"}
+{"version":3,"file":"plugin.d.cts","names":["CommandConfig","Context","ResolvedConfig","UserConfig","RequiredKeys","ChangelogPluginOptions","Partial","file","command","ChangelogPluginUserConfig","changelog","ChangelogPluginResolvedConfig","Omit","Required","ChangelogPluginContext","TResolvedConfig"],"sources":["../../../../../../plugin-changelog/dist/types/plugin.d.cts"],"mappings":";;;;;UAIUK,sBAAAA;EAAsB;;;;;;;;;AA+DC;;;;;;;;;AAME;;;;;;;;;;;;;;;;;;;;;;;AAUY;;;;;;;;;;;;EAzB7CE,IAAAA;EA4B2HQ;;;;;;;;EAnB3HP,OAAAA,GAAUF,OAAAA,CAAQN,aAAAA;AAAAA;AAAAA,KAEfS,yBAAAA,GAA4BN,UAAAA;;;;EAI/BO,SAAAA,EAAWL,sBAAAA;AAAAA;AAAAA,KAERM,6BAAAA,GAAgCT,cAAAA;;;;EAInCQ,SAAAA,EAAWG,QAAAA,CAASD,IAAAA,CAAKP,sBAAAA;;;;IAIvBG,OAAAA,EAASJ,YAAAA,CAAaE,OAAAA,CAAQN,aAAAA;EAAAA;AAAAA;AAAAA,KAG7Bc,sBAAAA,yBAA+CH,6BAAAA,GAAgCA,6BAAAA,IAAiCV,OAAAA,CAAQc,eAAAA"}

package/dist/packages/plugin-changelog/dist/types/plugin.d.mts

@@ -7,6 +7,54 @@ interface ChangelogPluginOptions {
   /**
    * The path to the changelog file to read when executing the `changelog` command. This can be an absolute path or a path relative to the application's root directory.
    *
+   * @remarks
+   * If not provided, the plugin will attempt to resolve the changelog file by looking for common changelog file names (e.g., `CHANGELOG.md`, `RELEASE-NOTES.md`, etc.) in the application's root directory. If a specific file name is provided but cannot be found, it will fall back to looking for common changelog file names. If no valid changelog file can be resolved, the `changelog` command will not be added to the application. The following list of common changelog file names will be used for resolution:
+   * - `CHANGELOG.md`
+   * - `changelog.md`
+   * - `Changelog.md`
+   * - `CHANGELOG.markdown`
+   * - `changelog.markdown`
+   * - `Changelog.markdown`
+   * - `CHANGELOG.txt`
+   * - `changelog.txt`
+   * - `Changelog.txt`
+   * - `RELEASE-NOTES.md`
+   * - `release-notes.md`
+   * - `Release-Notes.md`
+   * - `RELEASE-NOTES.markdown`
+   * - `release-notes.markdown`
+   * - `Release-Notes.markdown`
+   * - `RELEASE-NOTES.txt`
+   * - `release-notes.txt`
+   * - `Release-Notes.txt`
+   * - `RELEASE_NOTES.md`
+   * - `release_notes.md`
+   * - `Release_Notes.md`
+   * - `RELEASE_NOTES.markdown`
+   * - `release_notes.markdown`
+   * - `Release_Notes.markdown`
+   * - `RELEASE_NOTES.txt`
+   * - `release_notes.txt`
+   * - `Release_Notes.txt`
+   * - `RELEASES.md`
+   * - `releases.md`
+   * - `Releases.md`
+   * - `RELEASES.markdown`
+   * - `releases.markdown`
+   * - `Releases.markdown`
+   * - `RELEASES.txt`
+   * - `releases.txt`
+   * - `Releases.txt`
+   * - `HISTORY.md`
+   * - `history.md`
+   * - `History.md`
+   * - `HISTORY.markdown`
+   * - `history.markdown`
+   * - `History.markdown`
+   * - `HISTORY.txt`
+   * - `history.txt`
+   * - `History.txt`
+   *
    * @defaultValue "\{root\}/CHANGELOG.md"
    */
   file?: string;

package/dist/packages/plugin-changelog/dist/types/plugin.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin.d.mts","names":["CommandConfig","Context","ResolvedConfig","UserConfig","RequiredKeys","ChangelogPluginOptions","Partial","file","command","ChangelogPluginUserConfig","changelog","ChangelogPluginResolvedConfig","Omit","Required","ChangelogPluginContext","TResolvedConfig"],"sources":["../../../../../../plugin-changelog/dist/types/plugin.d.cts"],"mappings":";;;;;UAIUK,sBAAAA;EAAsB;;;;;EAM9BE,IAAAA;EASkBP;;;AAAa;;;;;EAA/BQ,OAAAA,GAAUF,OAAAA,CAAQN,aAAAA;AAAAA;AAAAA,KAEfS,yBAAAA,GAA4BN,UAAAA;EAIE;AAAA;;EAAjCO,SAAAA,EAAWL,sBAAAA;AAAAA;AAAAA,KAERM,6BAAAA,GAAgCT,cAAAA;EAIfU;;;EAApBF,SAAAA,EAAWG,QAAAA,CAASD,IAAAA,CAAKP,sBAAAA;IAIdD;;;IAATI,OAAAA,EAASJ,YAAAA,CAAaE,OAAAA,CAAQN,aAAAA;EAAAA;AAAAA;AAAAA,KAG7Bc,sBAAAA,yBAA+CH,6BAAAA,GAAgCA,6BAAAA,IAAiCV,OAAAA,CAAQc,eAAAA"}
+{"version":3,"file":"plugin.d.mts","names":["CommandConfig","Context","ResolvedConfig","UserConfig","RequiredKeys","ChangelogPluginOptions","Partial","file","command","ChangelogPluginUserConfig","changelog","ChangelogPluginResolvedConfig","Omit","Required","ChangelogPluginContext","TResolvedConfig"],"sources":["../../../../../../plugin-changelog/dist/types/plugin.d.cts"],"mappings":";;;;;UAIUK,sBAAAA;EAAsB;;;;;;;;;AA+DC;;;;;;;;;AAME;;;;;;;;;;;;;;;;;;;;;;;AAUY;;;;;;;;;;;;EAzB7CE,IAAAA;EA4B2HQ;;;;;;;;EAnB3HP,OAAAA,GAAUF,OAAAA,CAAQN,aAAAA;AAAAA;AAAAA,KAEfS,yBAAAA,GAA4BN,UAAAA;;;;EAI/BO,SAAAA,EAAWL,sBAAAA;AAAAA;AAAAA,KAERM,6BAAAA,GAAgCT,cAAAA;;;;EAInCQ,SAAAA,EAAWG,QAAAA,CAASD,IAAAA,CAAKP,sBAAAA;;;;IAIvBG,OAAAA,EAASJ,YAAAA,CAAaE,OAAAA,CAAQN,aAAAA;EAAAA;AAAAA;AAAAA,KAG7Bc,sBAAAA,yBAA+CH,6BAAAA,GAAgCA,6BAAAA,IAAiCV,OAAAA,CAAQc,eAAAA"}