create-lumfall 1.0.1 → 1.1.1

package/templates/basic/app/pages/home/home.vue

@@ -1,164 +0,0 @@
-<template>
-  <main class="home-page">
-    <section class="hero">
-      <h1 class="hero-title">Lumfall Basic Project</h1>
-      <p class="hero-desc">
-        基于 lumfall 的基础业务项目骨架。这个页面演示了：页面入口约定、
-        $lumfallCurl 调用 /api 接口、参数校验与统一响应结构。
-      </p>
-      <div class="hero-links">
-        <a-button type="primary" @click="goHealth">健康检查页</a-button>
-        <a-button @click="loadData">刷新数据</a-button>
-      </div>
-    </section>
-
-    <a-card class="panel" title="服务端配置（GET /api/demo/info）">
-      <a-descriptions :column="1" size="medium" v-if="info">
-        <a-descriptions-item label="应用名">{{ info.appName }}</a-descriptions-item>
-        <a-descriptions-item label="demoMessage">
-          <a-tag color="arcoblue">{{ info.demoMessage }}</a-tag>
-        </a-descriptions-item>
-        <a-descriptions-item label="服务端时间">{{ info.serverTime }}</a-descriptions-item>
-      </a-descriptions>
-    </a-card>
-
-    <a-card class="panel" title="笔记列表（GET /api/demo/note/list）">
-      <template #extra>
-        <a-space>
-          <a-input-search
-            v-model="newNote"
-            placeholder="输入内容，回车新建笔记"
-            style="width: 260px"
-            @search="handleCreate"
-            allow-clear
-          />
-        </a-space>
-      </template>
-
-      <a-table
-        :data="noteList"
-        :loading="loading"
-        :pagination="pagination"
-        size="medium"
-      >
-        <template #columns>
-          <a-table-column title="ID" data-index="id" :width="80" />
-          <a-table-column title="内容" data-index="content" />
-          <a-table-column title="创建时间" data-index="createdAt" :width="200" />
-        </template>
-      </a-table>
-    </a-card>
-  </main>
-</template>
-
-<script setup>
-import { computed, onMounted, ref } from "vue";
-import { Message } from "@arco-design/web-vue";
-import $curl from "$lumfallCurl";
-
-const info = ref(null);
-const noteList = ref([]);
-const loading = ref(false);
-const newNote = ref("");
-const total = ref(0);
-const currentPage = ref(1);
-const pageSize = ref(10);
-
-const pagination = computed(() => ({
-  total: total.value,
-  current: currentPage.value,
-  pageSize: pageSize.value,
-  showTotal: true,
-}));
-
-async function loadInfo() {
-  const res = await $curl({ method: "get", url: "/api/demo/info" });
-  if (res && res.success) {
-    info.value = res.data;
-  }
-}
-
-async function loadNoteList() {
-  loading.value = true;
-  const res = await $curl({
-    method: "get",
-    url: "/api/demo/note/list",
-    query: {
-      page: String(currentPage.value),
-      pageSize: String(pageSize.value),
-    },
-  });
-  loading.value = false;
-  if (res && res.success) {
-    noteList.value = res.data;
-    total.value = res.metadata.total;
-  }
-}
-
-async function handleCreate() {
-  const content = newNote.value.trim();
-  if (!content) {
-    Message.warning("请输入笔记内容");
-    return;
-  }
-
-  const res = await $curl({
-    method: "post",
-    url: "/api/demo/note",
-    data: { content },
-  });
-  if (res && res.success) {
-    newNote.value = "";
-    Message.success("创建成功");
-    currentPage.value = 1;
-    await loadNoteList();
-  }
-}
-
-function loadData() {
-  loadInfo();
-  loadNoteList();
-}
-
-function goHealth() {
-  window.location.href = "/view/health";
-}
-
-onMounted(loadData);
-</script>
-
-<style lang="less" scoped>
-.home-page {
-  box-sizing: border-box;
-  max-width: 960px;
-  margin: 0 auto;
-  padding: 48px 24px 64px;
-
-  .hero {
-    margin-bottom: 32px;
-
-    .hero-title {
-      margin: 0 0 12px;
-      font-size: 32px;
-      font-weight: 700;
-      color: var(--color-text-1);
-    }
-
-    .hero-desc {
-      margin: 0 0 20px;
-      font-size: 15px;
-      line-height: 1.8;
-      color: var(--color-text-2);
-    }
-
-    .hero-links {
-      display: flex;
-      gap: 12px;
-    }
-  }
-
-  .panel {
-    margin-bottom: 20px;
-  }
-}
-</style>

