create-swdg-frontend 0.1.6 → 0.2.0

package/lib/scaffold.js

@@ -0,0 +1,118 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { spawn } from 'node:child_process';
+import { TEMPLATE_DIR } from './constants.js';
+import { applyGisIntegration, removeGisIntegration } from './gis.js';
+import { writeProjectManifest } from './manifest.js';
+
+export async function pathExists(p) {
+  try {
+    await fs.access(p);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function isDirEmpty(p) {
+  try {
+    return (await fs.readdir(p)).length === 0;
+  } catch {
+    return true;
+  }
+}
+
+export async function copyTemplate(destDir, { forceEmpty = false } = {}) {
+  if (await pathExists(destDir)) {
+    const empty = await isDirEmpty(destDir);
+    if (!empty && !forceEmpty) {
+      throw new Error('TARGET_NOT_EMPTY');
+    }
+    await fs.rm(destDir, { recursive: true, force: true });
+  }
+  await fs.mkdir(destDir, { recursive: true });
+  await fs.cp(TEMPLATE_DIR, destDir, { recursive: true });
+}
+
+export async function updatePackageName(destDir, name) {
+  const pkgPath = path.join(destDir, 'package.json');
+  const pkg = JSON.parse(await fs.readFile(pkgPath, 'utf8'));
+  pkg.name = name;
+  await fs.writeFile(pkgPath, JSON.stringify(pkg, null, 2) + '\n', 'utf8');
+}
+
+export async function updateIndexTitle(destDir, title) {
+  const indexPath = path.join(destDir, 'index.html');
+  try {
+    const html = await fs.readFile(indexPath, 'utf8');
+    const next = html.replace(
+      /<title>.*?<\/title>/i,
+      `<title>${title}</title>`
+    );
+    await fs.writeFile(indexPath, next, 'utf8');
+  } catch {
+    // ignore
+  }
+}
+
+export async function runInstall(destDir, pm) {
+  const child = spawn(pm, ['install'], { cwd: destDir, stdio: 'inherit' });
+  await new Promise((resolve, reject) => {
+    child.on('exit', (code) => {
+      if (code === 0) resolve();
+      else reject(new Error(`${pm} install failed with code ${code}`));
+    });
+  });
+}
+
+export async function initGit(destDir) {
+  const child = spawn('git', ['init'], { cwd: destDir, stdio: 'inherit' });
+  await new Promise((resolve, reject) => {
+    child.on('exit', (code) => {
+      if (code === 0) resolve();
+      else reject(new Error(`git init failed with code ${code}`));
+    });
+  });
+}
+
+export async function verifyProject(destDir, pm) {
+  const child = spawn(pm, ['run', 'typecheck'], {
+    cwd: destDir,
+    stdio: 'inherit',
+  });
+  await new Promise((resolve, reject) => {
+    child.on('exit', (code) => {
+      if (code === 0) resolve();
+      else reject(new Error('Post-scaffold typecheck failed'));
+    });
+  });
+}
+
+export async function applyFeatures(destDir, { gis }) {
+  if (gis) {
+    await applyGisIntegration(destDir);
+  } else {
+    await removeGisIntegration(destDir);
+  }
+}
+
+export async function finalizeProject(destDir, context) {
+  await writeProjectManifest(destDir, {
+    features: { gis: context.gis },
+    packageManager: context.pm,
+  });
+}
+
+/** 供 CLI 与集成测试复用的创建流程（不含 install / git / verify） */
+export async function createProject(
+  destDir,
+  { projectName, gis, pm = 'pnpm' }
+) {
+  await copyTemplate(destDir);
+  await updatePackageName(destDir, projectName);
+  await updateIndexTitle(destDir, projectName);
+  await applyFeatures(destDir, { gis });
+  await finalizeProject(destDir, { gis, pm });
+}
+
+export { TEMPLATE_DIR };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "create-swdg-frontend",
-  "version": "0.1.6",
+  "version": "0.2.0",
   "description": "Scaffold a new SWDG frontend project",
   "type": "module",
   "bin": {
@@ -8,11 +8,15 @@
   },
   "files": [
     "bin",
+    "lib",
+    "stubs",
+    "scripts",
     "template"
   ],
   "scripts": {
     "sync-template": "node scripts/sync-template.js",
-    "prepublishOnly": "node scripts/sync-template.js"
+    "validate-template": "node scripts/validate-template.mjs",
+    "prepublishOnly": "node scripts/sync-template.js && node scripts/validate-template.mjs"
   },
   "engines": {
     "node": ">=18"

package/scripts/sync-template.js

@@ -0,0 +1,120 @@
+#!/usr/bin/env node
+import fs from 'node:fs/promises';
+import os from 'node:os';
+import path from 'node:path';
+import { spawn } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+const DEFAULT_REPO = 'http://10.20.124.70/bim/frontend-framework.git';
+const repo = process.env.TEMPLATE_REPO || DEFAULT_REPO;
+const localSource = process.env.TEMPLATE_DIR;
+const autoLocalSource = path.resolve(__dirname, '../..');
+const branch = process.env.TEMPLATE_BRANCH || 'main';
+const templateDir = path.resolve(__dirname, '../template');
+
+const excludes = new Set([
+  '.git',
+  'node_modules',
+  'dist',
+  '.DS_Store',
+  '.cursor',
+  '.vscode',
+  'create-swdg',
+  'create-frontend-framework',
+  'swdg',
+  'package-lock.json',
+  'pnpm-lock.yaml',
+  'openapi-generator-cli.jar',
+  'tsconfig.tsbuildinfo',
+  'auto-imports.d.ts',
+  'components.d.ts',
+  '_tmp-swdg-test',
+  'my-app',
+  'public/Cesium1.119',
+]);
+
+function run(cmd, args, options = {}) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(cmd, args, { stdio: 'inherit', ...options });
+    child.on('exit', (code) => {
+      if (code === 0) resolve();
+      else
+        reject(new Error(`${cmd} ${args.join(' ')} failed with code ${code}`));
+    });
+  });
+}
+
+async function pathExists(targetPath) {
+  try {
+    await fs.access(targetPath);
+    return true;
+  } catch {
+    return false;
+  }
+}
+
+async function copyDir(src, dest) {
+  const entries = await fs.readdir(src, { withFileTypes: true });
+  await fs.mkdir(dest, { recursive: true });
+
+  for (const entry of entries) {
+    if (excludes.has(entry.name)) continue;
+    const from = path.join(src, entry.name);
+    const to = path.join(dest, entry.name);
+
+    if (entry.isDirectory()) {
+      await copyDir(from, to);
+    } else if (entry.isSymbolicLink()) {
+      const link = await fs.readlink(from);
+      await fs.symlink(link, to);
+    } else {
+      await fs.copyFile(from, to);
+    }
+  }
+}
+
+async function main() {
+  const tempRoot = await fs.mkdtemp(path.join(os.tmpdir(), 'swdg-template-'));
+  const tempRepo = path.join(tempRoot, 'repo');
+
+  if (
+    localSource ||
+    (await pathExists(path.join(autoLocalSource, 'package.json')))
+  ) {
+    const absLocal = localSource ? path.resolve(localSource) : autoLocalSource;
+    console.log(`Syncing template from local path: ${absLocal}`);
+    await fs.rm(templateDir, { recursive: true, force: true });
+    await fs.mkdir(templateDir, { recursive: true });
+    await copyDir(absLocal, templateDir);
+    console.log('Template synced.');
+    return;
+  }
+
+  console.log(`Cloning template from ${repo} (${branch})...`);
+  await run('git', [
+    'clone',
+    '--depth',
+    '1',
+    '--branch',
+    branch,
+    repo,
+    tempRepo,
+  ]);
+
+  await fs.rm(templateDir, { recursive: true, force: true });
+  await fs.mkdir(templateDir, { recursive: true });
+
+  console.log('Syncing template...');
+  await copyDir(tempRepo, templateDir);
+
+  await fs.rm(tempRoot, { recursive: true, force: true });
+  console.log('Template synced.');
+}
+
+main().catch((err) => {
+  console.error(err?.message ?? err);
+  process.exit(1);
+});

