create-swdg-frontend 0.1.7 → 0.2.0

package/template/scripts/gen-api.cjs

@@ -85,7 +85,9 @@ function quoteForCmd(arg) {
 }
 
 function execOnWindowsViaCmd(commandLine) {
-  execFileSync('cmd.exe', ['/d', '/s', '/c', commandLine], { stdio: 'inherit' });
+  execFileSync('cmd.exe', ['/d', '/s', '/c', commandLine], {
+    stdio: 'inherit',
+  });
 }
 
 function runAndReport(cmd, args, options = {}) {
@@ -94,8 +96,10 @@ function runAndReport(cmd, args, options = {}) {
   } catch (e) {
     const stdout = e && e.stdout ? e.stdout.toString() : '';
     const stderr = e && e.stderr ? e.stderr.toString() : '';
-    if (stdout.trim()) console.error(`\n[openapi-generator stdout]\n${stdout}\n`);
-    if (stderr.trim()) console.error(`\n[openapi-generator stderr]\n${stderr}\n`);
+    if (stdout.trim())
+      console.error(`\n[openapi-generator stdout]\n${stdout}\n`);
+    if (stderr.trim())
+      console.error(`\n[openapi-generator stderr]\n${stderr}\n`);
     throw e;
   }
 }
@@ -110,7 +114,8 @@ function withJavaEnv(baseEnv) {
 
   // ✅ 如果你已全局装好 Java（java -version 可用），可以把这块注释掉
   // TODO: 把这里改成你的 JDK 路径
-  const JDK_HOME = env.JDK_HOME || env.JAVA_HOME || 'C:\\Program Files\\Java\\jdk-17';
+  const JDK_HOME =
+    env.JDK_HOME || env.JAVA_HOME || 'C:\\Program Files\\Java\\jdk-17';
 
   if (process.platform === 'win32') {
     const javaBin = path.join(JDK_HOME, 'bin');
@@ -148,7 +153,10 @@ function runOpenapiGenerator(args) {
     const cmdline = ['npx', 'openapi-generator-cli', ...args]
       .map(quoteForCmd)
       .join(' ');
-    execFileSync('cmd.exe', ['/d', '/s', '/c', cmdline], { stdio: 'inherit', env });
+    execFileSync('cmd.exe', ['/d', '/s', '/c', cmdline], {
+      stdio: 'inherit',
+      env,
+    });
     return;
   }
 
@@ -200,7 +208,9 @@ function moveToSrcApi(serviceName, tempDir, targetBase) {
   }
 
   fse.moveSync(tempDir, destDir, { overwrite: true });
-  console.log(`✅ ${serviceName} 接口生成完毕，已移动到 src/api/${serviceName}`);
+  console.log(
+    `✅ ${serviceName} 接口生成完毕，已移动到 src/api/${serviceName}`
+  );
 }
 
 function toCamelExportName(serviceName) {
@@ -257,7 +267,10 @@ async function main() {
     try {
       await generateService(svc.name, svc.url);
     } catch (err) {
-      console.error(`❌ 生成失败: ${svc.name}`, err && err.message ? err.message : err);
+      console.error(
+        `❌ 生成失败: ${svc.name}`,
+        err && err.message ? err.message : err
+      );
     }
   }
 

package/template/scripts/release.mjs

@@ -7,51 +7,45 @@ const rootDir = process.cwd();
 const createDir = path.join(rootDir, 'create-swdg');
 const swdgDir = path.join(rootDir, 'swdg');
 
-const createPkgPath = path.join(createDir, 'package.json');
-const swdgPkgPath = path.join(swdgDir, 'package.json');
-
 const input = process.argv[2];
 if (!input) {
   console.error('Usage: node scripts/release.mjs <x.y.z>');
+  console.error('Tip: push tag v<x.y.z> to GitHub for automated npm publish.');
   process.exit(1);
 }
 
-const readJson = (filePath) => JSON.parse(fs.readFileSync(filePath, 'utf8'));
-const writeJson = (filePath, data) =>
-  fs.writeFileSync(filePath, JSON.stringify(data, null, 2) + '\n', 'utf8');
-
-const isValidVersion = (value) => /^\d+\.\d+\.\d+$/.test(value);
-const createPkg = readJson(createPkgPath);
-const swdgPkg = readJson(swdgPkgPath);
-
-if (!isValidVersion(input)) {
+if (!/^\d+\.\d+\.\d+$/.test(input)) {
   console.error('Version must be in x.y.z format, e.g. 0.1.2');
   process.exit(1);
 }
 
-const nextVersion = input;
-
-createPkg.version = nextVersion;
-swdgPkg.version = nextVersion;
-swdgPkg.dependencies = swdgPkg.dependencies || {};
-swdgPkg.dependencies['create-swdg-frontend'] = `^${nextVersion}`;
+console.log('\nRunning release test pipeline (must pass before publish)…\n');
+execSync('node scripts/test-pipeline.mjs', { stdio: 'inherit', cwd: rootDir });
 
-writeJson(createPkgPath, createPkg);
-writeJson(swdgPkgPath, swdgPkg);
+execSync(`node scripts/set-release-version.mjs ${input}`, {
+  stdio: 'inherit',
+  cwd: rootDir,
+});
 
 try {
   execSync('npm config set registry https://registry.npmjs.org/', {
     stdio: 'inherit',
   });
   execSync('pnpm -C create-swdg run prepublishOnly', { stdio: 'inherit' });
-  execSync('npm publish --access public --registry https://registry.npmjs.org/', {
-    stdio: 'inherit',
-    cwd: createDir,
-  });
-  execSync('npm publish --access public --registry https://registry.npmjs.org/', {
-    stdio: 'inherit',
-    cwd: swdgDir,
-  });
+  execSync(
+    'npm publish --access public --registry https://registry.npmjs.org/',
+    {
+      stdio: 'inherit',
+      cwd: createDir,
+    }
+  );
+  execSync(
+    'npm publish --access public --registry https://registry.npmjs.org/',
+    {
+      stdio: 'inherit',
+      cwd: swdgDir,
+    }
+  );
 } finally {
   execSync('npm config set registry https://registry.npmmirror.com/', {
     stdio: 'inherit',

package/template/scripts/set-release-version.mjs

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+/**
+ * 将 create-swdg / swdg / SCAFFOLD_VERSION 对齐到同一 semver。
+ * 供本地 release 与 CI tag 发布共用。
+ */
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const rootDir = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+const createPkgPath = path.join(rootDir, 'create-swdg/package.json');
+const swdgPkgPath = path.join(rootDir, 'swdg/package.json');
+const constantsPath = path.join(rootDir, 'create-swdg/lib/constants.js');
+
+const version = process.argv[2];
+if (!version || !/^\d+\.\d+\.\d+$/.test(version)) {
+  console.error('Usage: node scripts/set-release-version.mjs <x.y.z>');
+  process.exit(1);
+}
+
+const readJson = (filePath) => JSON.parse(fs.readFileSync(filePath, 'utf8'));
+const writeJson = (filePath, data) =>
+  fs.writeFileSync(filePath, JSON.stringify(data, null, 2) + '\n', 'utf8');
+
+const createPkg = readJson(createPkgPath);
+const swdgPkg = readJson(swdgPkgPath);
+
+createPkg.version = version;
+swdgPkg.version = version;
+swdgPkg.dependencies = swdgPkg.dependencies || {};
+swdgPkg.dependencies['create-swdg-frontend'] = `^${version}`;
+
+writeJson(createPkgPath, createPkg);
+writeJson(swdgPkgPath, swdgPkg);
+
+let constants = fs.readFileSync(constantsPath, 'utf8');
+constants = constants.replace(
+  /export const SCAFFOLD_VERSION = '[^']+';/,
+  `export const SCAFFOLD_VERSION = '${version}';`
+);
+fs.writeFileSync(constantsPath, constants, 'utf8');
+
+console.log(`✓ Release version set to ${version}`);
+console.log('  - create-swdg/package.json');
+console.log('  - swdg/package.json');
+console.log('  - create-swdg/lib/constants.js');

package/template/scripts/test-pipeline.mjs

@@ -0,0 +1,85 @@
+#!/usr/bin/env node
+/**
+ * 发布前统一测试管道（本地 CI / npm release 门禁）。
+ *
+ * 顺序固定，任一阶段失败即 exit(1)：
+ *   0. sync       — 生成 create-swdg/template（CI 全新 clone 必需）
+ *   1. verify     — typecheck + eslint
+ *   2. unit       — vitest
+ *   3. scaffold   — 脚手架集成（无 install）
+ *   4. template   — template install/typecheck/build
+ */
+import { spawn } from 'node:child_process';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const rootDir = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  '..'
+);
+
+const syncScript = path.join(rootDir, 'create-swdg/scripts/sync-template.js');
+
+const stages = [
+  {
+    name: 'sync',
+    cmd: process.execPath,
+    args: [syncScript],
+    env: { ...process.env, TEMPLATE_DIR: rootDir },
+  },
+  { name: 'verify', cmd: process.execPath, args: ['scripts/verify.mjs'] },
+  { name: 'unit', cmd: 'pnpm', args: ['run', 'test:unit'] },
+  {
+    name: 'scaffold',
+    cmd: process.execPath,
+    args: ['scripts/test-scaffold.mjs'],
+  },
+  {
+    name: 'template',
+    cmd: process.execPath,
+    args: ['scripts/test-template.mjs'],
+  },
+];
+
+function runStage(stage) {
+  return new Promise((resolve, reject) => {
+    console.log(
+      `\n${'='.repeat(60)}\n▶ stage: ${stage.name}\n${'='.repeat(60)}\n`
+    );
+    const started = Date.now();
+    const child = spawn(stage.cmd, stage.args, {
+      cwd: rootDir,
+      stdio: 'inherit',
+      shell: stage.cmd === 'pnpm',
+      env: stage.env ?? process.env,
+    });
+    child.on('exit', (code) => {
+      const sec = ((Date.now() - started) / 1000).toFixed(1);
+      if (code === 0) {
+        console.log(`\n✓ stage "${stage.name}" passed (${sec}s)\n`);
+        resolve();
+      } else {
+        reject(new Error(`stage "${stage.name}" failed (exit ${code})`));
+      }
+    });
+  });
+}
+
+async function main() {
+  console.log('\nSWDG release test pipeline\n');
+  const pipelineStarted = Date.now();
+
+  for (const stage of stages) {
+    await runStage(stage);
+  }
+
+  const totalSec = ((Date.now() - pipelineStarted) / 1000).toFixed(1);
+  console.log(`${'='.repeat(60)}`);
+  console.log(`✓ ALL STAGES PASSED (${totalSec}s)`);
+  console.log(`${'='.repeat(60)}\n`);
+}
+
+main().catch((err) => {
+  console.error(`\n✗ PIPELINE FAILED: ${err.message}\n`);
+  process.exit(1);
+});

package/template/scripts/test-scaffold.mjs

@@ -0,0 +1,197 @@
+#!/usr/bin/env node
+/**
+ * 脚手架集成测试：无 GIS / 有 GIS 产物结构、manifest、CLI 参数解析。
+ * 不执行 pnpm install（快速、可重复）。
+ */
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import os from 'node:os';
+import { spawn } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+import { createProject, pathExists } from '../create-swdg/lib/scaffold.js';
+import { SCAFFOLD_VERSION } from '../create-swdg/lib/constants.js';
+
+const rootDir = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  '..'
+);
+const cliBin = path.join(rootDir, 'create-swdg/bin/index.js');
+const tmpBase = path.join(os.tmpdir(), 'swdg-scaffold-test');
+
+let passed = 0;
+let failed = 0;
+
+function pass(name) {
+  passed += 1;
+  console.log(`  ✓ ${name}`);
+}
+
+function fail(name, err) {
+  failed += 1;
+  console.error(`  ✗ ${name}`);
+  console.error(`    ${err?.message ?? err}`);
+}
+
+async function readJson(filePath) {
+  return JSON.parse(await fs.readFile(filePath, 'utf8'));
+}
+
+async function assertNoGisProject(dir) {
+  const pkg = await readJson(path.join(dir, 'package.json'));
+  if (pkg.dependencies?.cesium) {
+    throw new Error('dependencies.cesium should be removed');
+  }
+  if (pkg.devDependencies?.['vite-plugin-static-copy']) {
+    throw new Error('vite-plugin-static-copy should be removed');
+  }
+  const paths = [
+    'scripts/vite-plugin-cesium-dev.ts',
+    'src/utils/cesium',
+    'src/components/CesiumViewer',
+    'src/views/examples/cesium',
+  ];
+  for (const rel of paths) {
+    if (await pathExists(path.join(dir, rel))) {
+      throw new Error(`should not exist: ${rel}`);
+    }
+  }
+  const envExample = await fs.readFile(path.join(dir, '.env.example'), 'utf8');
+  if (envExample.includes('VITE_FEATURE_GIS=true')) {
+    throw new Error('.env.example should not contain VITE_FEATURE_GIS=true');
+  }
+  const manifest = await readJson(path.join(dir, '.swdg/manifest.json'));
+  if (manifest.features.gis !== false) {
+    throw new Error('manifest.features.gis should be false');
+  }
+  if (manifest.generatorVersion !== SCAFFOLD_VERSION) {
+    throw new Error(`manifest version mismatch: ${manifest.generatorVersion}`);
+  }
+}
+
+async function assertGisProject(dir) {
+  const pkg = await readJson(path.join(dir, 'package.json'));
+  if (!pkg.dependencies?.cesium) {
+    throw new Error('dependencies.cesium should exist');
+  }
+  if (
+    !(await pathExists(path.join(dir, 'src/views/examples/cesium/index.vue')))
+  ) {
+    throw new Error('cesium example page missing');
+  }
+  const envExample = await fs.readFile(path.join(dir, '.env.example'), 'utf8');
+  if (!envExample.includes('VITE_FEATURE_GIS=true')) {
+    throw new Error('.env.example should contain VITE_FEATURE_GIS=true');
+  }
+  const manifest = await readJson(path.join(dir, '.swdg/manifest.json'));
+  if (manifest.features.gis !== true) {
+    throw new Error('manifest.features.gis should be true');
+  }
+}
+
+function runCli(cwd, args) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(process.execPath, [cliBin, ...args], {
+      cwd,
+      stdio: ['ignore', 'pipe', 'pipe'],
+    });
+    let stdout = '';
+    let stderr = '';
+    child.stdout.on('data', (d) => {
+      stdout += d;
+    });
+    child.stderr.on('data', (d) => {
+      stderr += d;
+    });
+    child.on('exit', (code) => {
+      resolve({ code, stdout, stderr });
+    });
+    child.on('error', reject);
+  });
+}
+
+async function rmDir(dir) {
+  await fs.rm(dir, { recursive: true, force: true });
+}
+
+async function runCase(name, fn) {
+  try {
+    await fn();
+    pass(name);
+  } catch (err) {
+    fail(name, err);
+  }
+}
+
+async function main() {
+  console.log('\n▶ test:scaffold\n');
+  await fs.mkdir(tmpBase, { recursive: true });
+
+  const noGisDir = path.join(tmpBase, 'proj-no-gis');
+  const gisDir = path.join(tmpBase, 'proj-gis');
+  const cliDir = path.join(tmpBase, 'cli-run');
+
+  await runCase('programmatic scaffold --no-gis', async () => {
+    await rmDir(noGisDir);
+    await createProject(noGisDir, {
+      projectName: 'proj-no-gis',
+      gis: false,
+    });
+    const pkg = await readJson(path.join(noGisDir, 'package.json'));
+    if (pkg.name !== 'proj-no-gis') {
+      throw new Error(`package name should be proj-no-gis, got ${pkg.name}`);
+    }
+    await assertNoGisProject(noGisDir);
+  });
+
+  await runCase('programmatic scaffold --gis', async () => {
+    await rmDir(gisDir);
+    await createProject(gisDir, {
+      projectName: 'proj-gis',
+      gis: true,
+    });
+    await assertGisProject(gisDir);
+  });
+
+  await runCase('CLI end-to-end --no-gis --no-install', async () => {
+    await rmDir(cliDir);
+    await fs.mkdir(cliDir, { recursive: true });
+    const { code } = await runCli(cliDir, [
+      'cli-smoke-app',
+      '--no-gis',
+      '--no-install',
+      '--no-git',
+      '--no-verify',
+    ]);
+    if (code !== 0) {
+      throw new Error(`CLI exited with ${code}`);
+    }
+    const outDir = path.join(cliDir, 'cli-smoke-app');
+    await assertNoGisProject(outDir);
+  });
+
+  await runCase('CLI rejects invalid project name', async () => {
+    await rmDir(cliDir);
+    await fs.mkdir(cliDir, { recursive: true });
+    const { code } = await runCli(cliDir, [
+      'Invalid_Name',
+      '--no-install',
+      '--no-git',
+      '--no-verify',
+    ]);
+    if (code === 0) {
+      throw new Error('CLI should fail for invalid project name');
+    }
+  });
+
+  await rmDir(tmpBase);
+
+  console.log(`\n  scaffold: ${passed} passed, ${failed} failed\n`);
+  if (failed > 0) {
+    process.exit(1);
+  }
+}
+
+main().catch((err) => {
+  console.error(err);
+  process.exit(1);
+});

