@shell-shock/plugin-upgrade 0.1.4 → 0.1.5

package/dist/components/index.cjs

@@ -1,11 +1,13 @@
 const require_components_upgrade_builtin = require('./upgrade-builtin.cjs');
 const require_components_upgrade_command = require('./upgrade-command.cjs');
 
+exports.CheckForUpdatesFunctionDeclaration = require_components_upgrade_builtin.CheckForUpdatesFunctionDeclaration;
 exports.FetchNpmPackageFunctionDeclaration = require_components_upgrade_builtin.FetchNpmPackageFunctionDeclaration;
-exports.GetLatestFunctionDeclaration = require_components_upgrade_builtin.GetLatestFunctionDeclaration;
+exports.GetLatestVersionFunctionDeclaration = require_components_upgrade_builtin.GetLatestVersionFunctionDeclaration;
 exports.GetPackageManagerFunctionDeclaration = require_components_upgrade_builtin.GetPackageManagerFunctionDeclaration;
-exports.InstallFunctionDeclaration = require_components_upgrade_builtin.InstallFunctionDeclaration;
+exports.GetUpgradeCommandFunctionDeclaration = require_components_upgrade_builtin.GetUpgradeCommandFunctionDeclaration;
 exports.LocateLockfileFunctionDeclaration = require_components_upgrade_builtin.LocateLockfileFunctionDeclaration;
 exports.LocatePackageJsonFunctionDeclaration = require_components_upgrade_builtin.LocatePackageJsonFunctionDeclaration;
 exports.UpgradeBuiltin = require_components_upgrade_builtin.UpgradeBuiltin;
-exports.UpgradeCommand = require_components_upgrade_command.UpgradeCommand;
+exports.UpgradeCommand = require_components_upgrade_command.UpgradeCommand;
+exports.UpgradeFunctionDeclaration = require_components_upgrade_builtin.UpgradeFunctionDeclaration;

package/dist/components/index.d.cts

@@ -1,3 +1,3 @@
-import { FetchNpmPackageFunctionDeclaration, GetLatestFunctionDeclaration, GetPackageManagerFunctionDeclaration, InstallFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps } from "./upgrade-builtin.cjs";
+import { CheckForUpdatesFunctionDeclaration, FetchNpmPackageFunctionDeclaration, GetLatestVersionFunctionDeclaration, GetPackageManagerFunctionDeclaration, GetUpgradeCommandFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps, UpgradeFunctionDeclaration } from "./upgrade-builtin.cjs";
 import { UpgradeCommand } from "./upgrade-command.cjs";
-export { FetchNpmPackageFunctionDeclaration, GetLatestFunctionDeclaration, GetPackageManagerFunctionDeclaration, InstallFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps, UpgradeCommand };
+export { CheckForUpdatesFunctionDeclaration, FetchNpmPackageFunctionDeclaration, GetLatestVersionFunctionDeclaration, GetPackageManagerFunctionDeclaration, GetUpgradeCommandFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps, UpgradeCommand, UpgradeFunctionDeclaration };

package/dist/components/index.d.mts

@@ -1,3 +1,3 @@
-import { FetchNpmPackageFunctionDeclaration, GetLatestFunctionDeclaration, GetPackageManagerFunctionDeclaration, InstallFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps } from "./upgrade-builtin.mjs";
+import { CheckForUpdatesFunctionDeclaration, FetchNpmPackageFunctionDeclaration, GetLatestVersionFunctionDeclaration, GetPackageManagerFunctionDeclaration, GetUpgradeCommandFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps, UpgradeFunctionDeclaration } from "./upgrade-builtin.mjs";
 import { UpgradeCommand } from "./upgrade-command.mjs";
-export { FetchNpmPackageFunctionDeclaration, GetLatestFunctionDeclaration, GetPackageManagerFunctionDeclaration, InstallFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps, UpgradeCommand };
+export { CheckForUpdatesFunctionDeclaration, FetchNpmPackageFunctionDeclaration, GetLatestVersionFunctionDeclaration, GetPackageManagerFunctionDeclaration, GetUpgradeCommandFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps, UpgradeCommand, UpgradeFunctionDeclaration };

package/dist/components/index.mjs

