@farris/cli 2.3.6 → 2.3.8

package/templates/web/.gitignore.tpl

@@ -1,32 +1,33 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-lerna-debug.log*
+# 依赖与产物
+node_modules/
+dist/
+dist-es/
+dist-ssr/
+coverage/
+*.tsbuildinfo
+.pnpm-store/
 
-node_modules
-package-lock.json
+# 日志与本地文件
+*.log
 .DS_Store
-dist
-dist-es
-dist-ssr
-coverage
 *.local
+.env
+.env.*
+!.env.example
+package-lock.json
 
-/cypress/videos/
-/cypress/screenshots/
-
-# Editor directories and files
+# 编辑器
 .vscode/*
 !.vscode/extensions.json
-.idea
-*.suo
-*.ntvs*
-*.njsproj
-*.sln
+!.vscode/settings.json
+.idea/
+.history
 *.sw?
 
-*.tsbuildinfo
+# AI 工具
+.codebuddy/
+.cursor/
+.claude/
+.windsurf/
+.trae/
+.opencode/

package/templates/web/farris.config.mjs

@@ -4,9 +4,9 @@ export default {
   // 相对路径 base：微前端（IBP）与 iframe 嵌入场景都适用
   base: './',
   routerMode: 'hash',
-  // iife: IBP 微前端单文件产物（默认）；如需普通 ESM 站点产物，执行 pnpm build:es
+  // 默认交付格式；pnpm build 会依次产出 es / umd / systemjs（iife 见 --format iife）
   format: "<%= format %>",
-  // 输出目录  App模式默认值 './dist' Lib模式 './lib'
+  // 输出目录  App/Lib 模式默认值均为 './dist'
   // outDir: fileURLToPath(new URL('./dist', import.meta.url)),
   // 最小化 默认值 true
   minify: true,

package/templates/web/mock/README.md

@@ -17,7 +17,14 @@ export default [
 ];
 ```
 
-规则：
+## 加一条 mock 并验证
+
+1. 先在 `src/api/` 里确认请求路径（例如 `/api/v1/users`），逐字抄进 `url`。
+2. 新建或追加 `mock/<领域>.mock.ts`，按上面的形状写 `url` / `method` / `response`。
+3. 在工程目录执行 `pnpm dev`，打开用到该接口的页面，**验证**返回的是 mock 数据。
+4. 需要联调真实后端时：`pnpm dev --no-mock`（或 `MOCK=none pnpm dev`），业务代码不改。
+
+## 规则
 
 - url 必须与代码中的请求路径逐字一致，见 `src/api/` 下的接口模块。
 - 路径参数在 url 里用 `:参数名` 表示，例如 `/api/v1/users/:id`；查询参数不写进 url，在 response 的 `query` 里读取。
@@ -25,10 +32,9 @@ export default [
 - 同一 url 不允许在多个 mock 文件中重复定义，重复时开发服务启动即报错。
 - mock 只用于开发期：不进构建产物，也不要在组件里散落假数据。
 
-行为：
+## 行为与开关
 
 - 命中 mock → 返回 mock 数据。
 - 未命中 → 按 `farris.config.mjs` 的 `proxy` 配置转发真实后端。
 - 未命中且未配代理的 `/api` 路径 → 返回 404 并提示，便于排查漏配。
-
-开关：在工程目录执行 `pnpm dev` 默认生效；`pnpm dev --no-mock` 或 `MOCK=none pnpm dev` 进入真实后端联调。
+- 开关：工程目录内 `pnpm dev` 默认生效；`pnpm dev --no-mock` 或 `MOCK=none pnpm dev` 进真实后端联调。

package/templates/web/package.json

@@ -5,8 +5,10 @@
   "type": "module",
   "scripts": {
     "dev": "farris-cli dev",
-    "build": "farris-cli build -ep",
-    "build:es": "farris-cli build --format es --outDir dist-es",
+    "build": "pnpm run build:es && pnpm run build:umd && pnpm run build:systemjs",
+    "build:es": "farris-cli build -ep --format es",
+    "build:umd": "farris-cli build -ep --format umd --outDir dist-umd",
+    "build:systemjs": "farris-cli build -ep --format systemjs --outDir dist-systemjs",
     "preview": "farris-cli preview",
     "test": "vitest run",
     "test:watch": "vitest",

package/templates/web/src/App.tsx

@@ -1,13 +1,9 @@
 import { defineComponent } from 'vue';
 import { RouterLink, RouterView } from 'vue-router';
-import { setupMicroAppContext } from './micro/context';
 
 export default defineComponent({
   name: 'App',
   setup() {
-    // 微前端环境：订阅主应用下发的上下文（语言 / 主题）
-    setupMicroAppContext();
-
     return () => (
       <>
         <header>

package/templates/web/src/locales/index.ts

@@ -1,5 +1,5 @@
-import zhCN from './zh-CN.json';
+import zhCHS from './zh-CHS.json';
 
 export const localResources = {
-    'zh-CN': zhCN
+    'zh-CHS': zhCHS
 };

package/templates/web/src/locales/zh-CHS.json

@@ -0,0 +1 @@
+{}

package/templates/web/src/main.ts

@@ -1,47 +1,12 @@
-import { createApp, type App as VueApp } from 'vue';
+import { createApp } from 'vue';
 import FarrisVue from '@farris/ui-vue';
 import '@farris/ui-vue/index.css';
 import App from './App';
 import router from './router';<%= styleImport %>
 import { localResources } from './locales';
 
-let app: VueApp | null = null;
+const app = createApp(App);
 
-/** 挂载应用（微前端宿主会调用 window.mount） */
-function mount(): void {
-  if (app) {
-    return;
-  }
-  app = createApp(App);
-  app.use(FarrisVue, { basePath: '', locale: 'zh-CN', localResources });
-  app.use(router);
-  app.mount('#app');
-
-  // 微前端环境：按平台下发的 initialPath 定位菜单配置的页面（fullPath）
-  // hash 路由必须保留这段兜底；history 路由下平台 defaultPage 已能直接命中，这里是幂等兜底
-  if (window.__MICRO_APP_ENVIRONMENT__) {
-    const rawPath = window.microApp?.getData?.()?.initialPath;
-    if (typeof rawPath === 'string' && rawPath !== '') {
-      // 平台下发的 initialPath 通常不带前导斜杠（如 'form'），这里统一归一化
-      const initialPath = rawPath.startsWith('/') ? rawPath : '/' + rawPath;
-      if (initialPath !== '/') {
-        router.isReady().then(() => router.replace(initialPath)).catch(() => undefined);
-      }
-    }
-  }
-}
-
-/** 卸载应用（微前端宿主会调用 window.unmount） */
-function unmount(): void {
-  app?.unmount();
-  app = null;
-}
-
-// 微前端（micro-app）生命周期契约：必须暴露到 window
-window.mount = mount;
-window.unmount = unmount;
-
-// 独立运行（浏览器直接访问 / iframe 嵌入）时自动挂载
-if (!window.__MICRO_APP_ENVIRONMENT__) {
-  mount();
-}
+app.use(FarrisVue, { basePath: '', locale: 'zh-CHS', localResources });
+app.use(router);
+app.mount('#app');

