create-rstack 1.0.0-beta.0 → 1.0.1

package/README.md

@@ -1,48 +1,28 @@
-# rsbuild-plugin-example
+# create-rstack
 
-rsbuild-plugin-example is a Rsbuild plugin to do something.
+A shared package for create-rspack, create-rsbuild, create-rspress and create-rslib.
+
+> This package should only be used in Rstack projects.
 
 <p>
-  <a href="https://npmjs.com/package/rsbuild-plugin-example">
-   <img src="https://img.shields.io/npm/v/rsbuild-plugin-example?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
+  <a href="https://npmjs.com/package/create-rstack">
+   <img src="https://img.shields.io/npm/v/create-rstack?style=flat-square&colorA=564341&colorB=EDED91" alt="npm version" />
   </a>
   <img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square&colorA=564341&colorB=EDED91" alt="license" />
 </p>
 
-## Usage
-
-Install:
+## Install
 
 ```bash
-npm add rsbuild-plugin-example -D
-```
-
-Add plugin to your `rsbuild.config.ts`:
-
-```ts
-// rsbuild.config.ts
-import { pluginExample } from "rsbuild-plugin-example";
-
-export default {
-  plugins: [pluginExample()],
-};
+npm add create-rstack -D
 ```
 
-## Options
+## Example
 
-### foo
+See: [create-rsbuild](https://github.com/web-infra-dev/rsbuild/tree/main/packages/create-rsbuild).
 
-Some description.
+![image](https://github.com/user-attachments/assets/2dda3501-720c-4151-bd3e-5e038dca9e68)
 
-- Type: `string`
-- Default: `undefined`
-- Example:
-
-```js
-pluginExample({
-  foo: "bar",
-});
-```
 
 ## License
 

package/dist/index.d.ts

@@ -9,9 +9,10 @@ export type Argv = {
     tools?: string | string[];
 };
 export type ESLintTemplateName = 'vanilla-js' | 'vanilla-ts' | 'react-js' | 'react-ts' | 'vue-ts' | 'vue-js' | 'svelte-js' | 'svelte-ts';
-export declare function create({ name, root, templates, getTemplateName, mapESLintTemplate, }: {
+export declare function create({ name, root, templates, skipFiles, getTemplateName, mapESLintTemplate, }: {
     name: string;
     root: string;
+    skipFiles?: string[];
     templates: string[];
     getTemplateName: (argv: Argv) => Promise<string>;
     mapESLintTemplate: (templateName: string) => ESLintTemplateName | null;

package/dist/index.js

@@ -1158,7 +1158,7 @@ async function getTools({ tools, dir, template }) {
 function upperFirst(str) {
     return str.charAt(0).toUpperCase() + str.slice(1);
 }
-async function create({ name, root, templates, getTemplateName, mapESLintTemplate }) {
+async function create({ name, root, templates, skipFiles, getTemplateName, mapESLintTemplate }) {
     const argv = minimist_default()(process.argv.slice(2), {
         alias: {
             h: 'help',
@@ -1217,13 +1217,15 @@ async function create({ name, root, templates, getTemplateName, mapESLintTemplat
     copyFolder({
         from: commonFolder,
         to: distFolder,
-        version
+        version,
+        skipFiles
     });
     copyFolder({
         from: srcFolder,
         to: distFolder,
         version,
-        packageName
+        packageName,
+        skipFiles
     });
     const packageRoot = external_node_path_namespaceObject["default"].resolve(src_dirname, '..');
     for (const tool of tools){
@@ -1238,6 +1240,7 @@ async function create({ name, root, templates, getTemplateName, mapESLintTemplat
                 from: subFolder,
                 to: distFolder,
                 version,
+                skipFiles,
                 isMergePackageJson: true
             });
         } else {
@@ -1245,6 +1248,7 @@ async function create({ name, root, templates, getTemplateName, mapESLintTemplat
                 from: toolFolder,
                 to: distFolder,
                 version,
+                skipFiles,
                 isMergePackageJson: true
             });
         }
@@ -1285,20 +1289,21 @@ function mergePackageJson(targetPackage, extraPackage) {
     }
     external_node_fs_namespaceObject["default"].writeFileSync(targetPackage, `${JSON.stringify(mergedJson, null, 2)}\n`);
 }
-function copyFolder({ from, to, version, packageName, isMergePackageJson }) {
+function copyFolder({ from, to, version, packageName, isMergePackageJson, skipFiles = [] }) {
     const renameFiles = {
         gitignore: '.gitignore'
     };
     // Skip local files
-    const skipFiles = [
+    const allSkipFiles = [
         'node_modules',
-        'dist'
+        'dist',
+        ...skipFiles
     ];
     external_node_fs_namespaceObject["default"].mkdirSync(to, {
         recursive: true
     });
     for (const file of external_node_fs_namespaceObject["default"].readdirSync(from)){
-        if (skipFiles.includes(file)) {
+        if (allSkipFiles.includes(file)) {
             continue;
         }
         const srcFile = external_node_path_namespaceObject["default"].resolve(from, file);
@@ -1308,7 +1313,8 @@ function copyFolder({ from, to, version, packageName, isMergePackageJson }) {
             copyFolder({
                 from: srcFile,
                 to: distFile,
-                version
+                version,
+                skipFiles
             });
         } else if (file === 'package.json') {
             const targetPackage = external_node_path_namespaceObject["default"].resolve(to, 'package.json');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rstack",
-  "version": "1.0.0-beta.0",
+  "version": "1.0.1",
   "description": "Create a new Rstack project",
   "repository": {
     "type": "git",