@farris/cli 2.2.0-beta.1 → 2.2.0

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

@@ -0,0 +1,88 @@
+image: registry.inspures.com/public/docker.io/library/node:22
+
+variables:
+  PROJECT_ROOT: "."
+  NPM_REGISTRY: "https://repos.iec.io/repository/npm-igix/"
+  NPM_RELEASE_REGISTRY: "https://repos.iec.io/repository/npm-igix-release/"
+
+stages:
+  - pre
+  - build
+  - publish
+  - publishproject
+
+pre-job:
+  stage: pre
+  tags:
+    - environment:cloud
+  script:
+    - export commit_author=$(git log -1 --pretty=format:%an)
+    - export commit_email=$(git log -1 --pretty=format:%ce)
+
+build-job:
+  stage: build
+  tags:
+    - environment:cloud
+  before_script:
+    - |
+      if [ -z "${ARTIFACTS_REPO_USERNAME}" ] || [ -z "${ARTIFACTS_REPO_PASSWORD}" ]; then
+        echo "ARTIFACTS_REPO_USERNAME or ARTIFACTS_REPO_PASSWORD is empty on ${CI_COMMIT_REF_NAME}."
+        echo "If these GitLab CI/CD variables are Protected, they are not available on unprotected branches."
+        exit 1
+      fi
+    - if [ ! -f .npmrc ]; then wget -O - https://repos.iec.io/gitlab-ci/template/experimental/script/npmrc | sh; fi
+    - echo _auth=$(echo -n ${ARTIFACTS_REPO_USERNAME}:${ARTIFACTS_REPO_PASSWORD} | base64) >> .npmrc
+    - echo always-auth=true >> .npmrc
+    - sed -i "s#registry=.*#registry=$NPM_REGISTRY#g" $CI_PROJECT_DIR/.npmrc
+    - cp .npmrc ~/
+    - npm config fix
+  script:
+    - npm i --no-package-lock
+    - npm test
+    - npm run build
+  artifacts:
+    expire_in: '5days'
+    name: 'dist'
+    paths:
+      - $CI_PROJECT_DIR/dist
+
+publish-one:
+  stage: publish
+  tags:
+    - environment:cloud
+  only:
+    refs:
+      - cicd
+    changes:
+      - packages/**/package.json
+  script:
+    - echo "skip publish-one, app package is private"
+
+publish-project:
+  stage: publishproject
+  tags:
+    - environment:cloud
+  only:
+    refs:
+      - cicd
+    changes:
+      - project.json
+  before_script:
+    - |
+      if [ -z "${ARTIFACTS_REPO_USERNAME}" ] || [ -z "${ARTIFACTS_REPO_PASSWORD}" ]; then
+        echo "ARTIFACTS_REPO_USERNAME or ARTIFACTS_REPO_PASSWORD is empty on ${CI_COMMIT_REF_NAME}."
+        echo "If these GitLab CI/CD variables are Protected, they are not available on unprotected branches."
+        exit 1
+      fi
+    - if [ ! -f .npmrc ]; then wget -O - https://repos.iec.io/gitlab-ci/template/experimental/script/npmrc | sh; fi
+    - echo _auth=$(echo -n ${ARTIFACTS_REPO_USERNAME}:${ARTIFACTS_REPO_PASSWORD} | base64) >> .npmrc
+    - echo always-auth=true >> .npmrc
+    - sed -i "s#registry=.*#registry=$NPM_RELEASE_REGISTRY#g" $CI_PROJECT_DIR/.npmrc
+    - cp .npmrc ~/
+    - 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

package/templates/web/package.json

@@ -9,6 +9,8 @@
     "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"
   },
@@ -24,9 +26,11 @@
     "@vue/eslint-config-prettier": "^9.0.0",
     "@vue/eslint-config-typescript": "^13.0.0",
     "@vue/tsconfig": "^0.5.1",
+    "@vitejs/plugin-vue": "^4.0.0",
     "eslint": "^8.57.0",
     "eslint-plugin-vue": "^9.23.0",
     "prettier": "^3.2.5",
-    "typescript": "~5.4.0"
+    "typescript": "~5.4.0",
+    "vitest": "^1.6.1"
   }
 }

package/templates/web/project.json

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

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

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

package/templates/web/vitest.config.ts

@@ -0,0 +1,9 @@
+import vue from '@vitejs/plugin-vue';
+import { defineConfig } from 'vitest/config';
+
+export default defineConfig({
+  plugins: [vue()],
+  test: {
+    include: ['src/**/*.spec.ts']
+  }
+});

package/templates/workspace/app/farris.config.mjs

@@ -0,0 +1,13 @@
+import { fileURLToPath, URL } from 'node:url';
+
+export default {
+  base: '<%= base %>',
+  routerMode: '<%= routerMode %>',
+  format: '<%= format %>',
+  minify: true,
+  externalDependencies: false,
+  alias: [
+    { find: '@', replacement: fileURLToPath(new URL('./src', import.meta.url)) }
+  ],
+  viteConfig: {}
+};