@@ -1,4 +1,4 @@
-import { FetchNpmPackageFunctionDeclaration, GetLatestFunctionDeclaration, GetPackageManagerFunctionDeclaration, InstallFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin } from "./upgrade-builtin.mjs";
+import { CheckForUpdatesFunctionDeclaration, FetchNpmPackageFunctionDeclaration, GetLatestVersionFunctionDeclaration, GetPackageManagerFunctionDeclaration, GetUpgradeCommandFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeFunctionDeclaration } from "./upgrade-builtin.mjs";
 import { UpgradeCommand } from "./upgrade-command.mjs";
 
-export { FetchNpmPackageFunctionDeclaration, GetLatestFunctionDeclaration, GetPackageManagerFunctionDeclaration, InstallFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeCommand };
+export { CheckForUpdatesFunctionDeclaration, FetchNpmPackageFunctionDeclaration, GetLatestVersionFunctionDeclaration, GetPackageManagerFunctionDeclaration, GetUpgradeCommandFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeCommand, UpgradeFunctionDeclaration };

package/dist/components/upgrade-builtin.cjs

@@ -1,30 +1,41 @@
 const require_rolldown_runtime = require('../_virtual/rolldown_runtime.cjs');
 let __alloy_js_core_jsx_runtime = require("@alloy-js/core/jsx-runtime");
+let defu = require("defu");
+defu = require_rolldown_runtime.__toESM(defu);
 let __alloy_js_core = require("@alloy-js/core");
 let __alloy_js_typescript = require("@alloy-js/typescript");
 let __powerlines_plugin_alloy_core_components_spacing = require("@powerlines/plugin-alloy/core/components/spacing");
+let __powerlines_plugin_alloy_core_contexts_context = require("@powerlines/plugin-alloy/core/contexts/context");
 let __powerlines_plugin_alloy_typescript = require("@powerlines/plugin-alloy/typescript");
 let __powerlines_plugin_alloy_typescript_components_builtin_file = require("@powerlines/plugin-alloy/typescript/components/builtin-file");
-let defu = require("defu");
-defu = require_rolldown_runtime.__toESM(defu);
 
 //#region src/components/upgrade-builtin.tsx
 /**
 * The `locatePackageJson` handler function declaration code for the Shell Shock project.
 */
 function LocatePackageJsonFunctionDeclaration() {
+	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
 	return [
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.InterfaceDeclaration, {
 			"export": true,
 			name: "LocatePackageJsonOptions",
 			doc: "Options for the `locatePackageJson` handler function.",
 			get children() {
-				return (0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
-					name: "cwd",
-					optional: true,
-					type: "string",
-					doc: "The current working directory to use. If not provided, the process's current working directory will be used."
-				});
+				return [
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
+						name: "cwd",
+						optional: true,
+						type: "string",
+						doc: "The current working directory to use. If not provided, the process's current working directory will be used."
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
+						name: "isDependencyRequired",
+						optional: true,
+						type: "boolean",
+						doc: "Whether to only locate a package.json file if it contains the application as a dependency. If set to `true`, the function will check if the located package.json file has the application listed as a dependency in its dependencies, devDependencies, peerDependencies, or optionalDependencies before returning its path. This can be useful in monorepo setups where multiple package.json files may exist, but only the one that includes the application as a dependency is relevant for upgrade purposes."
+					})
+				];
 			}
 		}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
@@ -68,11 +79,32 @@ function LocatePackageJsonFunctionDeclaration() {
 					}),
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 					__alloy_js_core.code`while (parentPath !== currentPath && currentPath !== homePath && currentPath !== tempPath) { `,
-					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
-						condition: __alloy_js_core.code`existsSync(join(currentPath, "package.json"))`,
-						children: __alloy_js_core.code`return join(currentPath, "package.json"); `
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+						"const": true,
+						name: "packageJsonPath",
+						initializer: __alloy_js_core.code`join(currentPath, "package.json"); `
 					}),
