create-rstack 1.0.7 → 1.0.9

package/README.md

@@ -17,13 +17,15 @@ A shared package for create-rspack, create-rsbuild, create-rspress and create-rs
 npm add create-rstack -D
 ```
 
-## Example
+## Examples
 
-See: [create-rsbuild](https://github.com/web-infra-dev/rsbuild/tree/main/packages/create-rsbuild).
+| Project | Link                                                                                         |
+| ------- | -------------------------------------------------------------------------------------------- |
+| Rsbuild | [create-rsbuild](https://github.com/web-infra-dev/rsbuild/tree/main/packages/create-rsbuild) |
+| Rslib   | [create-rslib](https://github.com/web-infra-dev/rslib/tree/main/packages/create-rslib)       |
 
 ![image](https://github.com/user-attachments/assets/2dda3501-720c-4151-bd3e-5e038dca9e68)
 
-
 ## License
 
 [MIT](./LICENSE).

package/dist/index.d.ts

@@ -8,6 +8,24 @@ export declare type Argv = {
 
 export declare function checkCancel<T>(value: unknown): T;
 
+/**
+ * Copy files from one folder to another.
+ * @param from Source folder
+ * @param to Destination folder
+ * @param version - Optional. The version to update in the package.json. If not provided, version will not be updated.
+ * @param name - Optional. The name to update in the package.json. If not provided, name will not be updated.
+ * @param isMergePackageJson Merge package.json files
+ * @param skipFiles Files to skip
+ */
+export declare function copyFolder({ from, to, version, packageName, isMergePackageJson, skipFiles, }: {
+    from: string;
+    to: string;
+    version?: string;
+    packageName?: string;
+    isMergePackageJson?: boolean;
+    skipFiles?: string[];
+}): void;
+
 export declare function create({ name, root, templates, skipFiles, getTemplateName, mapESLintTemplate, }: {
     name: string;
     root: string;
@@ -19,6 +37,13 @@ export declare function create({ name, root, templates, skipFiles, getTemplateNa
 
 export declare type ESLintTemplateName = 'vanilla-js' | 'vanilla-ts' | 'react-js' | 'react-ts' | 'vue-ts' | 'vue-js' | 'svelte-js' | 'svelte-ts';
 
+/**
+ * Merge two package.json files and keep the order of keys.
+ * @param targetPackage Path to the base package.json file
+ * @param extraPackage Path to the extra package.json file to merge
+ */
+export declare function mergePackageJson(targetPackage: string, extraPackage: string): void;
+
 export declare const multiselect: <Options extends Option_2<Value>[], Value>(opts: MultiSelectOptions<Options, Value>) => Promise<symbol | Value[]>;
 
 declare interface MultiSelectOptions<Options extends Option_2<Value>[], Value> {

package/dist/index.js

@@ -1693,7 +1693,11 @@ function sortObjectKeys(obj) {
     for (const key of sortedKeys)sortedObj[key] = obj[key];
     return sortedObj;
 }
-function mergePackageJson(targetPackage, extraPackage) {
+/**
+ * Merge two package.json files and keep the order of keys.
+ * @param targetPackage Path to the base package.json file
+ * @param extraPackage Path to the extra package.json file to merge
+ */ function mergePackageJson(targetPackage, extraPackage) {
     if (!__WEBPACK_EXTERNAL_MODULE_node_fs__["default"].existsSync(targetPackage)) return;
     const targetJson = JSON.parse(__WEBPACK_EXTERNAL_MODULE_node_fs__["default"].readFileSync(targetPackage, 'utf-8'));
     const extraJson = JSON.parse(__WEBPACK_EXTERNAL_MODULE_node_fs__["default"].readFileSync(extraPackage, 'utf-8'));
@@ -1708,7 +1712,15 @@ function mergePackageJson(targetPackage, extraPackage) {
     }
     __WEBPACK_EXTERNAL_MODULE_node_fs__["default"].writeFileSync(targetPackage, `${JSON.stringify(mergedJson, null, 2)}\n`);
 }
-function copyFolder({ from, to, version, packageName, isMergePackageJson, skipFiles = [] }) {
+/**
+ * Copy files from one folder to another.
+ * @param from Source folder
+ * @param to Destination folder
+ * @param version - Optional. The version to update in the package.json. If not provided, version will not be updated.
+ * @param name - Optional. The name to update in the package.json. If not provided, name will not be updated.
+ * @param isMergePackageJson Merge package.json files
+ * @param skipFiles Files to skip
+ */ function copyFolder({ from, to, version, packageName, isMergePackageJson, skipFiles = [] }) {
     const renameFiles = {
         gitignore: '.gitignore'
     };
@@ -1749,13 +1761,21 @@ const isStableVersion = (version)=>[
         'canary',
         'nightly'
     ].every((tag)=>!version.includes(tag));
-const updatePackageJson = (pkgJsonPath, version, name)=>{
+/**
+ * Updates the package.json file at the specified path with the provided version and name.
+ *
+ * @param pkgJsonPath - The file path to the package.json file.
+ * @param version - Optional. The version to update in the package.json. If not provided, version will not be updated.
+ * @param name - Optional. The name to update in the package.json. If not provided, name will not be updated.
+ */ const updatePackageJson = (pkgJsonPath, version, name)=>{
     let content = __WEBPACK_EXTERNAL_MODULE_node_fs__["default"].readFileSync(pkgJsonPath, 'utf-8');
-    // Lock the version if it is not stable
-    const targetVersion = isStableVersion(version) ? `^${version}` : version;
-    content = content.replace(/workspace:\*/g, targetVersion);
+    if ('string' == typeof version) {
+        // Lock the version if it is not stable
+        const targetVersion = isStableVersion(version) ? `^${version}` : version;
+        content = content.replace(/workspace:\*/g, targetVersion);
+    }
     const pkg = JSON.parse(content);
     if (name && '.' !== name) pkg.name = name;
-    __WEBPACK_EXTERNAL_MODULE_node_fs__["default"].writeFileSync(pkgJsonPath, JSON.stringify(pkg, null, 2));
+    __WEBPACK_EXTERNAL_MODULE_node_fs__["default"].writeFileSync(pkgJsonPath, `${JSON.stringify(pkg, null, 2)}\n`);
 };
-export { checkCancel, create, ae as multiselect, ie as select, te as text };
+export { checkCancel, copyFolder, create, mergePackageJson, ae as multiselect, ie as select, te as text };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rstack",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "Create a new Rstack project",
   "repository": {
     "type": "git",