package/templates/workspace/app/index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html lang="zh-CN">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title><%= title %></title>
+  </head>
+  <body>
+    <div id="app"></div>
+    <script type="module" src="/src/main.ts"></script>
+  </body>
+</html>

package/templates/workspace/app/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "<%= appName %>",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "farris-cli dev",
+    "build": "farris-cli build",
+    "preview": "farris-cli preview",
+    "typecheck": "vue-tsc --noEmit"
+  },
+  "dependencies": {
+    "@farris/ui-vue": "catalog:",
+    "vue": "catalog:"<%= routerDependency %>
+  },
+  "devDependencies": {
+    "@farris/cli": "catalog:",
+    "typescript": "catalog:",
+    "vite": "catalog:",
+    "vue-tsc": "catalog:"<%= sassDevDependency %>
+  }
+}

package/templates/workspace/app/src/App.tsx

@@ -0,0 +1,11 @@
+import { defineComponent } from 'vue';<%= appRouterImport %>
+
+export default defineComponent({
+    name: 'App',
+    setup() {
+        return () => (
+<%= appTemplateBody %>
+        );
+    }
+});
+

package/templates/workspace/app/src/locales/index.ts

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

package/templates/workspace/app/src/locales/zh-CN.json

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

package/templates/workspace/app/src/main.ts

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

package/templates/workspace/app/src/router/index.ts

@@ -0,0 +1,16 @@
+import { createRouter, <%= routerHistoryFunction %>, type RouteRecordRaw } from 'vue-router';
+
+export const routes: RouteRecordRaw[] = [
+  {
+    path: '/',
+    name: 'Home',
+    component: () => import('../views/home')
+  },
+];
+
+const router = createRouter({
+  history: <%= routerHistoryCall %>,
+  routes
+});
+
+export default router;

package/templates/workspace/app/src/views/home/composables/use-home.ts

@@ -0,0 +1,7 @@
+export function useHome() {
+  const title = '<%= title %>';
+
+  return {
+    title
+  };
+}

package/templates/workspace/app/src/views/home/home.component.tsx

@@ -0,0 +1,15 @@
+import { defineComponent } from 'vue';
+import { useHome } from './composables/use-home';
+
+export default defineComponent({
+  name: 'HomeView',
+  setup() {
+    const { title } = useHome();
+
+    return () => (
+      <div class="f-page-home">
+        <h2>{title}</h2>
+      </div>
+    );
+  }
+});

package/templates/workspace/app/src/views/home/index.ts

@@ -0,0 +1,4 @@
+import HomeComponent from './home.component';
+
+export { HomeComponent };
+export default HomeComponent;

package/templates/workspace/app/tsconfig.json

@@ -0,0 +1,21 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "useDefineForClassFields": true,
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "strict": true,
+    "jsx": "preserve",
+    "jsxImportSource": "vue",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "lib": ["ESNext", "DOM"],
+    "skipLibCheck": true,
+    "types": ["vite/client"],
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.tsx", "src/**/*.vue"]
+}

package/templates/workspace/root/README.md

@@ -0,0 +1,28 @@
+# <%= title %>
+
+基于 Farris Vue 的前端工程 Workspace。
+
+## 目录结构
+
+```text
+├── packages/
+│   └── <%= appDir %>/          # 应用源码
+├── pnpm-workspace.yaml  # pnpm workspace 配置及 Catalog 依赖版本
+└── package.json         # 根工程脚本
+```
+
+## 快速上手
+
+```bash
+# 安装依赖
+pnpm install
+
+# 启动开发服务器
+pnpm --filter "<%= appName %>" dev
+
+# 执行全量类型检查
+pnpm typecheck
+
+# 构建生产产物
+pnpm build
+```

package/templates/workspace/root/package.json

@@ -0,0 +1,13 @@
+{
+  "private": true,
+  "packageManager": "pnpm@<%= pnpmVersion %>",
+  "engines": {
+    "node": "^18.0.0 || >=20.0.0",
+    "pnpm": ">=9.0.0 <10.0.0"
+  },
+  "scripts": {
+    "build": "pnpm --recursive --if-present run build",
+    "dev": "pnpm --recursive --if-present run dev",
+    "typecheck": "pnpm --recursive --if-present run typecheck"
+  }
+}

package/templates/workspace/root/pnpm-workspace.yaml

@@ -0,0 +1,12 @@
+packages:
+  - "packages/*"
+
+catalog:
+  "@farris/ui-vue": "<%= farrisUiVueVersion %>"
+  "@farris/cli": "<%= farrisCliVersion %>"
+  "typescript": "<%= typescriptVersion %>"
+  "vite": "<%= viteVersion %>"
+  "vue": "<%= vueVersion %>"
+  "vue-router": "<%= vueRouterVersion %>"
+  "vue-tsc": "<%= vueTscVersion %>"
+  "sass": "<%= sassVersion %>"