package/scripts/validate-template.mjs

@@ -0,0 +1,74 @@
+#!/usr/bin/env node
+/**
+ * 校验 create-swdg/template 可 install / typecheck / build。
+ * 在 create-swdg 包内自包含，供 prepublishOnly 与 monorepo test:template 使用。
+ */
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { spawn } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+
+const packageRoot = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  '..'
+);
+const templateDir = path.join(packageRoot, 'template');
+
+function run(cmd, args, cwd, env = process.env) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(cmd, args, {
+      cwd,
+      stdio: 'inherit',
+      shell: true,
+      env,
+    });
+    child.on('exit', (code) => {
+      if (code === 0) resolve();
+      else reject(new Error(`${cmd} ${args.join(' ')} exited ${code}`));
+    });
+  });
+}
+
+async function assertTemplateLayout() {
+  const required = [
+    'package.json',
+    'vite.config.ts',
+    'src/main.ts',
+    'src/router/index.ts',
+    'src/views/index.vue',
+    'docs/ONBOARDING.md',
+  ];
+  for (const rel of required) {
+    try {
+      await fs.access(path.join(templateDir, rel));
+    } catch {
+      throw new Error(`template missing required file: ${rel}`);
+    }
+  }
+}
+
+async function main() {
+  console.log('\n▶ validate-template\n');
+  console.log(`  template: ${templateDir}`);
+
+  await assertTemplateLayout();
+
+  console.log('  · pnpm install');
+  await run('pnpm', ['install'], templateDir);
+
+  console.log('  · typecheck');
+  await run('pnpm', ['run', 'typecheck'], templateDir);
+
+  console.log('  · production build');
+  await run('pnpm', ['run', 'build'], templateDir, {
+    ...process.env,
+    VITE_FEATURE_GIS: 'true',
+  });
+
+  console.log('\n✓ validate-template passed\n');
+}
+
+main().catch((err) => {
+  console.error(`\n✗ validate-template failed: ${err.message}\n`);
+  process.exit(1);
+});