package/template/scripts/test-template.mjs

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+/**
+ * 模板包质量门禁：sync 后的 create-swdg/template 必须能 install / typecheck / build。
+ */
+import path from 'node:path';
+import { spawn } from 'node:child_process';
+import { fileURLToPath } from 'node:url';
+
+const rootDir = path.resolve(
+  path.dirname(fileURLToPath(import.meta.url)),
+  '..'
+);
+const syncScript = path.join(rootDir, 'create-swdg/scripts/sync-template.js');
+const validateScript = path.join(
+  rootDir,
+  'create-swdg/scripts/validate-template.mjs'
+);
+
+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 main() {
+  console.log('\n▶ test:template\n');
+
+  console.log('  · sync-template');
+  await run(process.execPath, [syncScript], rootDir, {
+    ...process.env,
+    TEMPLATE_DIR: rootDir,
+  });
+
+  console.log('  · validate-template');
+  await run(process.execPath, [validateScript], rootDir);
+
+  console.log('\n✓ test:template passed\n');
+}
+
+main().catch((err) => {
+  console.error(`\n✗ test:template failed: ${err.message}\n`);
+  process.exit(1);
+});

package/template/scripts/verify.mjs

@@ -0,0 +1,28 @@
+#!/usr/bin/env node
+import { spawn } from 'node:child_process';
+
+const steps = [
+  ['typecheck', ['run', 'typecheck']],
+  ['lint', ['run', 'lint']],
+];
+
+function run(cmd, args) {
+  return new Promise((resolve, reject) => {
+    const child = spawn(cmd, args, { stdio: 'inherit', shell: true });
+    child.on('exit', (code) => {
+      if (code === 0) resolve();
+      else reject(new Error(`${cmd} ${args.join(' ')} failed`));
+    });
+  });
+}
+
+try {
+  for (const [name, args] of steps) {
+    console.log(`\n▶ verify: ${name}\n`);
+    await run('pnpm', args);
+  }
+  console.log('\n✓ verify passed\n');
+} catch (err) {
+  console.error(`\n✗ ${err.message}\n`);
+  process.exit(1);
+}

