pdf-master-landing 0.0.6 → 0.1.0

package/README.md

@@ -1,82 +1,82 @@
-# PDF Master Landing
-
-PDF Master 的产品介绍页。Vite + React + TypeScript。
-
-## 与 Flutter Web 的关系
-
-落地页是站点根；Flutter Web 应用部署在 `/app/` 子路径下。
-
-集成方式：
-
-- **构建产物源**：`flutter build web --base-href /app/ --wasm --release` → `<repo>/build/web/`。
-- **同步点**：`landing/public/app/`。vite 把 `public/` 在 dev 直接 serve、在 build 拷到 `dist/`，所以一处同步两处生效。
-- **同步脚本**：`scripts/sync-flutter-web.mjs`，挂在 `predev` / `prebuild` 钩子上，自动执行。
-
-`landing/public/app/` 是构建产物，已 gitignore。
-
-## 开发
-
-```bash
-cd landing
-npm install
-
-# 第一次跑：先准备 Flutter 产物（一次构建即可，后续不用重复）
-npm run sync:app
-
-# 启动 dev server
-npm run dev          # http://localhost:5180
-```
-
-`npm run dev` 会先跑 `predev`，把现有的 `build/web/` 同步到 `public/app/`（不重新构建 Flutter）。
-如果 Flutter 代码有改动，重新跑 `npm run sync:app`。
-
-### 用 flutter run 热重载联调
-
-不想反复 `flutter build web`，可以让 Flutter 自己跑独立 dev server：
-
-```bash
-# 终端 A
-cd ..
-flutter run -d chrome --web-port 5181
-
-# 终端 B：跳过同步、走 VITE_APP_BASE 切换
-echo "VITE_APP_BASE=http://localhost:5181/" > landing/.env.local
-SKIP_FLUTTER=1 npm run dev
-```
-
-## 生产构建
-
-```bash
-npm run build        # → landing/dist/，包含 dist/app/
-```
-
-`prebuild` 钩子会先跑 `flutter build web` + 同步到 `public/app/`，然后 vite build 把整个 `public/` 拷进 `dist/`。
-
-## npm 发布与 1Panel 部署
-
-这个项目可以作为 npm 包发布，包内只暴露静态产物 `dist/` 和部署脚本。
-
-```bash
-cd landing
-npm publish
-```
-
-服务器上先把包安装到 1Panel 站点目录，再用包内 bin 把公开目录切成软链接：
-
-```bash
-cd /opt/1panel/www/sites/pdfmaster.top/index
-npm install pdf-master-landing@latest
-npx pdfmaster-deploy --target .
-```
-
-执行后，`/opt/1panel/www/sites/pdfmaster.top/index/dist` 会指向
-`node_modules/pdf-master-landing/dist`。OpenResty 当前 root 仍然是
-`/www/sites/pdfmaster.top/index/dist`，不用改 1Panel 站点配置。
-
-## 同步脚本参数
-
-```bash
-npm run sync:app             # 构建 + 同步（默认）
-npm run sync:app:no-build    # 只同步现有 build/web/，不跑 flutter
-SKIP_FLUTTER=1 ...           # 完全跳过（前端纯 UI 联调时用）
-```
+# PDF Master Landing
+
+PDF Master 的产品介绍页。Vite + React + TypeScript。
+
+## 与 Flutter Web 的关系
+
+落地页是站点根；Flutter Web 应用部署在 `/app/` 子路径下。
+
+集成方式：
+
+- **构建产物源**：`flutter build web --base-href /app/ --wasm --release` → `<repo>/build/web/`。
+- **同步点**：`landing/public/app/`。vite 把 `public/` 在 dev 直接 serve、在 build 拷到 `dist/`，所以一处同步两处生效。
+- **同步脚本**：`scripts/sync-flutter-web.mjs`，挂在 `predev` / `prebuild` 钩子上，自动执行。
+
+`landing/public/app/` 是构建产物，已 gitignore。
+
+## 开发
+
+```bash
+cd landing
+npm install
+
+# 第一次跑：先准备 Flutter 产物（一次构建即可，后续不用重复）
+npm run sync:app
+
+# 启动 dev server
+npm run dev          # http://localhost:5180
+```
+
+`npm run dev` 会先跑 `predev`，把现有的 `build/web/` 同步到 `public/app/`（不重新构建 Flutter）。
+如果 Flutter 代码有改动，重新跑 `npm run sync:app`。
+
+### 用 flutter run 热重载联调
+
+不想反复 `flutter build web`，可以让 Flutter 自己跑独立 dev server：
+
+```bash
+# 终端 A
+cd ..
+flutter run -d chrome --web-port 5181
+
+# 终端 B：跳过同步、走 VITE_APP_BASE 切换
+echo "VITE_APP_BASE=http://localhost:5181/" > landing/.env.local
+SKIP_FLUTTER=1 npm run dev
+```
+
+## 生产构建
+
+```bash
+npm run build        # → landing/dist/，包含 dist/app/
+```
+
+`prebuild` 钩子会先跑 `flutter build web` + 同步到 `public/app/`，然后 vite build 把整个 `public/` 拷进 `dist/`。
+
+## npm 发布与 1Panel 部署
+
+这个项目可以作为 npm 包发布，包内只暴露静态产物 `dist/` 和部署脚本。
+
+```bash
+cd landing
+npm publish
+```
+
+服务器上先把包安装到 1Panel 站点目录，再用包内 bin 把公开目录切成软链接：
+
+```bash
+cd /opt/1panel/www/sites/pdfmaster.top/index
+npm install pdf-master-landing@latest
+npx pdfmaster-deploy --target .
+```
+
+执行后，`/opt/1panel/www/sites/pdfmaster.top/index/dist` 会指向
+`node_modules/pdf-master-landing/dist`。OpenResty 当前 root 仍然是
+`/www/sites/pdfmaster.top/index/dist`，不用改 1Panel 站点配置。
+
+## 同步脚本参数
+
+```bash
+npm run sync:app             # 构建 + 同步（默认）
+npm run sync:app:no-build    # 只同步现有 build/web/，不跑 flutter
+SKIP_FLUTTER=1 ...           # 完全跳过（前端纯 UI 联调时用）
+```

