@farris/cli 2.2.6 → 2.3.0

package/templates/lib/package.json

@@ -3,11 +3,37 @@
   "version": "1.0.0",
   "private": false,
   "type": "module",
+  "license": "Apache-2.0",
+  "description": "<%= name %>，基于 Farris Vue 的 Vue3 组件库。",
+  "keywords": [
+    "farris",
+    "vue3",
+    "components"
+  ],
+  "homepage": "https://farris-design.gitee.io/farris-vue/",
+  "repository": {
+    "type": "git",
+    "url": "git@gitee.com:ubml/farris-vue.git"
+  },
+  "files": [
+    "lib"
+  ],
+  "sideEffects": [
+    "**/*.css",
+    "**/*.scss"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
   "scripts": {
     "dev": "farris-cli dev",
     "build": "farris-cli build-lib -ep && farris-cli build-components",
+    "preview": "farris-cli preview",
     "test": "vitest run",
     "test:watch": "vitest",
+    "typecheck": "vue-tsc --noEmit",
+    "lint": "eslint . --ext .vue,.ts,.tsx --fix",
+    "format": "prettier --write components/ src/",
     "changeset": "changeset",
     "version": "changeset version"
   },
@@ -17,12 +43,21 @@
   "devDependencies": {
     "@changesets/cli": "^2.29.5",
     "@farris/cli": "<%= cliVersion %>",
-    "@vue/tsconfig": "^0.5.1",
-    "@vue/test-utils": "^2.4.6",
+    "@rushstack/eslint-patch": "^1.8.0",
     "@vitejs/plugin-vue": "^5.2.4",
+    "@vue/eslint-config-prettier": "^9.0.0",
+    "@vue/eslint-config-typescript": "^13.0.0",
+    "@vue/test-utils": "^2.4.6",
+    "@vue/tsconfig": "^0.5.1",
+    "eslint": "^8.57.0",
+    "eslint-plugin-vue": "^9.23.0",
     "jsdom": "^25.0.1",
+    "prettier": "^3.2.5",
+    "sass": "^1.90.0",
     "typescript": "~5.4.0",
+    "vite": "^5.4.19",
+    "vitest": "^3.2.4",
     "vue": "^3.4.29",
-    "vitest": "^3.2.4"
+    "vue-tsc": "^2.2.0"
   }
 }

package/templates/lib/{components → test/components}/button/button.spec.ts

@@ -1,10 +1,11 @@
 import { mount } from '@vue/test-utils';
 import { describe, expect, it } from 'vitest';