package/stubs/tsconfig.node.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "composite": true,
+    "skipLibCheck": true,
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "allowSyntheticDefaultImports": true,
+    "strict": true
+  },
+  "include": ["vite.config.ts"]
+}

package/stubs/types-env.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="vite/client" />
+
+interface ImportMetaEnv {
+  readonly VITE_DEMO_PROXY_TARGET?: string;
+}
+
+interface ImportMeta {
+  readonly env: ImportMetaEnv;
+}

package/stubs/vite.config.ts

@@ -0,0 +1,64 @@
+import { defineConfig, loadEnv } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import AutoImport from 'unplugin-auto-import/vite';
+import Components from 'unplugin-vue-components/vite';
+import copyPlugin from 'rollup-plugin-copy';
+import path from 'path';
+
+export default defineConfig(({ mode }) => {
+  const env = loadEnv(mode, process.cwd(), '');
+
+  return {
+    base: './',
+    build: {
+      sourcemap: true,
+      emptyOutDir: false,
+      rollupOptions: {
+        plugins: [
+          copyPlugin({
+            targets: [{ src: 'src/assets/**/*', dest: 'dist/assets' }],
+          }),
+        ],
+      },
+      outDir: 'dist',
+      assetsDir: 'assets',
+    },
+    plugins: [vue(), AutoImport({}), Components({})],
+    resolve: {
+      alias: {
+        '@': path.resolve(__dirname, './src'),
+        '@assets': path.resolve(__dirname, './src/assets'),
+        '@style': path.resolve(__dirname, './src/styles'),
+        '@stores': path.resolve(__dirname, './src/stores'),
+        '@components': path.resolve(__dirname, './src/components'),
+        '@utils': path.resolve(__dirname, './src/utils'),
+        '@api': path.resolve(__dirname, './src/api'),
+        '@types': path.resolve(__dirname, './types'),
+        '@views': path.resolve(__dirname, './src/views'),
+        '@composables': path.resolve(__dirname, './src/utils/composables'),
+        '@router': path.resolve(__dirname, './src/router'),
+        '@directive': path.resolve(__dirname, './src/directive'),
+        '@layout': path.resolve(__dirname, './src/layout'),
+        '@interface': path.resolve(__dirname, './interface'),
+      },
+    },
+    css: {
+      preprocessorOptions: {
+        less: {
+          javascriptEnabled: true,
+        },
+      },
+    },
+    server: {
+      host: '0.0.0.0',
+      port: 3000,
+      open: true,
+      proxy: {
+        '/demo': {
+          target: env.VITE_DEMO_PROXY_TARGET,
+          changeOrigin: true,
+        },
+      },
+    },
+  };
+});