package/template/scripts/vite-plugin-cesium-dev.ts

@@ -0,0 +1,56 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import type { Plugin } from 'vite';
+
+const cesiumRoot = path.resolve(
+  process.cwd(),
+  'node_modules/cesium/Build/Cesium'
+);
+
+const MIME: Record<string, string> = {
+  '.js': 'application/javascript',
+  '.mjs': 'application/javascript',
+  '.json': 'application/json',
+  '.wasm': 'application/wasm',
+  '.css': 'text/css',
+  '.svg': 'image/svg+xml',
+  '.png': 'image/png',
+  '.jpg': 'image/jpeg',
+  '.jpeg': 'image/jpeg',
+  '.xml': 'application/xml',
+};
+
+/** 开发环境从 node_modules 提供 Cesium Workers/Assets，避免请求落到 SPA 返回 HTML */
+export function cesiumDevAssets(mountPath = '/cesium'): Plugin {
+  return {
+    name: 'cesium-dev-assets',
+    apply: 'serve',
+    configureServer(server) {
+      server.middlewares.use(mountPath, (req, res, next) => {
+        const rawUrl = req.url ?? '';
+        const pathname = decodeURIComponent(rawUrl.split('?')[0]);
+        const relative = pathname.replace(/^\/+/, '');
+        if (!relative) {
+          next();
+          return;
+        }
+
+        const filePath = path.join(cesiumRoot, relative);
+        if (!filePath.startsWith(cesiumRoot)) {
+          res.statusCode = 403;
+          res.end();
+          return;
+        }
+
+        if (!fs.existsSync(filePath) || fs.statSync(filePath).isDirectory()) {
+          next();
+          return;
+        }
+
+        const ext = path.extname(filePath);
+        res.setHeader('Content-Type', MIME[ext] ?? 'application/octet-stream');
+        fs.createReadStream(filePath).pipe(res);
+      });
+    },
+  };
+}

package/template/src/api/README.md

@@ -1,3 +1,7 @@
 # api
 
 后端接口请求统一放在这里。
+
+开发环境代理：`/demo` → `.env` 中的 `VITE_DEMO_PROXY_TARGET`（见 `vite.config.ts`）。
+
+更多用法见 [docs/ONBOARDING.md](../../docs/ONBOARDING.md)。