package/templates/basic/app/router/demo.js

@@ -1,17 +0,0 @@
-// 路由只负责把 URL 绑到 controller 方法。
-// 注意绑定时要 .bind(controller)，否则方法内的 this 会丢失。
-module.exports = (app, router) => {
-  const { demo: demoController } = app.controllers;
-
-  router.get("/api/demo/info", demoController.getInfo.bind(demoController));
-
-  router.get(
-    "/api/demo/note/list",
-    demoController.getNoteList.bind(demoController)
-  );
-
-  router.post(
-    "/api/demo/note",
-    demoController.createNote.bind(demoController)
-  );
-};

package/templates/basic/app/router-schema/demo.js

@@ -1,29 +0,0 @@
-// API 参数校验：key 必须是已注册路由的 path，method 必须全小写，否则启动失败。
-// 只作用于 /api 开头的请求；校验失败返回 HTTP 200 + { success: false, code: 442 }。
-module.exports = {
-  "/api/demo/info": {
-    get: {},
-  },
-  "/api/demo/note/list": {
-    get: {
-      query: {
-        type: "object",
-        properties: {
-          page: { type: "string" },
-          pageSize: { type: "string" },
-        },
-      },
-    },
-  },
-  "/api/demo/note": {
-    post: {
-      body: {
-        type: "object",
-        properties: {
-          content: { type: "string", minLength: 1, maxLength: 200 },
-        },
-        required: ["content"],
-      },
-    },
-  },
-};

package/templates/basic/app/service/demo.js

@@ -1,51 +0,0 @@
-// 示例 service：演示「工厂返回 class、继承 BaseService」的约定。
-// 文件名 demo.js + 无子目录 → 挂载到 app.services.demo
-// 数据放在内存里，重启即清空；真实业务请换成数据库 / 远程服务调用。
-module.exports = (app) => {
-  const BaseService = require("lumfall").Service.Base(app);
-
-  // 内存数据池
-  const notePool = [
-    { id: 1, content: "第一条示例笔记：这是一个基于 lumfall 的基础项目骨架", createdAt: "2026-10-02 10:00:00" },
-    { id: 2, content: "在 app/service 下新建文件即可被自动加载", createdAt: "2026-10-02 10:01:00" },
-    { id: 3, content: "配置通过 config/config.<env>.js 按 _ENV 合并", createdAt: "2026-10-02 10:02:00" },
-  ];
-  let nextId = notePool.length + 1;
-
-  return class DemoService extends BaseService {
-    // 请求阶段读 this.config（= app.config）是安全的；
-    // 不要在工厂执行期或构造期读，那时 configLoader 还没跑
-    getInfo() {
-      return {
-        appName: this.config.name,
-        demoMessage: this.config.demoMessage,
-        serverTime: new Date().toISOString(),
-      };
-    }
-
-    /**
-     * 分页查询笔记
-     * @param {{ page: number, size: number }} param0
-     */
-    getNoteList({ page = 1, size = 10 }) {
-      const start = (page - 1) * size;
-      const data = notePool.slice(start, start + size).map((note) => ({ ...note }));
-
-      return { data, total: notePool.length, page, size };
-    }
-
-    /**
-     * 新建笔记
-     * @param {{ content: string }} param0
-     */
-    createNote({ content }) {
-      const note = {
-        id: nextId++,
-        content,
-        createdAt: new Date().toISOString().slice(0, 19).replace("T", " "),
-      };
-      notePool.unshift(note);
-      return note;
-    }
-  };
-};