package/template/.env.example

@@ -0,0 +1,6 @@
+# 复制为 .env 后按需修改
+VITE_DEMO_PROXY_TARGET=http://127.0.0.1:8888
+
+# 模板默认含 Cesium；脚手架 --no-gis 会移除此行
+VITE_FEATURE_GIS=true
+# VITE_CESIUM_ION_ACCESS_TOKEN=

package/template/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  release-gate:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@v4
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+      - run: pnpm install --frozen-lockfile
+      - run: pnpm test:ci

package/template/.github/workflows/release.yml

@@ -0,0 +1,69 @@
+name: Release to npm
+
+on:
+  push:
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Resolve version from tag
+        id: meta
+        run: |
+          TAG="${GITHUB_REF_NAME}"
+          VERSION="${TAG#v}"
+          if ! echo "$VERSION" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$'; then
+            echo "Invalid tag: $TAG (expected vX.Y.Z)"
+            exit 1
+          fi
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "Publishing version: $VERSION"
+
+      - uses: pnpm/action-setup@v4
+        with:
+          version: 9
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: pnpm
+
+      - name: Align package versions
+        run: node scripts/set-release-version.mjs "${{ steps.meta.outputs.version }}"
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Release test pipeline
+        run: pnpm test:ci
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org
+
+      - name: Publish create-swdg-frontend
+        working-directory: create-swdg
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish swdg
+        working-directory: swdg
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Summary
+        run: |
+          echo "Published create-swdg-frontend@${{ steps.meta.outputs.version }}"
+          echo "Published swdg@${{ steps.meta.outputs.version }}"

package/template/.husky/commit-msg