package/templates/web/src/views/HomeView.tsx

@@ -1,12 +1,12 @@
 import { defineComponent } from 'vue';
-import TheButton from '../components/TheButton';
 
 export default defineComponent({
   name: 'HomeView',
   setup() {
     return () => (
       <main>
-        <TheButton />
+        <h1>Home</h1>
+        <p>在 src/views/ 下新增页面；通用组件按需创建在 src/components/ 下。</p>
       </main>
     );
   }

package/templates/web/src/views/__tests__/AboutView.spec.tsx

@@ -0,0 +1,11 @@
+import { mount } from '@vue/test-utils';
+import { describe, expect, it } from 'vitest';
+import AboutView from '../AboutView';
+
+describe('AboutView', () => {
+  it('mounts', () => {
+    const wrapper = mount(AboutView);
+
+    expect(wrapper.exists()).toBe(true);
+  });
+});

package/templates/web/src/views/__tests__/HomeView.spec.tsx

@@ -0,0 +1,11 @@
+import { mount } from '@vue/test-utils';
+import { describe, expect, it } from 'vitest';
+import HomeView from '../HomeView';
+
+describe('HomeView', () => {
+  it('mounts', () => {
+    const wrapper = mount(HomeView);
+
+    expect(wrapper.exists()).toBe(true);
+  });
+});

package/templates/web/tsconfig.json

@@ -3,8 +3,7 @@
   "include": [
     "env.d.ts",
     "src/**/*",
-    "src/**/*.vue",
-    "test/**/*"
+    "src/**/*.vue"
   ],
   "compilerOptions": {
     "composite": true,

package/templates/web/vitest.config.ts

@@ -1,10 +1,12 @@
 import vue from '@vitejs/plugin-vue';
-import { defineConfig } from 'vitest/config';
+import { configDefaults, defineConfig } from 'vitest/config';
 
 export default defineConfig({
   plugins: [vue()],
   test: {
     environment: 'jsdom',
-    include: ['test/**/*.spec.{ts,tsx}']
+    // 官方默认收集范围（**/*.{test,spec}.*），源码旁的测试才会被收集
+    include: [...configDefaults.include],
+    exclude: [...configDefaults.exclude, '**/__sandbox_*/**']
   }
 });

package/templates/mobile/src/components/TheButton.tsx

@@ -1,9 +0,0 @@
-import { defineComponent } from 'vue';
-import { Button } from '@farris/mobile-ui-vue';
-
-export default defineComponent({
-  name: 'TheButton',
-  setup() {
-    return () => <Button>按钮</Button>;
-  }
-});

package/templates/mobile/test/src/components/TheButton.spec.ts

@@ -1,15 +0,0 @@
-import { mount } from '@vue/test-utils';
-import { describe, expect, it } from 'vitest';
-import TheButton from '../../../src/components/TheButton';
-
-describe('TheButton', () => {
-  it('mounts and renders its default slot', () => {
-    const wrapper = mount(TheButton, {
-      global: {
-        stubs: { FmButton: { template: '<button><slot /></button>' } }
-      }
-    });
-
-    expect(wrapper.text()).toContain('按钮');
-  });
-});

package/templates/mobile/test/src/components/TheButton.spec.tsx

@@ -1,15 +0,0 @@
-import { mount } from '@vue/test-utils';
-import { describe, expect, it } from 'vitest';
-import TheButton from '../../../src/components/TheButton';
-
-describe('TheButton (tsx collection)', () => {
-  it('is collected by the unified vitest include', () => {
-    const wrapper = mount(TheButton, {
-      global: {
-        stubs: { FmButton: { template: '<button><slot /></button>' } }
-      }
-    });
-
-    expect(wrapper.text()).toContain('按钮');
-  });
-});

package/templates/web/src/components/TheButton.tsx

@@ -1,9 +0,0 @@
-import { defineComponent } from 'vue';
-import { FButton } from '@farris/ui-vue';
-
-export default defineComponent({
-  name: 'TheButton',
-  setup() {
-    return () => <FButton>按钮</FButton>;
-  }
-});

package/templates/web/src/micro-app.d.ts

@@ -1,20 +0,0 @@
-export {};
-
-declare global {
-  interface Window {
-    /** micro-app 子应用环境标记（由宿主注入） */
-    __MICRO_APP_ENVIRONMENT__?: boolean;
-    /** 宿主注入的 micro-app API */
-    microApp?: {
-      addGlobalDataListener?: (callback: (data: any) => void, immediately?: boolean) => void;
-      setGlobalData?: (data: Record<string, any>) => void;
-      getData?: () => Record<string, any> | null;
-      router?: {
-        getBaseAppRouter?: () => any;
-      };
-    };
-    /** 微前端生命周期：宿主会调用这两个方法 */
-    mount?: () => void;
-    unmount?: () => void;
-  }
-}

package/templates/web/test/src/components/TheButton.spec.ts

@@ -1,15 +0,0 @@
-import { mount } from '@vue/test-utils';
-import { describe, expect, it } from 'vitest';
-import TheButton from '../../../src/components/TheButton';
-
-describe('TheButton', () => {
-  it('mounts and renders its default slot', () => {
-    const wrapper = mount(TheButton, {
-      global: {
-        stubs: { FButton: { template: '<button><slot /></button>' } }
-      }
-    });
-
-    expect(wrapper.text()).toContain('按钮');
-  });
-});

package/templates/web/test/src/components/TheButton.spec.tsx

@@ -1,15 +0,0 @@
-import { mount } from '@vue/test-utils';
-import { describe, expect, it } from 'vitest';
-import TheButton from '../../../src/components/TheButton';
-
-describe('TheButton (tsx collection)', () => {
-  it('is collected by the unified vitest include', () => {
-    const wrapper = mount(TheButton, {
-      global: {
-        stubs: { FButton: { template: '<button><slot /></button>' } }
-      }
-    });
-
-    expect(wrapper.text()).toContain('按钮');
-  });
-});