-					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseClause, { children: __alloy_js_core.code`currentPath = pathParent;
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
+						condition: __alloy_js_core.code`existsSync(packageJsonPath)`,
+						get children() {
+							return [(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
+								condition: __alloy_js_core.code`options.isDependencyRequired`,
+								get children() {
+									return [(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+										"const": true,
+										name: "packageJson",
+										initializer: __alloy_js_core.code`JSON.parse(await readFile(packageJsonPath, "utf8")); `
+									}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
+										get condition() {
+											return __alloy_js_core.code`Object.keys(packageJson.dependencies || {}).concat(Object.keys(packageJson.devDependencies || {})).concat(Object.keys(packageJson.peerDependencies || {})).concat(Object.keys(packageJson.optionalDependencies || {})).some(dep => dep === "${context.packageJson.name}" || dep.startsWith("${context.packageJson.name}@"))`;
+										},
+										children: __alloy_js_core.code`return packageJsonPath; `
+									})];
+								}
+							}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseClause, { children: __alloy_js_core.code`return packageJsonPath; ` })];
+						}
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseClause, { children: __alloy_js_core.code`currentPath = parentPath;
           parentPath = resolve(currentPath, ".."); ` }),
 					__alloy_js_core.code` }
 
@@ -117,7 +149,6 @@ function LocateLockfileFunctionDeclaration() {
 		}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.FunctionDeclaration, {
 			"export": true,
-			async: true,
 			name: "locateLockfile",
 			parameters: [{
 				name: "options",
@@ -162,7 +193,7 @@ function LocateLockfileFunctionDeclaration() {
 						condition: __alloy_js_core.code`lockfile`,
 						children: __alloy_js_core.code`return lockfile; `
 					}),
-					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseClause, { children: __alloy_js_core.code`currentPath = pathParent;
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseClause, { children: __alloy_js_core.code`currentPath = parentPath;
           parentPath = resolve(currentPath, ".."); ` }),
 					__alloy_js_core.code` }
 
@@ -177,6 +208,15 @@ function LocateLockfileFunctionDeclaration() {
 */
 function GetPackageManagerFunctionDeclaration() {
 	return [
+		__alloy_js_core.code`declare global {
+        var Bun: any;
+        namespace NodeJS {
+          interface ProcessVersions {
+            bun?: string;
+          }
+        }
+      } `,
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TypeDeclaration, {
 			"export": true,
 			name: "GetPackageManagerOptions",
@@ -265,7 +305,7 @@ function GetPackageManagerFunctionDeclaration() {
 									(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
 										"const": true,
 										name: "packageJsonPath",
-										initializer: __alloy_js_core.code`locatePackageJson(options); `
+										initializer: __alloy_js_core.code`await locatePackageJson(options); `
 									}),
 									(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
 										condition: __alloy_js_core.code`packageJsonPath && existsSync(packageJsonPath)`,
@@ -512,9 +552,10 @@ function FetchNpmPackageFunctionDeclaration() {
 	];
 }
 /**
-* The `getLatest` handler function declaration code for the Shell Shock project.
+* The `getLatestVersion` handler function declaration code for the Shell Shock project.
 */
-function GetLatestFunctionDeclaration() {
+function GetLatestVersionFunctionDeclaration() {
+	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
 	return [(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDoc, {
 		heading: "Get the latest version of the application from the npm registry.",
 		get children() {
@@ -531,45 +572,124 @@ function GetLatestFunctionDeclaration() {
 	}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.FunctionDeclaration, {
 		"export": true,
 		async: true,
-		name: "getLatest",
+		name: "getLatestVersion",
+		get parameters() {
+			return [{
+				name: "packageName",
+				default: `"${context.packageJson.name}"`
+			}];
+		},
+		returnType: __alloy_js_core.code`Promise<string | undefined>`,
+		get children() {
+			return [
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+					"const": true,
+					name: "result",
+					initializer: __alloy_js_core.code`await fetchNpmPackage(packageName); `
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+				__alloy_js_core.code`return result?.version; `
+			];
+		}
+	})];
+}
+/**
+* The `upgrade` handler function declaration code for the Shell Shock project.
+*/
+function GetUpgradeCommandFunctionDeclaration() {
+	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return [(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDoc, {
+		heading: "A function to get the upgrade command for a specific package manager.",
+		get children() {
+			return [
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocRemarks, { children: `This function is used to get the appropriate upgrade command for a specific package manager. It can be used in the CLI upgrade command to determine which command to run based on the package manager being used by the application.` }),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocParam, {
+					name: "packageManager",
+					children: `The name of the package manager to get the upgrade command for. This should be one of "npm", "yarn", "pnpm", "deno", or "bun".`
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocParam, {
+					name: "cwd",
+					children: `The current working directory to use when determining the upgrade command. This can be used to locate the appropriate package.json and lockfile to determine how to run the upgrade command. If not provided, the process's current working directory will be used.`
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocReturns, { children: `An array of strings representing the command and its arguments to run in order to upgrade the application dependencies using the specified package manager.` })
+			];
+		}
+	}), (0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.FunctionDeclaration, {
+		"export": true,
+		async: true,
+		name: "getUpgradeCommand",
 		parameters: [{
-			name: "packageName",
+			name: "packageManager",
 			type: "string"
+		}, {
+			name: "cwd",
+			type: "string",
+			default: "process.cwd()"
 		}],
+		returnType: "Promise<string[]>",
 		get children() {
 			return [
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
 					"const": true,
-					name: "package",
-					initializer: __alloy_js_core.code`await fetchNpmPackage(packageName); `
+					name: "version",
+					get initializer() {
+						return __alloy_js_core.code`(await getLatestVersion("${context.packageJson.name}")) || "latest"; `;
+					}
 				}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
-				__alloy_js_core.code`return package?.version; `
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
+					condition: __alloy_js_core.code`packageManager === "yarn"`,
+					get children() {
+						return __alloy_js_core.code`return ["upgrade", \`${context.packageJson.name}@\${version}\`]; `;
+					}
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseIfClause, {
+					condition: __alloy_js_core.code`packageManager === "pnpm"`,
+					get children() {
+						return __alloy_js_core.code`return ["update", \`${context.packageJson.name}@\${version}\`]; `;
+					}
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseIfClause, {
+					condition: __alloy_js_core.code`packageManager === "deno"`,
+					get children() {
+						return __alloy_js_core.code`return ["outdated", "--update", \`${context.packageJson.name}@\${version}\`]; `;
+					}
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseIfClause, {
+					condition: __alloy_js_core.code`packageManager === "bun"`,
+					get children() {
+						return __alloy_js_core.code`return ["update", "--save",  \`${context.packageJson.name}@\${version}\`]; `;
+					}
+				}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseClause, { get children() {
+					return __alloy_js_core.code`return ["update", "--save", "--bin-links", \`${context.packageJson.name}@\${version}\`]; `;
+				} })
 			];
 		}
 	})];
 }
 /**
-* The `install` handler function declaration code for the Shell Shock project.
+* The `upgrade` handler function declaration code for the Shell Shock project.
 */
-function InstallFunctionDeclaration() {
+function UpgradeFunctionDeclaration() {
 	return [
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.InterfaceDeclaration, {
-			name: "InstallBaseOptions",
-			doc: "Options for the `install` handler function.",
+			name: "UpgradeBaseOptions",
+			doc: "Options for the `upgrade` handler function.",
 			get children() {
 				return [
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
 						name: "stdout",
 						optional: true,
-						type: "(string) => void",
+						type: "(data: string) => void",
 						doc: "A callback function that is called with the stdout output of the command."
 					}),
 					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
 						name: "stderr",
 						optional: true,
-						type: "(string) => void",
+						type: "(err: string) => void",
 						doc: "A callback function that is called with the stderr output of the command."
 					})
 				];
@@ -578,32 +698,32 @@ function InstallFunctionDeclaration() {
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TypeDeclaration, {
 			"export": true,
-			name: "InstallOptions",
-			doc: "Options for the `install` handler function.",
-			children: __alloy_js_core.code`InstallBaseOptions & Parameters<typeof spawn>[2];`
+			name: "UpgradeOptions",
+			doc: "Options for the `upgrade` handler function.",
+			children: __alloy_js_core.code`UpgradeBaseOptions & GetPackageManagerOptions & Parameters<typeof spawn>[2];`
 		}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDoc, {
-			heading: "Install the application dependencies.",
+			heading: "Upgrade the application dependencies.",
 			get children() {
 				return [
-					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocRemarks, { children: `This function is used to install the application dependencies. It can be used in the CLI upgrade command to ensure that all necessary dependencies are installed.` }),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocRemarks, { children: `This function is used to upgrade the application dependencies. It can be used in the CLI upgrade command to ensure that all necessary dependencies are up-to-date.` }),
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocParam, {
 						name: "options",
-						children: `The options for the \`install\` function. Currently, there are no options available, but this parameter is included for future extensibility.`
+						children: `The options for the \`upgrade\` function. Currently, there are no options available, but this parameter is included for future extensibility.`
 					}),
-					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocReturns, { children: `A promise that resolves when the installation of dependencies is complete.` })
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocReturns, { children: `A promise that resolves when the upgrade of dependencies is complete.` })
 				];
 			}
 		}),
 		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.FunctionDeclaration, {
 			"export": true,
 			async: true,
-			name: "install",
+			name: "upgrade",
 			parameters: [{
 				name: "options",
-				type: "InstallOptions",
+				type: "UpgradeOptions",
 				default: "{}"
 			}],
 			get children() {
@@ -611,9 +731,15 @@ function InstallFunctionDeclaration() {
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
 						"const": true,
 						name: "packageManager",
-						initializer: __alloy_js_core.code`getPackageManager(); `
+						initializer: __alloy_js_core.code`await getPackageManager(options); `
 					}),
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+						"const": true,
+						name: "args",
+						initializer: __alloy_js_core.code`await getUpgradeCommand(packageManager, options.cwd); `
+					}),
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
 						"let": true,
 						name: "output",
@@ -622,9 +748,9 @@ function InstallFunctionDeclaration() {
 					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
 					__alloy_js_core.code`await spawn(
           \`\${packageManager}\${isWindows && packageManager !== "bun" ? ".cmd" : ""}\`,
-          ["install"],
+          [args.join(" ")],
           {
-            ...options
+            ...options,
             env: {
               ...options.env,
               ...(packageManager === "pnpm" ? { npm_config_strict_peer_dependencies: false } : null),
@@ -644,6 +770,147 @@ function InstallFunctionDeclaration() {
 	];
 }
 /**
+* The `checkForUpdates` handler function declaration code for the Shell Shock project.
+*/
+function CheckForUpdatesFunctionDeclaration() {
+	const context = (0, __powerlines_plugin_alloy_core_contexts_context.usePowerlines)();
+	return [
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.InterfaceDeclaration, {
+			"export": true,
+			name: "CheckForUpdatesOptions",
+			"extends": "GetPackageManagerOptions",
+			doc: "Options for the `checkForUpdates` handler function."
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.InterfaceDeclaration, {
+			"export": true,
+			name: "CheckForUpdatesResult",
+			doc: "The result for the `checkForUpdates` handler function.",
+			get children() {
+				return [
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
+						name: "latestVersion",
+						type: "string",
+						doc: "The latest version of the application dependencies."
+					}),
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
+						name: "currentVersion",
+						type: "string",
+						doc: "The current version of the application dependencies."
+					}),
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
+						name: "isUpToDate",
+						type: "boolean",
+						doc: "Indicates whether the application dependencies are up-to-date."
+					}),
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
+						name: "package",
+						type: "NpmPackage",
+						doc: "The npm package that was checked for updates."
+					}),
+					(0, __alloy_js_core_jsx_runtime.createIntrinsic)("hbr", {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.InterfaceMember, {
+						name: "packageManager",
+						type: "'npm' | 'yarn' | 'pnpm' | 'deno' | 'bun'",
+						doc: "The package manager used to check for updates."
+					})
+				];
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDoc, {
+			heading: "Check for updates to the application dependencies.",
+			get children() {
+				return [
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocRemarks, { children: `This function is used to check for updates to the application dependencies. It can be used in the CLI upgrade command to ensure that all necessary dependencies are up-to-date.` }),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocParam, {
+						name: "options",
+						children: `The options for the \`checkForUpdates\` function. Currently, there are no options available, but this parameter is included for future extensibility.`
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_typescript.TSDocReturns, { children: `A promise that resolves when the check for updates is complete or undefined if the check was not performed.` })
+				];
+			}
+		}),
+		(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.FunctionDeclaration, {
+			"export": true,
+			async: true,
+			name: "checkForUpdates",
+			parameters: [{
+				name: "options",
+				type: "CheckForUpdatesOptions",
+				default: "{}"
+			}],
+			returnType: "Promise<CheckForUpdatesResult | undefined>",
+			get children() {
+				return [
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+						"const": true,
+						name: "filePath",
+						initializer: __alloy_js_core.code`join(paths.data, "version-check.json"); `
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
+						condition: __alloy_js_core.code`existsSync(filePath)`,
+						get children() {
+							return [
+								(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+									"const": true,
+									name: "file",
+									type: "{ timestamp: number; }",
+									initializer: __alloy_js_core.code` JSON.parse(await readFile(filePath, "utf8")); `
+								}),
+								(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
+									condition: __alloy_js_core.code`!file.timestamp`,
+									children: __alloy_js_core.code`await writeFile(filePath, JSON.stringify({ timestamp: new Date().getTime() }), "utf8");
+            return undefined; `
+								}),
+								(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseIfClause, {
+									get condition() {
+										return __alloy_js_core.code`new Date().getTime() - file.timestamp < ${context.config.upgrade.staleTime}`;
+									},
+									children: __alloy_js_core.code`return undefined; `
+								})
+							];
+						}
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.ElseClause, { children: __alloy_js_core.code`await writeFile(filePath, JSON.stringify({ timestamp: new Date().getTime() }), "utf8");
+              return undefined; ` }),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+						"const": true,
+						name: "packageManager",
+						initializer: __alloy_js_core.code`await getPackageManager(options); `
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.VarDeclaration, {
+						"const": true,
+						name: "pkg",
+						initializer: __alloy_js_core.code`await fetchNpmPackage(); `
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_typescript.IfStatement, {
+						condition: __alloy_js_core.code`!pkg`,
+						children: __alloy_js_core.code`return undefined; `
+					}),
+					(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+					(0, __alloy_js_core_jsx_runtime.memo)(() => __alloy_js_core.code`await writeFile(filePath, JSON.stringify({ timestamp: new Date().getTime() }), "utf8");
+
+          return {
+          latestVersion: pkg?.version ?? "0.0.0",
+          currentVersion: "${context.packageJson.version}",
+          isUpToDate: pkg ? "${context.packageJson.version}" === pkg.version : true,
+          package: pkg,
+          packageManager,
+        }; `)
+				];
+			}
+		})
+	];
+}
+/**
 * A built-in upgrade module for Shell Shock.
 */
 function UpgradeBuiltin(props) {
@@ -688,15 +955,21 @@ function UpgradeBuiltin(props) {
 					initializer: __alloy_js_core.code`os.tmpdir(); `
 				}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(LocatePackageJsonFunctionDeclaration, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(LocateLockfileFunctionDeclaration, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(GetPackageManagerFunctionDeclaration, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(FetchNpmPackageFunctionDeclaration, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
-				(0, __alloy_js_core_jsx_runtime.createComponent)(GetLatestFunctionDeclaration, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(GetLatestVersionFunctionDeclaration, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(GetUpgradeCommandFunctionDeclaration, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(UpgradeFunctionDeclaration, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
-				(0, __alloy_js_core_jsx_runtime.createComponent)(InstallFunctionDeclaration, {}),
+				(0, __alloy_js_core_jsx_runtime.createComponent)(CheckForUpdatesFunctionDeclaration, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__powerlines_plugin_alloy_core_components_spacing.Spacing, {}),
 				(0, __alloy_js_core_jsx_runtime.createComponent)(__alloy_js_core.Show, {
 					get when() {
@@ -710,10 +983,12 @@ function UpgradeBuiltin(props) {
 }
 
 //#endregion
+exports.CheckForUpdatesFunctionDeclaration = CheckForUpdatesFunctionDeclaration;
 exports.FetchNpmPackageFunctionDeclaration = FetchNpmPackageFunctionDeclaration;
-exports.GetLatestFunctionDeclaration = GetLatestFunctionDeclaration;
+exports.GetLatestVersionFunctionDeclaration = GetLatestVersionFunctionDeclaration;
 exports.GetPackageManagerFunctionDeclaration = GetPackageManagerFunctionDeclaration;
-exports.InstallFunctionDeclaration = InstallFunctionDeclaration;
+exports.GetUpgradeCommandFunctionDeclaration = GetUpgradeCommandFunctionDeclaration;
 exports.LocateLockfileFunctionDeclaration = LocateLockfileFunctionDeclaration;
 exports.LocatePackageJsonFunctionDeclaration = LocatePackageJsonFunctionDeclaration;
-exports.UpgradeBuiltin = UpgradeBuiltin;
+exports.UpgradeBuiltin = UpgradeBuiltin;
+exports.UpgradeFunctionDeclaration = UpgradeFunctionDeclaration;

package/dist/components/upgrade-builtin.d.cts

@@ -19,18 +19,26 @@ declare function GetPackageManagerFunctionDeclaration(): _alloy_js_core0.Childre
  */
 declare function FetchNpmPackageFunctionDeclaration(): _alloy_js_core0.Children;
 /**
- * The `getLatest` handler function declaration code for the Shell Shock project.
+ * The `getLatestVersion` handler function declaration code for the Shell Shock project.
  */
-declare function GetLatestFunctionDeclaration(): _alloy_js_core0.Children;
+declare function GetLatestVersionFunctionDeclaration(): _alloy_js_core0.Children;
 /**
- * The `install` handler function declaration code for the Shell Shock project.
+ * The `upgrade` handler function declaration code for the Shell Shock project.
  */
-declare function InstallFunctionDeclaration(): _alloy_js_core0.Children;
+declare function GetUpgradeCommandFunctionDeclaration(): _alloy_js_core0.Children;
+/**
+ * The `upgrade` handler function declaration code for the Shell Shock project.
+ */
+declare function UpgradeFunctionDeclaration(): _alloy_js_core0.Children;
+/**
+ * The `checkForUpdates` handler function declaration code for the Shell Shock project.
+ */
+declare function CheckForUpdatesFunctionDeclaration(): _alloy_js_core0.Children;
 interface UpgradeBuiltinProps extends Omit<BuiltinFileProps, "id" | "description"> {}
 /**
  * A built-in upgrade module for Shell Shock.
  */
 declare function UpgradeBuiltin(props: UpgradeBuiltinProps): _alloy_js_core0.Children;
 //#endregion
-export { FetchNpmPackageFunctionDeclaration, GetLatestFunctionDeclaration, GetPackageManagerFunctionDeclaration, InstallFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps };
+export { CheckForUpdatesFunctionDeclaration, FetchNpmPackageFunctionDeclaration, GetLatestVersionFunctionDeclaration, GetPackageManagerFunctionDeclaration, GetUpgradeCommandFunctionDeclaration, LocateLockfileFunctionDeclaration, LocatePackageJsonFunctionDeclaration, UpgradeBuiltin, UpgradeBuiltinProps, UpgradeFunctionDeclaration };
 //# sourceMappingURL=upgrade-builtin.d.cts.map

package/dist/components/upgrade-builtin.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"upgrade-builtin.d.cts","names":[],"sources":["../../src/components/upgrade-builtin.tsx"],"sourcesContent":[],"mappings":";;;;;;;AA2CgB,iBAAA,oCAAA,CAAA,CAAoC,EAAA,eAAA,CAAA,QAAA;AAwEpD;AAwFA;AAyIA;AA6KgB,iBA9YA,iCAAA,CAAA,CA8Y4B,EA9YK,eAAA,CAAA,QA8YL;AAwC5C;AAgFA;AAQA;iBAtbgB,oCAAA,CAAA,GAAoC,eAAA,CAAA;;;;iBAyIpC,kCAAA,CAAA,GAAkC,eAAA,CAAA;;;;iBA6KlC,4BAAA,CAAA,GAA4B,eAAA,CAAA;;;;iBAwC5B,0BAAA,CAAA,GAA0B,eAAA,CAAA;UAgFzB,mBAAA,SAA4B,KAC3C;;;;iBAOc,cAAA,QAAsB,sBAAmB,eAAA,CAAA"}
+{"version":3,"file":"upgrade-builtin.d.cts","names":[],"sources":["../../src/components/upgrade-builtin.tsx"],"sourcesContent":[],"mappings":";;;;;;;AA6CgB,iBAAA,oCAAA,CAAA,CAAoC,EAAA,eAAA,CAAA,QAAA;AAgGpD;AAuFA;AAkJA;AA6KgB,iBAtZA,iCAAA,CAAA,CAsZmC,EAtZF,eAAA,CAAA,QAsZE;AA2CnD;AAyEA;AAyFA;AAgIiB,iBA5oBD,oCAAA,CAAA,CA4oBiC,EA5oBG,eAAA,CAAA,QA4oBH;AAQjD;;;iBAlgBgB,kCAAA,CAAA,GAAkC,eAAA,CAAA;;;;iBA6KlC,mCAAA,CAAA,GAAmC,eAAA,CAAA;;;;iBA2CnC,oCAAA,CAAA,GAAoC,eAAA,CAAA;;;;iBAyEpC,0BAAA,CAAA,GAA0B,eAAA,CAAA;;;;iBAyF1B,kCAAA,CAAA,GAAkC,eAAA,CAAA;UAgIjC,mBAAA,SAA4B,KAC3C;;;;iBAOc,cAAA,QAAsB,sBAAmB,eAAA,CAAA"}