@@ -1,42 +1,42 @@
-npx commitlint --edit "$1" || (
-  echo ""
-  echo "提交格式："
-  echo "  <type>[scope]: <subject>"
-  echo "  type 和 subject 必填，scope 可选。"
-  echo ""
-  echo "详细说明："
-  echo "1. type（提交类型）："
-  echo "   描述提交的目的，必须是以下之一："
-  echo "    - feat     新功能开发"
-  echo "    - fix      问题修复"
-  echo "    - update   更新现有功能"
-  echo "    - docs     文档调整"
-  echo "    - style    代码格式调整（不影响功能）"
-  echo "    - refactor 代码重构（非功能变更）"
-  echo "    - perf     性能优化"
-  echo "    - test     添加或修改测试代码"
-  echo "    - chore    构建工具或依赖的变更"
-  echo "    - revert   回滚到上一次提交"
-  echo "    - build    构建相关的变更"
-  echo "    - ci       CI/CD 配置或脚本调整"
-  echo ""
-  echo "2. scope（范围模块，可选）："
-  echo "   - 可选字段，表明受影响的模块，例如 auth, api, ui 等。"
-  echo "   - 如果省略，则提交格式为：<type>: <subject>"
-  echo ""
-  echo "3. subject（简要描述）："
-  echo "   - 用一句话清晰描述本次提交的目的。"
-  echo "   - 必须清晰、简短，不超过 72 个字符。"
-  echo "   - 支持中文描述，可以用句号（。）结尾。"
-  echo "   - subject 必须全部使用小写字母，不能使用句首大写、首字母大写、帕斯卡命名或全大写。（例如：update: gis弹窗添加基础功能, 地图定位）"
-  echo ""
-  echo "提交信息示例："
-  echo "  feat(auth): 添加用户登录功能"
-  echo "  fix: 修复用户接口返回错误问题"
-  echo "  update(ui): 优化表单组件样式"
-  echo "  style: 调整代码格式，去除无用空格"
-  echo ""
-  echo "错误原因：提交信息不符合以上规范，请根据提示修改！"
-  echo ""
-  exit 1
-)
+npx commitlint --edit "$1" || (
+  echo ""
+  echo "提交格式："
+  echo "  <type>[scope]: <subject>"
+  echo "  type 和 subject 必填，scope 可选。"
+  echo ""
+  echo "详细说明："
+  echo "1. type（提交类型）："
+  echo "   描述提交的目的，必须是以下之一："
+  echo "    - feat     新功能开发"
+  echo "    - fix      问题修复"
+  echo "    - update   更新现有功能"
+  echo "    - docs     文档调整"
+  echo "    - style    代码格式调整（不影响功能）"
+  echo "    - refactor 代码重构（非功能变更）"
+  echo "    - perf     性能优化"
+  echo "    - test     添加或修改测试代码"
+  echo "    - chore    构建工具或依赖的变更"
+  echo "    - revert   回滚到上一次提交"
+  echo "    - build    构建相关的变更"
+  echo "    - ci       CI/CD 配置或脚本调整"
+  echo ""
+  echo "2. scope（范围模块，可选）："
+  echo "   - 可选字段，表明受影响的模块，例如 auth, api, ui 等。"
+  echo "   - 如果省略，则提交格式为：<type>: <subject>"
+  echo ""
+  echo "3. subject（简要描述）："
+  echo "   - 用一句话清晰描述本次提交的目的。"
+  echo "   - 必须清晰、简短，不超过 72 个字符。"
+  echo "   - 支持中文描述，可以用句号（。）结尾。"
+  echo "   - subject 必须全部使用小写字母，不能使用句首大写、首字母大写、帕斯卡命名或全大写。（例如：update: gis弹窗添加基础功能, 地图定位）"
+  echo ""
+  echo "提交信息示例："
+  echo "  feat(auth): 添加用户登录功能"
+  echo "  fix: 修复用户接口返回错误问题"
+  echo "  update(ui): 优化表单组件样式"
+  echo "  style: 调整代码格式，去除无用空格"
+  echo ""
+  echo "错误原因：提交信息不符合以上规范，请根据提示修改！"
+  echo ""
+  exit 1
+)

package/template/.husky/pre-commit

@@ -1,2 +1,2 @@
-# 运行 lint-staged
-npx lint-staged
+# 运行 lint-staged
+npx lint-staged

package/template/.lintstagedrc

@@ -1,5 +1,5 @@
-{
-  "*.{js,ts}": ["eslint --fix", "prettier --write"],
-  "*.vue": ["stylelint --fix", "prettier --write"],
-  "*.{less,css}": ["prettier --write"]
-}
+{
+  "*.{js,ts}": ["eslint --fix", "prettier --write"],
+  "*.vue": ["stylelint --fix", "prettier --write"],
+  "*.{less,css}": ["prettier --write"]
+}

package/template/.prettierignore

@@ -1,26 +1,26 @@
-# 忽略构建输出目录
-dist
-out
-
-# 忽略依赖目录
-node_modules
-
-# 忽略 Vite 自动生成的文件
-index.html
-
-# 忽略所有 .d.ts 文件
-*.d.ts
-
-# 忽略环境配置文件
-.env
-.env.local
-.env.*.local
-
-# 忽略自动生成的组件声明文件
-src/components.d.ts
-
-android
-
-dev-dist
-
-public/**
+# 忽略构建输出目录
+dist
+out
+
+# 忽略依赖目录
+node_modules
+
+# 忽略 Vite 自动生成的文件
+index.html
+
+# 忽略所有 .d.ts 文件
+*.d.ts
+
+# 忽略环境配置文件
+.env
+.env.local
+.env.*.local
+
+# 忽略自动生成的组件声明文件
+src/components.d.ts
+
+android
+
+dev-dist
+
+public/**