package/templates/basic/app/webpack.config.js

@@ -1,4 +0,0 @@
-// 业务 Webpack 扩展配置：与框架基础配置 webpack-merge.merge.smart 合并。
-// 例如给 .md 文件加 raw 导入：
-//   module.exports = { module: { rules: [{ test: /\.md$/, type: "asset/source" }] } };
-module.exports = {};

package/templates/basic/build.js

@@ -1,7 +0,0 @@
-const { frontendBuild } = require("lumfall");
-
-// 环境由 _ENV 决定（不是 NODE_ENV）：
-//   _ENV=local  启动 Webpack dev server（HMR 热更新，默认 127.0.0.1:9002）
-//   _ENV=prod   产物构建到 app/public/dist/prod/，同时产出各页面 .tpl 模板
-// 其他值（如 beta）不执行任何构建
-frontendBuild(process.env._ENV);

package/templates/basic/config/config.beta.js

@@ -1,4 +0,0 @@
-// _ENV=beta 时加载，覆盖 config.default.js 的同名键（浅合并）
-module.exports = {
-  demoMessage: "hello from beta config",
-};

package/templates/basic/config/config.default.js

@@ -1,32 +0,0 @@
-// 所有环境共享的基础配置。合并顺序（后者覆盖前者同名键）：
-//   框架 config.default -> 业务 config.default -> 框架 config.<env> -> 业务 config.<env>
-// 环境由 _ENV 决定（local / beta / prod，缺省 local），不是 NODE_ENV。
-module.exports = {
-  // 应用名，与 server.js 的 name 保持一致
-  name: "lumfall-basic-project",
-
-  // API 路径前缀约定：框架的参数校验（apiParamsVerify）与安全策略（securityPolicy）
-  // 只作用于 /api 开头的请求
-  apiBasePath: "/api",
-
-  // 示例配置：演示「配置如何从服务端流动到接口/页面」，各环境文件里都有同名键
-  demoMessage: "hello from config.default",
-
-  // 安全策略（可选）。不配置这段时，框架等价于「接口签名关闭 + projectKey 开启」
-  security: {
-    // 接口签名校验：开启后 /api 请求必须携带 s_sign = md5(secret + "_" + st)、
-    // st = 毫秒时间戳（前端 $lumfallCurl 默认带的是 s_sign / s_t，均可识别），
-    // 时间差超过 maxAgeMs 或时间戳在未来都会返回 code 445。
-    // 生产开启时 secret 建议走环境变量 / 配置中心，不要提交到仓库。
-    apiSignature: {
-      enabled: false,
-      maxAgeMs: 600000,
-    },
-    // project_key 校验：只作用于 /api/project/ 路径，缺 header 返回 code 446。
-    // /api/project/model_list、/api/project/list 内置豁免，可用 freePaths 追加。
-    projectKey: {
-      enabled: true,
-      headerName: "project_key",
-    },
-  },
-};

package/templates/basic/config/config.local.js

@@ -1,4 +0,0 @@
-// _ENV=local 时加载，覆盖 config.default.js 的同名键（浅合并）
-module.exports = {
-  demoMessage: "hello from local config",
-};

package/templates/basic/config/config.prod.js

@@ -1,6 +0,0 @@
-// _ENV=prod 时加载，覆盖 config.default.js 的同名键（浅合并）。
-// 生产相关的密钥、连接串建议从环境变量读取：
-//   module.exports = { dbPassword: process.env.DB_PASSWORD };
-module.exports = {
-  demoMessage: "hello from prod config",
-};

package/templates/basic/package.json