-import { Button } from './index';
+import { Button } from '../../../../components/button/index';
 
 describe('Button', () => {
-  it('renders a button', () => {
+  it('renders its default slot', () => {
     const wrapper = mount(Button, { slots: { default: 'OK' } });
+
     expect(wrapper.text()).toContain('OK');
   });
 });

package/templates/lib/test/components/button/button.spec.tsx

@@ -0,0 +1,11 @@
+import { mount } from '@vue/test-utils';
+import { describe, expect, it } from 'vitest';
+import { Button } from '../../../../components/button/index';
+
+describe('Button (tsx collection)', () => {
+  it('is collected by the unified vitest include', () => {
+    const wrapper = mount(Button, { slots: { default: 'OK' } });
+
+    expect(wrapper.text()).toContain('OK');
+  });
+});

package/templates/lib/tsconfig.json

@@ -1,6 +1,10 @@
 {
   "extends": "@vue/tsconfig/tsconfig.dom.json",
-  "include": ["components/**/*"],
+  "include": [
+    "components/**/*",
+    "src/**/*",
+    "test/**/*"
+  ],
   "compilerOptions": {
     "strict": true
   }

package/templates/lib/vitest.config.ts

@@ -5,6 +5,6 @@ export default defineConfig({
   plugins: [vue()],
   test: {
     environment: 'jsdom',
-    include: ['components/**/*.spec.ts']
+    include: ['test/**/*.spec.{ts,tsx}']
   }
 });

package/templates/mobile/.gitignore.tpl

@@ -0,0 +1,31 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+package-lock.json
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.tsbuildinfo

package/templates/mobile/.gitlab-ci.yml

@@ -39,11 +39,8 @@ publish-project:
   stage: publishproject
   tags:
     - environment:cloud
-  only:
-    refs:
-      - cicd
-    changes:
-      - project.json
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v\d/
   before_script:
     - |
       if [ -z "${ARTIFACTS_REPO_USERNAME}" ] || [ -z "${ARTIFACTS_REPO_PASSWORD}" ]; then
@@ -59,7 +56,4 @@ publish-project:
     - npm config fix
   script:
     - npm config set //repos.iec.io/repository/npm-igix-release/:_auth=$(echo -n ${ARTIFACTS_REPO_USERNAME}:${ARTIFACTS_REPO_PASSWORD} | base64)
-    - cp ./project.json ./dist
-    - cd ./dist
-    - mv ./project.json ./package.json
-    - npm publish
+    - cd dist && npm publish

package/templates/mobile/index.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Vite App</title>
+    <title><%= title %></title>
   </head>
   <body>
     <div id="app"></div>

package/templates/mobile/package.json

@@ -1,18 +1,18 @@
 {
   "name": "<%= name %>",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "private": true,
   "type": "module",
   "scripts": {
     "dev": "farris-cli dev",
-    "build": "farris-cli build",
+    "build": "farris-cli build -ep",
     "preview": "farris-cli preview",
-    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
-    "format": "prettier --write src/",
     "test": "vitest run",
     "test:watch": "vitest",
-    "changeset": "changeset",
-    "version": "changeset version"
+    "typecheck": "vue-tsc --noEmit",
+    "lint": "eslint . --ext .vue,.ts,.tsx --fix",
+    "format": "prettier --write src/",
+    "i18n": "farris-cli extract-i18n"
   },
   "dependencies": {
     "@farris/mobile-ui-vue": "latest",
@@ -20,17 +20,21 @@
     "vue-router": "^4.3.0"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.29.5",
     "@farris/cli": "<%= cliVersion %>",
     "@rushstack/eslint-patch": "^1.8.0",
+    "@vitejs/plugin-vue": "^5.2.4",
     "@vue/eslint-config-prettier": "^9.0.0",
     "@vue/eslint-config-typescript": "^13.0.0",
+    "@vue/test-utils": "^2.4.6",
     "@vue/tsconfig": "^0.5.1",
-    "@vitejs/plugin-vue": "^5.2.4",
     "eslint": "^8.57.0",
     "eslint-plugin-vue": "^9.23.0",
+    "jsdom": "^25.0.1",
     "prettier": "^3.2.5",
     "typescript": "~5.4.0",
-    "vitest": "^3.2.4"
+    "vite": "^5.4.19",
+    "vitest": "^3.2.4",
+    "vue-tsc": "^2.2.0",
+    "sass": "^1.90.0"
   }
-}
+}

package/templates/mobile/src/main.ts

@@ -1,12 +1,13 @@
 import { createApp } from 'vue';
 import FarrisVue from '@farris/mobile-ui-vue';
-import App from './App.vue';
-import router from './router';
-
 import '@farris/mobile-ui-vue/style.css';
+import App from './App.vue';
+import router from './router';<%= styleImport %>
+import { localResources } from './locales';
 
 const app = createApp(App);
 
-app.use(router).use(FarrisVue);
+app.use(FarrisVue, { basePath: '', locale: 'zh-CN', localResources });
+app.use(router);
 
 app.mount('#app');

package/templates/mobile/src/router/index.ts

@@ -1,23 +1,23 @@
-import { createRouter, createWebHistory } from 'vue-router';
-import HomeView from '../views/HomeView.vue';
+import { createRouter, createWebHistory, type RouteRecordRaw } from 'vue-router';
+
+// 生成器（farris-cli generate view --with-route）依赖下面的 routes 数组赋值形式；
+// 改动结构会导致路由无法自动注册。
+export const routes: RouteRecordRaw[] = [
+  {
+    path: '/',
+    name: 'Home',
+    component: () => import('../views/HomeView.vue')
+  },
+  {
+    path: '/about',
+    name: 'About',
+    component: () => import('../views/AboutView.vue')
+  }
+];
 
 const router = createRouter({
   history: createWebHistory(import.meta.env.BASE_URL),
-  routes: [
-    {
-      path: '/',
-      name: 'home',
-      component: HomeView
-    },
-    {
-      path: '/about',
-      name: 'about',
-      // route level code-splitting
-      // this generates a separate chunk (About.[hash].js) for this route
-      // which is lazy-loaded when the route is visited.
-      component: () => import('../views/AboutView.vue')
-    }
-  ]
+  routes
 });
 
 export default router;

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

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

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

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

package/templates/mobile/tsconfig.json

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

package/templates/mobile/vitest.config.ts

@@ -4,6 +4,7 @@ import { defineConfig } from 'vitest/config';
 export default defineConfig({
   plugins: [vue()],
   test: {
-    include: ['src/**/*.spec.ts']
+    environment: 'jsdom',
+    include: ['test/**/*.spec.{ts,tsx}']
   }
 });

package/templates/web/.gitignore.tpl

@@ -0,0 +1,31 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+lerna-debug.log*
+
+node_modules
+package-lock.json
+.DS_Store
+dist
+dist-ssr
+coverage
+*.local
+
+/cypress/videos/
+/cypress/screenshots/
+
+# Editor directories and files
+.vscode/*
+!.vscode/extensions.json
+.idea
+*.suo
+*.ntvs*
+*.njsproj
+*.sln
+*.sw?
+
+*.tsbuildinfo

package/templates/web/.gitlab-ci.yml

@@ -39,11 +39,8 @@ publish-project:
   stage: publishproject
   tags:
     - environment:cloud
-  only:
-    refs:
-      - cicd
-    changes:
-      - project.json
+  rules:
+    - if: $CI_COMMIT_TAG =~ /^v\d/
   before_script:
     - |
       if [ -z "${ARTIFACTS_REPO_USERNAME}" ] || [ -z "${ARTIFACTS_REPO_PASSWORD}" ]; then
@@ -59,7 +56,4 @@ publish-project:
     - npm config fix
   script:
     - npm config set //repos.iec.io/repository/npm-igix-release/:_auth=$(echo -n ${ARTIFACTS_REPO_USERNAME}:${ARTIFACTS_REPO_PASSWORD} | base64)
-    - cp ./project.json ./dist
-    - cd ./dist
-    - mv ./project.json ./package.json
-    - npm publish
+    - cd dist && npm publish

package/templates/web/index.html

@@ -3,7 +3,7 @@
   <head>
     <meta charset="UTF-8">
     <meta name="viewport" content="width=device-width, initial-scale=1.0">
-    <title>Vite App</title>
+    <title><%= title %></title>
   </head>
   <body>
     <div id="app"></div>

package/templates/web/package.json

@@ -1,18 +1,18 @@
 {
   "name": "<%= name %>",
-  "version": "1.0.0",
+  "version": "0.1.0",
   "private": true,
   "type": "module",
   "scripts": {
     "dev": "farris-cli dev",
-    "build": "farris-cli build",
+    "build": "farris-cli build -ep",
     "preview": "farris-cli preview",
-    "lint": "eslint . --ext .vue,.js,.jsx,.cjs,.mjs,.ts,.tsx,.cts,.mts --fix --ignore-path .gitignore",
-    "format": "prettier --write src/",
     "test": "vitest run",
     "test:watch": "vitest",
-    "changeset": "changeset",
-    "version": "changeset version"
+    "typecheck": "vue-tsc --noEmit",
+    "lint": "eslint . --ext .vue,.ts,.tsx --fix",
+    "format": "prettier --write src/",
+    "i18n": "farris-cli extract-i18n"
   },
   "dependencies": {
     "@farris/ui-vue": "latest",
@@ -20,17 +20,21 @@
     "vue-router": "^4.3.0"
   },
   "devDependencies": {
-    "@changesets/cli": "^2.29.5",
     "@farris/cli": "<%= cliVersion %>",
     "@rushstack/eslint-patch": "^1.8.0",
+    "@vitejs/plugin-vue": "^5.2.4",
     "@vue/eslint-config-prettier": "^9.0.0",
     "@vue/eslint-config-typescript": "^13.0.0",
+    "@vue/test-utils": "^2.4.6",
     "@vue/tsconfig": "^0.5.1",
-    "@vitejs/plugin-vue": "^5.2.4",
     "eslint": "^8.57.0",
     "eslint-plugin-vue": "^9.23.0",
+    "jsdom": "^25.0.1",
     "prettier": "^3.2.5",
     "typescript": "~5.4.0",
-    "vitest": "^3.2.4"
+    "vite": "^5.4.19",
+    "vitest": "^3.2.4",
+    "vue-tsc": "^2.2.0",
+    "sass": "^1.90.0"
   }
-}
+}

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

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

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

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

package/templates/web/src/main.ts

@@ -1,10 +1,13 @@
 import { createApp } from 'vue';
 import FarrisVue from '@farris/ui-vue';
+import '@farris/ui-vue/index.css';
 import App from './App.vue';
-import router from './router';
+import router from './router';<%= styleImport %>
+import { localResources } from './locales';
 
 const app = createApp(App);
 
-app.use(router).use(FarrisVue);
+app.use(FarrisVue, { basePath: '', locale: 'zh-CN', localResources });
+app.use(router);
 
 app.mount('#app');

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

@@ -1,23 +1,23 @@
-import { createRouter, createWebHistory } from 'vue-router';
-import HomeView from '../views/HomeView.vue';
+import { createRouter, createWebHistory, type RouteRecordRaw } from 'vue-router';
+
+// 生成器（farris-cli generate view --with-route）依赖下面的 routes 数组赋值形式；
+// 改动结构会导致路由无法自动注册。
+export const routes: RouteRecordRaw[] = [
+  {
+    path: '/',
+    name: 'Home',
+    component: () => import('../views/HomeView.vue')
+  },
+  {
+    path: '/about',
+    name: 'About',
+    component: () => import('../views/AboutView.vue')
+  }
+];
 
 const router = createRouter({
   history: createWebHistory(import.meta.env.BASE_URL),
-  routes: [
-    {
-      path: '/',
-      name: 'home',
-      component: HomeView
-    },
-    {
-      path: '/about',
-      name: 'about',
-      // route level code-splitting
-      // this generates a separate chunk (About.[hash].js) for this route
-      // which is lazy-loaded when the route is visited.
-      component: () => import('../views/AboutView.vue')
-    }
-  ]
+  routes
 });
 
 export default router;

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

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

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

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

package/templates/web/tsconfig.json

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

package/templates/web/vitest.config.ts

@@ -4,6 +4,7 @@ import { defineConfig } from 'vitest/config';
 export default defineConfig({
   plugins: [vue()],
   test: {
-    include: ['src/**/*.spec.ts']
+    environment: 'jsdom',
+    include: ['test/**/*.spec.{ts,tsx}']
   }
 });