package/bin/deploy.mjs

@@ -1,164 +1,164 @@
-#!/usr/bin/env node
-
-import fs from 'node:fs/promises';
-import path from 'node:path';
-import { fileURLToPath } from 'node:url';
-
-const packageRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
-
-function printHelp() {
-  console.log(`PDF Master landing deploy
-
-Usage:
-  pdfmaster-deploy --target <site-index-dir>
-  pdf-master-landing deploy --target <site-index-dir>
-
-Options:
-  -t, --target <dir>     Directory that owns the public dist symlink.
-  --link-name <name>     Symlink name inside target. Defaults to dist.
-  --dry-run              Print the planned link change without writing files.
-  -h, --help             Show this help.
-`);
-}
-
-function parseArgs(argv) {
-  const args = argv[0] === 'deploy' ? argv.slice(1) : argv;
-  const options = {
-    linkName: 'dist',
-    dryRun: false,
-    target: undefined,
-  };
-
-  for (let index = 0; index < args.length; index += 1) {
-    const arg = args[index];
-    const next = args[index + 1];
-
-    if (arg === '-h' || arg === '--help') {
-      options.help = true;
-      continue;
-    }
-
-    if (arg === '--dry-run') {
-      options.dryRun = true;
-      continue;
-    }
-
-    if (arg === '-t' || arg === '--target') {
-      if (!next) {
-        throw new Error(`${arg} requires a directory.`);
-      }
-      options.target = next;
-      index += 1;
-      continue;
-    }
-
-    if (arg === '--link-name') {
-      if (!next) {
-        throw new Error('--link-name requires a name.');
-      }
-      options.linkName = next;
-      index += 1;
-      continue;
-    }
-
-    throw new Error(`Unknown argument: ${arg}`);
-  }
-
-  return options;
-}
-
-async function pathExists(value) {
-  try {
-    await fs.lstat(value);
-    return true;
-  } catch (error) {
-    if (error?.code === 'ENOENT') {
-      return false;
-    }
-    throw error;
-  }
-}
-
-function assertSafeLinkName(linkName) {
-  if (!linkName || linkName.includes('/') || linkName.includes('\\') || linkName === '.' || linkName === '..') {
-    throw new Error('--link-name must be a plain file name inside the target directory.');
-  }
-}
-
-function assertPackageInsideTarget(sourceDist, targetDir) {
-  const relative = path.relative(targetDir, sourceDist);
-  if (relative.startsWith('..') || path.isAbsolute(relative)) {
-    throw new Error(`The package dist directory is outside the deploy target.
-
-Install the npm package inside the 1Panel site directory first, then run the local bin:
-
-  cd ${targetDir}
-  npm install pdf-master-landing@latest
-  npx pdfmaster-deploy --target .
-
-Package dist:
-  ${sourceDist}
-Deploy target:
-  ${targetDir}`);
-  }
-}
-
-async function deploy(options) {
-  if (!options.target) {
-    throw new Error('--target is required.');
-  }
-
-  assertSafeLinkName(options.linkName);
-
-  const rawSourceDist = path.join(packageRoot, 'dist');
-  const sourceIndex = path.join(rawSourceDist, 'index.html');
-  const rawTargetDir = path.resolve(options.target);
-
-  if (!(await pathExists(sourceIndex))) {
-    throw new Error(`Cannot find built landing files at ${rawSourceDist}. Run npm run build before packing or publishing.`);
-  }
-
-  if (!(await pathExists(rawTargetDir))) {
-    throw new Error(`Deploy target does not exist: ${rawTargetDir}`);
-  }
-
-  const sourceDist = await fs.realpath(rawSourceDist);
-  const targetDir = await fs.realpath(rawTargetDir);
-  const linkPath = path.join(targetDir, options.linkName);
-  const tempLinkPath = path.join(targetDir, `.${options.linkName}.next-${process.pid}-${Date.now()}`);
-  const relativeSource = path.relative(path.dirname(linkPath), sourceDist);
-  const symlinkType = process.platform === 'win32' ? 'junction' : 'dir';
-
-  assertPackageInsideTarget(sourceDist, targetDir);
-
-  console.log(`PDF Master landing deploy
-Target: ${targetDir}
-Source: ${sourceDist}
-Link:   ${linkPath} -> ${relativeSource}`);
-
-  if (options.dryRun) {
-    console.log('Dry run complete. No files were changed.');
-    return;
-  }
-
-  await fs.rm(tempLinkPath, { force: true, recursive: true });
-  await fs.symlink(relativeSource, tempLinkPath, symlinkType);
-  await fs.rm(linkPath, { force: true, recursive: true });
-  await fs.rename(tempLinkPath, linkPath);
-
-  console.log('Deploy complete.');
-}
-
-try {
-  const options = parseArgs(process.argv.slice(2));
-
-  if (options.help) {
-    printHelp();
-  } else {
-    await deploy(options);
-  }
-} catch (error) {
-  console.error(error instanceof Error ? error.message : error);
-  console.error('Run pdfmaster-deploy --help for usage.');
-  process.exitCode = 1;
-}
+#!/usr/bin/env node
+
+import fs from 'node:fs/promises';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const packageRoot = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
+
+function printHelp() {
+  console.log(`PDF Master landing deploy
+
+Usage:
+  pdfmaster-deploy --target <site-index-dir>
+  pdf-master-landing deploy --target <site-index-dir>
+
+Options:
+  -t, --target <dir>     Directory that owns the public dist symlink.
+  --link-name <name>     Symlink name inside target. Defaults to dist.
+  --dry-run              Print the planned link change without writing files.
+  -h, --help             Show this help.
+`);
+}
+
+function parseArgs(argv) {
+  const args = argv[0] === 'deploy' ? argv.slice(1) : argv;
+  const options = {
+    linkName: 'dist',
+    dryRun: false,
+    target: undefined,
+  };
+
+  for (let index = 0; index < args.length; index += 1) {
+    const arg = args[index];
+    const next = args[index + 1];
+
+    if (arg === '-h' || arg === '--help') {
+      options.help = true;
+      continue;
+    }
+
+    if (arg === '--dry-run') {
+      options.dryRun = true;
+      continue;
+    }
+
+    if (arg === '-t' || arg === '--target') {
+      if (!next) {
+        throw new Error(`${arg} requires a directory.`);
+      }
+      options.target = next;
+      index += 1;
+      continue;
+    }
+
+    if (arg === '--link-name') {
+      if (!next) {
+        throw new Error('--link-name requires a name.');
+      }
+      options.linkName = next;
+      index += 1;
+      continue;
+    }
+
+    throw new Error(`Unknown argument: ${arg}`);
+  }
+
+  return options;
+}
+
+async function pathExists(value) {
+  try {
+    await fs.lstat(value);
+    return true;
+  } catch (error) {
+    if (error?.code === 'ENOENT') {
+      return false;
+    }
+    throw error;
+  }
+}
+
+function assertSafeLinkName(linkName) {
+  if (!linkName || linkName.includes('/') || linkName.includes('\\') || linkName === '.' || linkName === '..') {
+    throw new Error('--link-name must be a plain file name inside the target directory.');
+  }
+}
+
+function assertPackageInsideTarget(sourceDist, targetDir) {
+  const relative = path.relative(targetDir, sourceDist);
+  if (relative.startsWith('..') || path.isAbsolute(relative)) {
+    throw new Error(`The package dist directory is outside the deploy target.
+
+Install the npm package inside the 1Panel site directory first, then run the local bin:
+
+  cd ${targetDir}
+  npm install pdf-master-landing@latest
+  npx pdfmaster-deploy --target .
+
+Package dist:
+  ${sourceDist}
+Deploy target:
+  ${targetDir}`);
+  }
+}
+
+async function deploy(options) {
+  if (!options.target) {
+    throw new Error('--target is required.');
+  }
+
+  assertSafeLinkName(options.linkName);
+
+  const rawSourceDist = path.join(packageRoot, 'dist');
+  const sourceIndex = path.join(rawSourceDist, 'index.html');
+  const rawTargetDir = path.resolve(options.target);
+
+  if (!(await pathExists(sourceIndex))) {
+    throw new Error(`Cannot find built landing files at ${rawSourceDist}. Run npm run build before packing or publishing.`);
+  }
+
+  if (!(await pathExists(rawTargetDir))) {
+    throw new Error(`Deploy target does not exist: ${rawTargetDir}`);
+  }
+
+  const sourceDist = await fs.realpath(rawSourceDist);
+  const targetDir = await fs.realpath(rawTargetDir);
+  const linkPath = path.join(targetDir, options.linkName);
+  const tempLinkPath = path.join(targetDir, `.${options.linkName}.next-${process.pid}-${Date.now()}`);
+  const relativeSource = path.relative(path.dirname(linkPath), sourceDist);
+  const symlinkType = process.platform === 'win32' ? 'junction' : 'dir';
+
+  assertPackageInsideTarget(sourceDist, targetDir);
+
+  console.log(`PDF Master landing deploy
+Target: ${targetDir}
+Source: ${sourceDist}
+Link:   ${linkPath} -> ${relativeSource}`);
+
+  if (options.dryRun) {
+    console.log('Dry run complete. No files were changed.');
+    return;
+  }
+
+  await fs.rm(tempLinkPath, { force: true, recursive: true });
+  await fs.symlink(relativeSource, tempLinkPath, symlinkType);
+  await fs.rm(linkPath, { force: true, recursive: true });
+  await fs.rename(tempLinkPath, linkPath);
+
+  console.log('Deploy complete.');
+}
+
+try {
+  const options = parseArgs(process.argv.slice(2));
+
+  if (options.help) {
+    printHelp();
+  } else {
+    await deploy(options);
+  }
+} catch (error) {
+  console.error(error instanceof Error ? error.message : error);
+  console.error('Run pdfmaster-deploy --help for usage.');
+  process.exitCode = 1;
+}