adspecs 0.1.19 → 0.1.21

package/src/lib/readme-gen.js

@@ -1,143 +1,143 @@
-'use strict';
-
-/**
- * README.md 模板生成
- *
- * 与 project-init SKILL.md 中定义的 README.md 模板格式保持一致。
- */
-
-const TODAY = new Date().toISOString().slice(0, 10);
-
-/**
- * 生成标准 README.md 内容
- *
- * @param {object} opts
- * @param {string} opts.title - 目录名称（作为 H1）
- * @param {string} opts.purpose - 用途说明
- * @param {Array<{name: string, desc: string}>} [opts.subdirs] - 子目录说明列表
- * @param {string} [opts.namingConvention] - 文件命名规范
- * @param {string} [opts.date] - 修订日期（默认今天）
- * @returns {string}
- */
-function generateReadme({ title, purpose, subdirs = [], namingConvention = '', date = TODAY }) {
-  const lines = [`# ${title}`, '', purpose, ''];
-
-  if (subdirs.length > 0) {
-    lines.push('## 目录说明', '', '| 子目录 | 说明 |', '| --- | --- |');
-    for (const sub of subdirs) {
-      lines.push(`| ${sub.name} | ${sub.desc} |`);
-    }
-    lines.push('');
-  }
-
-  if (namingConvention) {
-    lines.push('## 文件命名规范', '', namingConvention, '');
-  }
-
-  lines.push(
-    '## 修订记录',
-    '',
-    '| 日期 | 版本 | 修改内容 | 修改人 |',
-    '| --- | --- | --- | --- |',
-    `| ${date} | 1.0 | 初始创建 | system |`,
-    ''
-  );
-
-  return lines.join('\n');
-}
-
-/**
- * 各 docs 子目录的 README 元数据
- */
-const DOCS_READMES = {
-  '00-planning': {
-    title: '00-planning',
-    purpose: '规划阶段文档，存放平台级规划产物（业务场景、子模块依赖关系、统一数据模型等）。',
-    namingConvention: '`{seq}-{name}.md`（如 `01-smom-wms_business_architecture.md`）',
-  },
-  '00-customer-requirements': {
-    title: '00-customer-requirements',
-    purpose: '客户需求文档，存放客户原始需求、会议纪要、需求沟通记录。',
-    subdirs: [{ name: 'crm/', desc: 'CRM 模块客户需求' }],
-  },
-  '10-architecture': {
-    title: '10-architecture',
-    purpose: '架构文档，系统架构设计、模块依赖关系、统一数据模型。',
-    namingConvention: '`{seq}-{name}.md`（如 `01-smom-wms_business_architecture.md`）',
-  },
-  '20-prd': {
-    title: '20-prd',
-    purpose: 'PRD 文档，产品需求说明书。',
-    subdirs: [{ name: 'crm/', desc: 'CRM 模块 PRD' }],
-    namingConvention: '`{module-code}-{module-name}/` 下存放',
-  },
-  '30-system-design': {
-    title: '30-system-design',
-    purpose: '系统设计，后端系统设计、SQL Schema、前端设计、TDD 任务清单。',
-    subdirs: [{ name: 'crm/', desc: 'CRM 模块系统设计' }],
-    namingConvention:
-      '`{module-code}-{module-name}_system-design.md`、`{module-code}-{module-name}_schema.sql`',
-  },
-  '40-project_conventions': {
-    title: '40-project_conventions',
-    purpose: '项目约定，前后端集成开发规范和接口约定。',
-    subdirs: [
-      { name: 'frontend-standard/', desc: '前端约定（按技术栈来源不同）' },
-      { name: 'end-standard/', desc: '后端约定（仅轻量模式复制 Python 后端规范）' },
-    ],
-  },
-  '70-scripts': {
-    title: '70-scripts',
-    purpose: '脚本，部署脚本和工具脚本。',
-    subdirs: [{ name: 'depoly/', desc: '部署相关脚本' }],
-  },
-  '80-development': {
-    title: '80-development',
-    purpose: '开发产物，开发工件和测试工件归档。',
-    subdirs: [
-      { name: '800-log/', desc: '开发日志，AI 会话记录和开发历史追踪' },
-      { name: '801-dev/', desc: '开发工件' },
-      { name: '802-test/', desc: '测试工件' },
-    ],
-    namingConvention: '`{YYYYMMDD}_{主题}.md` 或 `{YYYYMMDD_HHmmss}_{主题}.md`',
-  },
-  '100-help': {
-    title: '100-help',
-    purpose: '帮助文档，使用手册和参考指南。',
-  },
-  '300-specs': {
-    title: '300-specs',
-    purpose: '功能规格说明书。',
-    namingConvention: '`p{module}-{seq}_{name}_spec.md`，配套 `p{module}-{seq}_{name}_sim-data.md`',
-  },
-};
-
-/**
- * 生成 wiki/README.md
- */
-function generateWikiReadme(date = TODAY) {
-  return generateReadme({
-    title: 'wiki',
-    purpose:
-      '基线文件目录，用于存放项目级别的基线规格文件，包括功能规格、接口规格、数据规格等。',
-    subdirs: [{ name: '（按需创建）', desc: '按模块或主题组织基线文件' }],
-    namingConvention: '`{module}-{name}_spec.md`',
-    date,
-  });
-}
-
-/**
- * 生成 service/README.md
- */
-function generateServiceReadme() {
-  return (
-    '这是后端服务模块放置目录，在完成技术架构设计后，所有后端服务模块的源代码将放置在此目录下。\n'
-  );
-}
-
-module.exports = {
-  generateReadme,
-  generateWikiReadme,
-  generateServiceReadme,
-  DOCS_READMES,
-};
+'use strict';
+
+/**
+ * README.md 模板生成
+ *
+ * 与 project-init SKILL.md 中定义的 README.md 模板格式保持一致。
+ */
+
+const TODAY = new Date().toISOString().slice(0, 10);
+
+/**
+ * 生成标准 README.md 内容
+ *
+ * @param {object} opts
+ * @param {string} opts.title - 目录名称（作为 H1）
+ * @param {string} opts.purpose - 用途说明
+ * @param {Array<{name: string, desc: string}>} [opts.subdirs] - 子目录说明列表
+ * @param {string} [opts.namingConvention] - 文件命名规范
+ * @param {string} [opts.date] - 修订日期（默认今天）
+ * @returns {string}
+ */
+function generateReadme({ title, purpose, subdirs = [], namingConvention = '', date = TODAY }) {
+  const lines = [`# ${title}`, '', purpose, ''];
+
+  if (subdirs.length > 0) {
+    lines.push('## 目录说明', '', '| 子目录 | 说明 |', '| --- | --- |');
+    for (const sub of subdirs) {
+      lines.push(`| ${sub.name} | ${sub.desc} |`);
+    }
+    lines.push('');
+  }
+
+  if (namingConvention) {
+    lines.push('## 文件命名规范', '', namingConvention, '');
+  }
+
+  lines.push(
+    '## 修订记录',
+    '',
+    '| 日期 | 版本 | 修改内容 | 修改人 |',
+    '| --- | --- | --- | --- |',
+    `| ${date} | 1.0 | 初始创建 | system |`,
+    ''
+  );
+
+  return lines.join('\n');
+}
+
+/**
+ * 各 docs 子目录的 README 元数据
+ */
+const DOCS_READMES = {
+  '00-planning': {
+    title: '00-planning',
+    purpose: '规划阶段文档，存放平台级规划产物（业务场景、子模块依赖关系、统一数据模型等）。',
+    namingConvention: '`{seq}-{name}.md`（如 `01-smom-wms_business_architecture.md`）',
+  },
+  '00-customer-requirements': {
+    title: '00-customer-requirements',
+    purpose: '客户需求文档，存放客户原始需求、会议纪要、需求沟通记录。',
+    subdirs: [{ name: 'crm/', desc: 'CRM 模块客户需求' }],
+  },
+  '10-architecture': {
+    title: '10-architecture',
+    purpose: '架构文档，系统架构设计、模块依赖关系、统一数据模型。',
+    namingConvention: '`{seq}-{name}.md`（如 `01-smom-wms_business_architecture.md`）',
+  },
+  '20-prd': {
+    title: '20-prd',
+    purpose: 'PRD 文档，产品需求说明书。',
+    subdirs: [{ name: 'crm/', desc: 'CRM 模块 PRD' }],
+    namingConvention: '`{module-code}-{module-name}/` 下存放',
+  },
+  '30-system-design': {
+    title: '30-system-design',
+    purpose: '系统设计，后端系统设计、SQL Schema、前端设计、TDD 任务清单。',
+    subdirs: [{ name: 'crm/', desc: 'CRM 模块系统设计' }],
+    namingConvention:
+      '`{module-code}-{module-name}_system-design.md`、`{module-code}-{module-name}_schema.sql`',
+  },
+  '40-project_conventions': {
+    title: '40-project_conventions',
+    purpose: '项目约定，前后端集成开发规范和接口约定。',
+    subdirs: [
+      { name: 'frontend-standard/', desc: '前端约定（按技术栈来源不同）' },
+      { name: 'end-standard/', desc: '后端约定（仅轻量模式复制 Python 后端规范）' },
+    ],
+  },
+  '70-scripts': {
+    title: '70-scripts',
+    purpose: '脚本，部署脚本和工具脚本。',
+    subdirs: [{ name: 'depoly/', desc: '部署相关脚本' }],
+  },
+  '80-development': {
+    title: '80-development',
+    purpose: '开发产物，开发工件和测试工件归档。',
+    subdirs: [
+      { name: '800-log/', desc: '开发日志，AI 会话记录和开发历史追踪' },
+      { name: '801-dev/', desc: '开发工件' },
+      { name: '802-test/', desc: '测试工件' },
+    ],
+    namingConvention: '`{YYYYMMDD}_{主题}.md` 或 `{YYYYMMDD_HHmmss}_{主题}.md`',
+  },
+  '100-help': {
+    title: '100-help',
+    purpose: '帮助文档，使用手册和参考指南。',
+  },
+  '300-specs': {
+    title: '300-specs',
+    purpose: '功能规格说明书。',
+    namingConvention: '`p{module}-{seq}_{name}_spec.md`，配套 `p{module}-{seq}_{name}_sim-data.md`',
+  },
+};
+
+/**
+ * 生成 wiki/README.md
+ */
+function generateWikiReadme(date = TODAY) {
+  return generateReadme({
+    title: 'wiki',
+    purpose:
+      '基线文件目录，用于存放项目级别的基线规格文件，包括功能规格、接口规格、数据规格等。',
+    subdirs: [{ name: '（按需创建）', desc: '按模块或主题组织基线文件' }],
+    namingConvention: '`{module}-{name}_spec.md`',
+    date,
+  });
+}
+
+/**
+ * 生成 service/README.md
+ */
+function generateServiceReadme() {
+  return (
+    '这是后端服务模块放置目录，在完成技术架构设计后，所有后端服务模块的源代码将放置在此目录下。\n'
+  );
+}
+
+module.exports = {
+  generateReadme,
+  generateWikiReadme,
+  generateServiceReadme,
+  DOCS_READMES,
+};