@@ -1,31 +0,0 @@
-{
-  "name": "lumfall-basic-project",
-  "version": "1.0.0",
-  "description": "基于 lumfall 的基础业务项目骨架：目录约定、示例 API 与示例页面，开箱即用",
-  "main": "server.js",
-  "scripts": {
-    "dev": "_ENV='local' nodemon --exitcrash server.js",
-    "beta": "_ENV='beta' nodemon --exitcrash server.js",
-    "prod": "_ENV='prod' node server.js",
-    "build:dev": "_ENV='local' node --max_old_space_size=4096 ./build.js",
-    "build:prod": "_ENV='prod' node ./build.js",
-    "start:dev": "concurrently --kill-others-on-fail -n webpack,server -c cyan,green \"pnpm build:dev\" \"pnpm dev\"",
-    "start:prod": "pnpm build:prod && pnpm prod",
-    "new-page": "node ./node_modules/lumfall/scripts/generate-page.js"
-  },
-  "dependencies": {
-    "lumfall": "^1.2.1"
-  },
-  "devDependencies": {
-    "concurrently": "^10.0.5",
-    "nodemon": "^3.1.14"
-  },
-  "packageManager": "pnpm@10.30.0",
-  "keywords": [
-    "lumfall",
-    "koa",
-    "vue",
-    "fullstack"
-  ],
-  "license": "ISC"
-}

package/templates/basic/server.js

@@ -1,26 +0,0 @@
-const { serviceStart } = require("lumfall");
-
-const app = serviceStart({
-  // 应用名：渲染页面模板 <title> 时使用
-  name: "lumfall-basic-project",
-
-  // 未命中任何路由时的 302 兜底目标。
-  // 注意：serviceStart 一旦传入 options 对象，就不再套用框架默认值，
-  // homePath 必须在这里显式声明，否则兜底重定向会退化为 "/"
-  homePath: "/view/home",
-
-  // 可选：配置强校验。传入 JSON Schema，合并后的配置不匹配会直接启动失败
-  // configSchema: require("./config/config.schema.js"),
-
-  // 可选：启动 / 停止 hook（beforeStart / beforeRouteLoad / afterRouteLoad /
-  // afterStart / onError / beforeStop / afterStop），启动期 hook 必须同步
-  // lifecycle: {},
-
-  // 可选：插件（数据库、缓存等先于业务中间件/路由初始化的能力）
-  // plugins: [],
-
-  // 可选：请求级观测 hook（traceId / onRequestStart / onRequestEnd / onRequestError）
-  // monitoring: {},
-});
-
-module.exports = app;

package/templates/document/README.md

