create-rslib 0.19.3 → 0.19.4

package/dist/index.js

@@ -1,265 +1,31 @@
 #!/usr/bin/env node
+import node_fs from "node:fs";
 import node_path from "node:path";
 import { fileURLToPath } from "node:url";
-import { BUILTIN_TOOLS, checkCancel, create, multiselect, select as external_create_rstack_select } from "create-rstack";
-import "node:fs";
-const helpers_filename = fileURLToPath(import.meta.url);
-const helpers_dirname = node_path.dirname(helpers_filename);
-node_path.resolve(helpers_dirname, '../fragments');
-const composeTemplateName = ({ template, tools, lang })=>`[${template}]-[${(tools ? tools.sort() : []).join(',')}]-${lang}`;
+import { checkCancel, copyFolder, create, select as external_create_rstack_select } from "create-rstack";
 const TEMPLATES = [
-    {
-        template: 'node-dual',
-        lang: 'js'
-    },
-    {
-        template: 'node-dual',
-        lang: 'ts'
-    },
-    {
-        template: 'node-dual',
-        lang: 'js',
-        tools: {
-            vitest: 'vitest-node-js'
-        }
-    },
-    {
-        template: 'node-dual',
-        lang: 'ts',
-        tools: {
-            vitest: 'vitest-node-ts'
-        }
-    },
-    {
-        template: 'node-dual',
-        lang: 'js',
-        tools: {
-            rstest: 'rstest-node-js'
-        }
-    },
-    {
-        template: 'node-dual',
-        lang: 'ts',
-        tools: {
-            rstest: 'rstest-node-ts'
-        }
-    },
-    {
-        template: 'node-esm',
-        lang: 'js'
-    },
-    {
-        template: 'node-esm',
-        lang: 'ts'
-    },
-    {
-        template: 'node-esm',
-        lang: 'js',
-        tools: {
-            vitest: 'vitest-node-js'
-        }
-    },
-    {
-        template: 'node-esm',
-        lang: 'ts',
-        tools: {
-            vitest: 'vitest-node-ts'
-        }
-    },
-    {
-        template: 'node-esm',
-        lang: 'js',
-        tools: {
-            rstest: 'rstest-node-js'
-        }
-    },
-    {
-        template: 'node-esm',
-        lang: 'ts',
-        tools: {
-            rstest: 'rstest-node-ts'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'js'
-    },
-    {
-        template: 'react',
-        lang: 'js',
-        tools: {
-            storybook: 'storybook-react-js'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'js',
-        tools: {
-            vitest: 'vitest-react-js'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'js',
-        tools: {
-            rstest: 'rstest-react-js'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'js',
-        tools: {
-            storybook: 'storybook-react-js',
-            vitest: 'vitest-react-js'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'js',
-        tools: {
-            storybook: 'storybook-react-js',
-            rstest: 'rstest-react-js'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'ts'
-    },
-    {
-        template: 'react',
-        lang: 'ts',
-        tools: {
-            storybook: 'storybook-react-ts'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'ts',
-        tools: {
-            vitest: 'vitest-react-ts'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'ts',
-        tools: {
-            rstest: 'rstest-react-ts'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'ts',
-        tools: {
-            storybook: 'storybook-react-ts',
-            vitest: 'vitest-react-ts'
-        }
-    },
-    {
-        template: 'react',
-        lang: 'ts',
-        tools: {
-            storybook: 'storybook-react-ts',
-            rstest: 'rstest-react-ts'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'js'
-    },
-    {
-        template: 'vue',
-        lang: 'js',
-        tools: {
-            storybook: 'storybook-vue-js'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'js',
-        tools: {
-            vitest: 'vitest-vue-js'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'js',
-        tools: {
-            rstest: 'rstest-vue-js'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'js',
-        tools: {
-            storybook: 'storybook-vue-js',
-            vitest: 'vitest-vue-js'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'js',
-        tools: {
-            storybook: 'storybook-vue-js',
-            rstest: 'rstest-vue-js'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'ts'
-    },
-    {
-        template: 'vue',
-        lang: 'ts',
-        tools: {
-            storybook: 'storybook-vue-ts'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'ts',
-        tools: {
-            vitest: 'vitest-vue-ts'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'ts',
-        tools: {
-            rstest: 'rstest-vue-ts'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'ts',
-        tools: {
-            storybook: 'storybook-vue-ts',
-            vitest: 'vitest-vue-ts'
-        }
-    },
-    {
-        template: 'vue',
-        lang: 'ts',
-        tools: {
-            storybook: 'storybook-vue-ts',
-            rstest: 'rstest-vue-ts'
-        }
-    }
+    'node-dual-js',
+    'node-dual-ts',
+    'node-esm-js',
+    'node-esm-ts',
+    'react-js',
+    'react-ts',
+    'vue-js',
+    'vue-ts'
 ];
 const src_dirname = node_path.dirname(fileURLToPath(import.meta.url));
-async function getTemplateName(argv) {
-    if ('string' == typeof argv.template) {
-        const pair = argv.template.split('-');
-        const lang = pair[pair.length - 1] ?? 'ts';
+function parseTemplateName(template) {
+    const pair = template.split('-');
+    const lastPart = pair[pair.length - 1];
+    if ('ts' === lastPart || 'js' === lastPart) {
         const rest = pair.slice(0, pair.length - 1).join('-');
-        const tools = ('string' == typeof argv.tools ? [
-            argv.tools
-        ] : argv.tools ?? []).filter((tool)=>!BUILTIN_TOOLS.includes(tool));
-        return composeTemplateName({
-            template: rest,
-            lang: lang,
-            tools
-        });
+        if (!rest) throw new Error(`Invalid template name: "${template}". Template name cannot be just a language suffix.`);
+        return `${rest}-${lastPart}`;
     }
+    return `${template}-ts`;
+}
+async function getTemplateName({ template }) {
+    if ('string' == typeof template) return parseTemplateName(template);
     const templateName = checkCancel(await external_create_rstack_select({
         message: 'Select template',
         options: [
@@ -294,54 +60,107 @@ async function getTemplateName(argv) {
             }
         ]
     }));
-    const supportStorybook = [
-        'react',
-        'vue'
-    ].includes(templateName);
-    async function selectTools() {
-        const tools = checkCancel(await multiselect({
-            message: 'Select development tools (Use <space> to select, <enter> to continue)',
-            required: false,
-            options: [
-                supportStorybook && {
-                    value: 'storybook',
-                    label: 'Storybook'
-                },
-                {
-                    value: 'rstest',
-                    label: 'Rstest'
-                },
-                {
-                    value: 'vitest',
-                    label: 'Vitest'
-                }
-            ].filter(Boolean)
-        }));
-        if (tools.includes('rstest') && tools.includes('vitest')) {
-            console.error('You selected both Rstest and Vitest for testing, you should only select one of them.');
-            return selectTools();
-        }
-        return tools;
-    }
-    const tools = await selectTools();
-    return composeTemplateName({
-        template: templateName,
-        lang: language,
-        tools
-    });
+    return `${templateName}-${language}`;
 }
 function mapESLintTemplate(templateName) {
     const language = templateName.split('-').pop();
     return `vanilla-${language}`;
 }
+function mapTestingToolTemplate(templateName) {
+    if (templateName.startsWith('react-')) return templateName;
+    if (templateName.startsWith('vue-')) return templateName;
+    if (templateName.startsWith('node-dual-')) return templateName.replace('node-dual-', 'node-');
+    if (templateName.startsWith('node-esm-')) return templateName.replace('node-esm-', 'node-');
+    const language = templateName.split('-').pop();
+    return `node-${language}`;
+}
+function getPackageName(distFolder) {
+    const pkgPath = node_path.join(distFolder, 'package.json');
+    const pkgContent = JSON.parse(node_fs.readFileSync(pkgPath, 'utf-8'));
+    return pkgContent.name;
+}
+function replacePackageNamePlaceholder(distFolder, files, packageName) {
+    for (const file of files){
+        const filePath = node_path.join(distFolder, file);
+        if (node_fs.existsSync(filePath)) {
+            const content = node_fs.readFileSync(filePath, 'utf-8');
+            const replaced = content.replace(/\{\{ packageName \}\}/g, packageName);
+            node_fs.writeFileSync(filePath, replaced);
+        }
+    }
+}
 create({
     root: node_path.resolve(src_dirname, '..'),
     name: 'rslib',
-    templates: TEMPLATES.map(({ template, tools, lang })=>composeTemplateName({
-            template,
-            lang,
-            tools: Object.keys(tools || {})
-        })),
+    templates: TEMPLATES,
     getTemplateName: getTemplateName,
-    mapESLintTemplate: mapESLintTemplate
+    mapESLintTemplate: mapESLintTemplate,
+    extraTools: [
+        {
+            value: 'rspress',
+            label: 'Rspress - documentation',
+            when: (templateName)=>templateName.startsWith('react-ts'),
+            action: ({ templateName, distFolder, addAgentsMdSearchDirs })=>{
+                const toolFolder = node_path.join(src_dirname, '..', 'template-rspress');
+                const subFolder = node_path.join(toolFolder, templateName);
+                copyFolder({
+                    from: subFolder,
+                    to: distFolder,
+                    isMergePackageJson: true
+                });
+                const packageName = getPackageName(distFolder);
+                replacePackageNamePlaceholder(distFolder, [
+                    'docs/Button.mdx',
+                    'tsconfig.json'
+                ], packageName);
+                addAgentsMdSearchDirs(toolFolder);
+            }
+        },
+        {
+            value: 'storybook',
+            label: 'Storybook - component development',
+            when: (templateName)=>templateName.startsWith('react') || templateName.startsWith('vue'),
+            action: ({ templateName, distFolder, addAgentsMdSearchDirs })=>{
+                const toolFolder = node_path.join(src_dirname, '..', 'template-storybook');
+                const subFolder = node_path.join(toolFolder, templateName);
+                copyFolder({
+                    from: subFolder,
+                    to: distFolder,
+                    isMergePackageJson: true
+                });
+                addAgentsMdSearchDirs(toolFolder);
+            }
+        },
+        {
+            value: 'rstest',
+            label: 'Rstest - testing',
+            action: ({ templateName, distFolder, addAgentsMdSearchDirs })=>{
+                const rstestTemplate = mapTestingToolTemplate(templateName);
+                const toolFolder = node_path.join(src_dirname, '..', 'template-rstest');
+                const subFolder = node_path.join(toolFolder, rstestTemplate);
+                copyFolder({
+                    from: subFolder,
+                    to: distFolder,
+                    isMergePackageJson: true
+                });
+                addAgentsMdSearchDirs(toolFolder);
+            }
+        },
+        {
+            value: 'vitest',
+            label: 'Vitest - testing',
+            action: ({ templateName, distFolder, addAgentsMdSearchDirs })=>{
+                const vitestTemplate = mapTestingToolTemplate(templateName);
+                const toolFolder = node_path.join(src_dirname, '..', 'template-vitest');
+                const subFolder = node_path.join(toolFolder, vitestTemplate);
+                copyFolder({
+                    from: subFolder,
+                    to: distFolder,
+                    isMergePackageJson: true
+                });
+                addAgentsMdSearchDirs(toolFolder);
+            }
+        }
+    ]
 });
+export { TEMPLATES, parseTemplateName };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-rslib",
-  "version": "0.19.3",
+  "version": "0.19.4",
   "description": "Create a new Rslib project",
   "homepage": "https://rslib.rs",
   "repository": {
@@ -22,14 +22,14 @@
     "dist"
   ],
   "dependencies": {
-    "create-rstack": "1.7.20"
+    "create-rstack": "1.7.21"
   },
   "devDependencies": {
     "@types/fs-extra": "^11.0.4",
     "@types/node": "^24.10.9",
     "fs-extra": "^11.3.3",
-    "rsbuild-plugin-publint": "^0.3.3",
-    "rslib": "npm:@rslib/core@0.19.2",
+    "rsbuild-plugin-publint": "^0.3.4",
+    "rslib": "npm:@rslib/core@0.19.3",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "@rslib/tsconfig": "0.0.1"
@@ -44,7 +44,6 @@
   "scripts": {
     "build": "rslib build",
     "dev": "rslib build --watch",
-    "generate-templates": "pnpm tsx ./src/genTemplates.ts",
     "start": "node ./dist/index.js",
     "test": "rstest",
     "type-check": "tsc --noEmit"

package/{template-[react]-[]-js → template-react-js}/package.json

@@ -15,9 +15,9 @@
     "dev": "rslib build --watch"
   },
   "devDependencies": {
-    "@rsbuild/plugin-react": "^1.4.3",
+    "@rsbuild/plugin-react": "^1.4.4",
     "@rslib/core": "workspace:*",
-    "react": "^19.2.3"
+    "react": "^19.2.4"
   },
   "peerDependencies": {
     "react": ">=16.9.0",

package/{template-[react]-[]-ts → template-react-ts}/package.json

@@ -17,10 +17,10 @@
     "dev": "rslib build --watch"
   },
   "devDependencies": {
-    "@rsbuild/plugin-react": "^1.4.3",
+    "@rsbuild/plugin-react": "^1.4.4",
     "@rslib/core": "workspace:*",
-    "@types/react": "^19.2.8",
-    "react": "^19.2.3",
+    "@types/react": "^19.2.10",
+    "react": "^19.2.4",
     "typescript": "^5.9.3"
   },
   "peerDependencies": {

package/{template-[react]-[rstest]-ts → template-react-ts}/src/Button.tsx

@@ -1,10 +1,27 @@
 import './button.css';
 
-interface ButtonProps {
+export interface ButtonProps {
+  /**
+   * Whether the button is primary
+   * @default false
+   */
   primary?: boolean;
+  /**
+   * Background color of the button
+   */
   backgroundColor?: string;
+  /**
+   * Size of Button
+   * @default 'medium'
+   */
   size?: 'small' | 'medium' | 'large';
+  /**
+   * Label of the button
+   */
   label: string;
+  /**
+   * Optional click handler
+   */
   onClick?: () => void;
 }
 

package/template-rspress/AGENTS.md

@@ -0,0 +1,10 @@
+## Docs
+
+- Rspress: https://rspress.rs/llms.txt
+
+## Tools
+
+### Rspress
+
+- Run `{{ packageManager }} run doc` to start the Rspress documentation dev server, which will also start Rslib in watch mode
+- Run `{{ packageManager }} run doc:build` to build the documentation

package/template-rspress/react-ts/docs/Button.mdx

@@ -0,0 +1,31 @@
+# Button
+
+## Size
+
+Buttons can be small, medium and large in size.
+
+```jsx preview
+import React from 'react';
+import { Button } from '{{ packageName }}';
+
+export default () => {
+  return <Button size="medium" label="Click me"></Button>;
+};
+```
+
+## Background color
+
+The background color of the button can be set by yourself.
+
+```jsx preview
+import React from 'react';
+import { Button } from '{{ packageName }}';
+
+export default () => {
+  return <Button backgroundColor="red" label="Red"></Button>;
+};
+```
+
+## API
+
+<API moduleName="Button" en />

package/template-rspress/react-ts/docs/_meta.json

@@ -0,0 +1 @@
+["index", "Button"]

package/template-rspress/react-ts/docs/index.mdx

@@ -0,0 +1,4 @@
+---
+overview: true
+title: Overview
+---

package/template-rspress/react-ts/package.json

@@ -0,0 +1,15 @@
+{
+  "scripts": {
+    "doc": "rspress dev",
+    "doc:build": "rspress build",
+    "doc:preview": "rspress preview"
+  },
+  "devDependencies": {
+    "@rspress/core": "^2.0.0",
+    "@rspress/plugin-api-docgen": "^2.0.0",
+    "@rspress/plugin-preview": "^2.0.0",
+    "@types/node": "^24.10.9",
+    "react-dom": "^19.2.4",
+    "rsbuild-plugin-workspace-dev": "^0.1.3"
+  }
+}

package/template-rspress/react-ts/rspress.config.ts

@@ -0,0 +1,27 @@
+import * as path from 'node:path';
+import { defineConfig } from '@rspress/core';
+import { pluginApiDocgen } from '@rspress/plugin-api-docgen';
+import { pluginPreview } from '@rspress/plugin-preview';
+import { pluginWorkspaceDev } from 'rsbuild-plugin-workspace-dev';
+
+export default defineConfig({
+  root: path.join(__dirname, 'docs'),
+  title: 'Rslib Module Doc',
+  lang: 'en',
+  builderConfig: {
+    plugins: [
+      pluginWorkspaceDev({
+        startCurrent: true,
+      }),
+    ],
+  },
+  plugins: [
+    pluginApiDocgen({
+      entries: {
+        Button: './src/Button.tsx',
+      },
+      apiParseTool: 'react-docgen-typescript',
+    }),
+    pluginPreview(),
+  ],
+});

package/{template-[react]-[rstest,storybook]-ts → template-rspress/react-ts}/tsconfig.json

@@ -8,7 +8,10 @@
     "isolatedModules": true,
     "resolveJsonModule": true,
     "moduleResolution": "bundler",
-    "useDefineForClassFields": true
+    "useDefineForClassFields": true,
+    "paths": {
+      "{{ packageName }}": ["."]
+    }
   },
-  "include": ["src"]
+  "include": ["src", "docs", "rspress.config.ts"]
 }

package/template-rstest/AGENTS.md

@@ -0,0 +1,10 @@
+## Docs
+
+- Rstest: https://rstest.rs/llms.txt
+
+## Tools
+
+### Rstest
+
+- Run `{{ packageManager }} run test` to run tests
+- Run `{{ packageManager }} run test:watch` to run tests in watch mode

package/template-rstest/node-js/package.json

@@ -0,0 +1,10 @@
+{
+  "scripts": {
+    "test": "rstest",
+    "test:watch": "rstest --watch"
+  },
+  "devDependencies": {
+    "@rstest/adapter-rslib": "^0.2.0",
+    "@rstest/core": "^0.8.1"
+  }
+}

package/template-rstest/node-ts/package.json

@@ -0,0 +1,10 @@
+{
+  "scripts": {
+    "test": "rstest",
+    "test:watch": "rstest --watch"
+  },
+  "devDependencies": {
+    "@rstest/adapter-rslib": "^0.2.0",
+    "@rstest/core": "^0.8.1"
+  }
+}

package/template-rstest/react-js/package.json

@@ -0,0 +1,13 @@
+{
+  "scripts": {
+    "test": "rstest",
+    "test:watch": "rstest --watch"
+  },
+  "devDependencies": {
+    "@rstest/adapter-rslib": "^0.2.0",
+    "@rstest/core": "^0.8.1",
+    "@testing-library/jest-dom": "^6.9.1",
+    "@testing-library/react": "^16.3.2",
+    "happy-dom": "^20.4.0"
+  }
+}