package/lib/common/project-package-name.js

@@ -1,5 +0,0 @@
-export function toProjectPackageName(name) {
-    const unscoped = name.replace(/^@[^/]+\//, '');
-    return `@farris/project-${unscoped}`;
-}
-//# sourceMappingURL=project-package-name.js.map

package/lib/common/project-package-name.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"project-package-name.js","sourceRoot":"","sources":["../../src/common/project-package-name.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,oBAAoB,CAAC,IAAY;IAC/C,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC;IAC/C,OAAO,mBAAmB,QAAQ,EAAE,CAAC;AACvC,CAAC"}

package/templates/mobile/.changeset/README.md

@@ -1,4 +0,0 @@
-Use `npm run changeset` then `npm run version` to write CHANGELOG.md.
-
-This app template is `private` and is not meant for `npm publish`.
-If the default branch is not `main`, edit `baseBranch` in `config.json`.

package/templates/mobile/.changeset/config.json

@@ -1,11 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.0.2/schema.json",
-  "changelog": "@changesets/cli/changelog",
-  "commit": false,
-  "fixed": [],
-  "linked": [],
-  "access": "restricted",
-  "baseBranch": "main",
-  "updateInternalDependencies": "patch",
-  "ignore": []
-}

package/templates/mobile/project.json

@@ -1,4 +0,0 @@
-{
-  "name": "<%= projectPackageName %>",
-  "version": "1.0.0"
-}

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

@@ -1,8 +0,0 @@
-import { describe, expect, it } from 'vitest';
-import TheButton from './TheButton.vue';
-
-describe('TheButton', () => {
-  it('exports a component', () => {
-    expect(TheButton).toBeTruthy();
-  });
-});

package/templates/web/.changeset/README.md

@@ -1,4 +0,0 @@
-Use `npm run changeset` then `npm run version` to write CHANGELOG.md.
-
-This app template is `private` and is not meant for `npm publish`.
-If the default branch is not `main`, edit `baseBranch` in `config.json`.