@@ -1,58 +0,0 @@
-# lumfall-document（空模板）
-
-基于 [lumfall](https://www.npmjs.com/package/lumfall) 的技术文档站**空模板**：
-导航、侧边栏、页面目录（TOC）、站内搜索（Ctrl/Cmd+K）、代码高亮与复制、
-亮 / 暗主题、上一篇/下一篇、移动端适配全部就绪，生成后只需要写内容。
-
-> 这个分支（`template/empty`）是 create-lumfall 脚手架 `document` 模板的来源；
-> `main` 分支是自举的完整示例（内置 lumfall 技术文档）。
-
-## 开始
-
-```sh
-pnpm install
-pnpm start:dev                # http://localhost:3000/view/docs
-
-pnpm build:static             # 产出 dist-static/（Vercel 等静态托管可直接部署）
-```
-
-## 写内容
-
-1. **内容**：`docs/` 下的 markdown 就是文档，目录结构随意（两级以内体验最佳）。
-   文档里可以互相引用，支持相对链接与锚点：
-   ```markdown
-   [其他页](./other.md)  [上级目录](../advanced/x.md)  [某节](./other.md#锚点)
-   ```
-2. **站点配置**：`app/pages/docs/docs-config.js` 是唯一需要动的配置文件——
-   站点名、导航、侧栏分组、首页 hero、页脚。侧栏条目的 `path` 对应
-   `docs/` 下的文件路径（`/view/docs/<path>` ↔ `docs/<path>.md`）
-3. **可选**：改主题色（`app/pages/docs/styles/vars.less` 的 `--doc-brand`
-   等变量）、换 logo（`app/pages/docs/assets/docs-logo.svg`）
-
-## 功能清单
-
-| 功能 | 说明 |
-| --- | --- |
-| 首页 hero | 大标题 + 标语 + 按钮 + 特性卡片（配置驱动） |
-| 侧边栏 | 分组导航，当前页高亮，移动端抽屉 |
-| 页面目录 | 正文右侧 TOC，滚动联动高亮（<1280px 隐藏） |
-| 站内搜索 | `Ctrl/Cmd + K` 或 `/` 唤起；标题 / 小节 / 正文加权匹配，关键词高亮摘要，键盘导航 |
-| 代码块 | highlight.js 按需注册语言、语言标签、一键复制、亮暗配色 |
-| markdown 扩展 | `::: tip / info / warning / danger <可选标题>` 提示块、标题锚点、外链新窗口 |
-| 主题 | 亮 / 暗（右上角切换），首次进站跟随系统，localStorage 记忆 |
-| 上一篇/下一篇 | 按侧边栏顺序自动生成 |
-| 静态部署 | `pnpm build:static` 一键产出 `dist-static/`（vercel.json rewrite + 长缓存） |
-
-## 写作约定
-
-- 每篇文档以 `# 一级标题` 开头（渲染为页面标题），章节用 `##` / `###`
-  （自动进入右侧 TOC 与搜索索引）
-- 代码块标注语言（`js` / `vue` / `bash` / `json`…）才会高亮
-- 不支持数学公式、mermaid 图（markdown-it 未接插件，需要时可在
-  `app/pages/docs/markdown/index.js` 扩展）
-
-## 相关项目
-
-- `lumfall-basic-project/`：基础业务工程骨架
-- `lumfall-business/`：B 端全栈模板
-- `create-lumfall/`：应用脚手架（本模板通过它的 `-t document` 生成）

package/templates/document/app/extend/README.md

@@ -1,6 +0,0 @@
-// 扩展点目录：每个文件导出 (app) => object，返回值直接挂到 app 上。
-// 例如注册业务健康探针（文档站默认没有外部依赖，无需探针）：
-//   module.exports = (app) => {
-//     app.health.register("database", async () => { /* ping */ });
-//     return {};
-//   };

package/templates/document/app/middleware/README.md

@@ -1,2 +0,0 @@
-// 可复用中间件目录：每个文件导出 (app) => (ctx, next) => {}，
-// 自动挂载到 app.middlewares.<目录名>.<文件名>（kebab/snake-case 自动转 camelCase）。

package/templates/document/app/middleware.js

@@ -1,2 +0,0 @@
-// 业务全局中间件注册入口。文档站是纯静态站点，默认不需要额外中间件。
-module.exports = (app) => {};

package/templates/document/app/pages/docs/assets/docs-logo.svg

@@ -1,5 +0,0 @@
-<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 32 32">
-  <rect x="2" y="2" width="28" height="28" rx="7" fill="#165dff"/>
-  <path d="M10 9v11a3 3 0 0 0 3 3h9v-2h-9a1 1 0 0 1-1-1V9h-2z" fill="#fff"/>
-  <path d="M13 9h9a1 1 0 0 1 1 1v8h-8a2 2 0 0 0-2 2V9z" fill="#9fd4ff"/>
-</svg>

package/templates/document/app/pages/docs/components/doc-layout.vue

@@ -1,144 +0,0 @@
-<template>
-  <div class="doc-shell">
-    <DocNavbar
-      :show-sidebar-toggle="sidebar"
-      @toggle-sidebar="drawerOpen = !drawerOpen"
-      @open-search="searchOpen = true"
-    />
-
-    <div class="doc-body" @click="handleBodyClick">
-      <DocSidebar v-if="sidebar" class="doc-desktop-sidebar" />
-
-      <!-- 移动端抽屉侧栏 -->
-      <Transition name="doc-fade">
-        <div v-if="sidebar && drawerOpen" class="doc-drawer-mask" @click.self="drawerOpen = false">
-          <DocSidebar class="doc-drawer-sidebar" @navigate="drawerOpen = false" />
-        </div>
-      </Transition>
-
-      <main class="doc-main">
-        <slot />
-      </main>
-    </div>
-
-    <DocSearch v-model="searchOpen" />
-  </div>
-</template>
-
-<script setup>
-import { onBeforeUnmount, onMounted, ref, watch } from "vue";
-import { useRoute, useRouter } from "vue-router";
-import DocNavbar from "./doc-navbar.vue";
-import DocSidebar from "./doc-sidebar.vue";
-import DocSearch from "./doc-search.vue";
-
-defineProps({
-  // 是否显示侧栏（首页不显示）
-  sidebar: { type: Boolean, default: true },
-});
-
-const route = useRoute();
-const router = useRouter();
-const drawerOpen = ref(false);
-const searchOpen = ref(false);
-
-// 路由切换时收起移动端抽屉
-watch(
-  () => route.fullPath,
-  () => {
-    drawerOpen.value = false;
-  }
-);
-
-// ---- 全局点击处理：复制代码 / 站内路由 / 锚点平滑滚动 ----
-const copyText = (text) => {
-  if (navigator.clipboard && window.isSecureContext) {
-    navigator.clipboard.writeText(text);
-    return;
-  }
-  // 非安全上下文（http 部署）回退方案
-  const textarea = document.createElement("textarea");
-  textarea.value = text;
-  textarea.style.position = "fixed";
-  textarea.style.opacity = "0";
-  document.body.appendChild(textarea);
-  textarea.select();
-  try {
-    document.execCommand("copy");
-  } catch (err) {
-    // 忽略复制失败
-  }
-  document.body.removeChild(textarea);
-};
-
-const handleBodyClick = (e) => {
-  // 1. 代码块复制按钮
-  const copyBtn = e.target.closest(".doc-code-copy");
-  if (copyBtn) {
-    const block = copyBtn.closest(".doc-code-block");
-    const pre = block && block.querySelector("pre");
-    if (pre) {
-      copyText(pre.textContent || "");
-      copyBtn.textContent = "已复制";
-      setTimeout(() => {
-        copyBtn.textContent = "复制";
-      }, 1500);
-    }
-    return;
-  }
-
-  // 2. 站内文档链接走 SPA 路由，避免整页刷新
-  const link = e.target.closest("a");
-  if (!link) {
-    return;
-  }
-  const href = link.getAttribute("href") || "";
-
-  if (href.startsWith("/view/docs")) {
-    e.preventDefault();
-    router.push(href);
-    return;
-  }
-
-  // 3. 页内锚点：平滑滚动，滚动结束后再更新 URL。
-  //    注意：带 fragment 的 history.replaceState 会取消 Chrome 正在进行的
-  //    平滑滚动（无论先后调用），所以必须等 scrollend 之后再写 URL。
-  if (href.startsWith("#") && href.length > 1) {
-    const target = document.getElementById(decodeURIComponent(href.slice(1)));
-    if (target) {
-      e.preventDefault();
-      let urlUpdated = false;
-      const updateUrl = () => {
-        if (urlUpdated) return;
-        urlUpdated = true;
-        history.replaceState(null, "", href);
-      };
-      target.scrollIntoView({ behavior: "smooth" });
-      // 平滑滚动结束（scrollend 支持前用定时器兜底；目标已在视口内时不会滚动）
-      window.addEventListener("scrollend", updateUrl, { once: true });
-      setTimeout(updateUrl, 800);
-    }
-  }
-};
-
-// 全局快捷键：Ctrl/Cmd + K 或 / 唤起搜索（输入框内按 / 不触发）
-const onGlobalKeydown = (e) => {
-  const isCtrlK = (e.ctrlKey || e.metaKey) && e.key.toLowerCase() === "k";
-  const isSlash =
-    e.key === "/" &&
-    !["INPUT", "TEXTAREA"].includes(e.target.tagName) &&
-    !e.target.isContentEditable;
-  if (isCtrlK || isSlash) {
-    e.preventDefault();
-    searchOpen.value = true;
-  }
-};
-
-onMounted(() => {
-  window.addEventListener("keydown", onGlobalKeydown);
-});
-
-onBeforeUnmount(() => {
-  window.removeEventListener("keydown", onGlobalKeydown);
-});
-</script>