cloudcc-cli 2.3.8 → 2.4.0

package/src/fields/fields/Q.js

@@ -1,35 +1,65 @@
 /**
- * 选项列表（多选）字段(Q)配置模板
+ * 选项列表（多选）字段(Q)配置模板（与 `L` 类似，另含 `visibleLines`、`showalloptions`）
+ * @param {string} useGlobalSelect 是否使用全局选项列表：`"0"` 否，`"1"` 是
+ * @param {string} edittype 选择样式，写入 `obj.edittype`：`radio` 或 `select`（多选常见为 `select`）
+ * @param {string} isPicklistSorted 是否按字母排序：`"0"` 否，`"1"` 是
+ * @param {string} defPl 是否将第一个值作为默认值：`"0"` 否，`"1"` 是
+ * @param {string} globalSelectId 全局选项列表 id（`useGlobalSelect` 为 `"1"` 时使用）
+ * @param {string} visibleLines 下拉最多展示几行选项，写入 `obj.visibleLines`
+ * @param {string} showalloptions 是否显示所有选项：`"0"` 否，`"1"` 是，写入 `obj.showalloptions`
  */
-module.exports = function (objid, nameLabel, apiname, ptext, profileList) {
+module.exports = function (
+    objid,
+    nameLabel,
+    apiname,
+    ptext,
+    helps = "",
+    defaultValue = "",
+    profileList,
+    useGlobalSelect = "0",
+    edittype = "select",
+    isPicklistSorted = "0",
+    defPl = "0",
+    globalSelectId = "",
+    visibleLines = "4",
+    showalloptions = "0"
+) {
+    const ugs = useGlobalSelect === "1" ? "1" : "0";
+    const et = edittype === "radio" ? "radio" : "select";
+    const sorted = isPicklistSorted === "1" ? "1" : "0";
+    const dp = defPl === "1" ? "1" : "0";
+    const gid = ugs === "1" ? String(globalSelectId || "").trim() : "";
+    const vl = String(visibleLines || "4").trim() || "4";
+    const sao = showalloptions === "1" ? "1" : "0";
     return {
-        "objid": objid,
         "obj": {
             "id": "",
             "nameLabel": nameLabel,
             "apiname": apiname,
             "schemefieldLength": "255",
-            "edittype": "select",
-            "visibleLines": "4",
-            "showalloptions": "0",
+            "edittype": et,
+            "visibleLines": vl,
+            "showalloptions": sao,
             "renderstyle": "1",
             "remark": "",
-            "helps": ""
+            "helps": helps !== undefined && helps !== null ? String(helps) : "",
+            "defaultValue": defaultValue !== undefined && defaultValue !== null ? String(defaultValue) : ""
         },
+        "objid": objid,
         "dtype": "Q:选项列表（多选）",
         "fdtype": "Q",
         "ischecked": "false",
-        "useGlobalSelect": "0",
-        "globalSelectId": "province",
+        "useGlobalSelect": ugs,
+        "globalSelectId": gid,
         "ptext": ptext,
-        "isPicklistSorted": "0",
-        "defPl": "1",
+        "isPicklistSorted": sorted,
+        "defPl": dp,
         "iscover": "",
         "formulaText": "",
         "profileFieldJson": profileList.map(profile => ({
             "profileId": profile.id,
             "visible": "true",
             "readonly": "false"
-        })),
+        }))
     }
 }

package/src/fields/fields/S.js

@@ -1,7 +1,19 @@
 /**
  * 文本字段(S)配置模板
  */
-module.exports = function (objid, nameLabel, apiname, profileList) {
+module.exports = function (
+    objid,
+    nameLabel,
+    apiname,
+    schemefieldLength,
+    helps,
+    isrepeat,
+    casesensitive,
+    placeholder,
+    defaultValue,
+    profileList
+) {
+    const length = schemefieldLength ? String(schemefieldLength) : "255";
     return {
         "objid": objid,
         "obj": {
@@ -9,12 +21,12 @@ module.exports = function (objid, nameLabel, apiname, profileList) {
             "nameLabel": nameLabel,
             "apiname": apiname,
             "remark": "",
-            "helps": "",
-            "schemefieldLength": "255",
-            "isrepeat": "true",
-            "casesensitive": "",
-            "placeholder": "",
-            "defaultValue": ""
+            "helps": helps ? String(helps) : "",
+            "schemefieldLength": length,
+            "isrepeat": isrepeat !== undefined ? String(isrepeat) : "true",
+            "casesensitive": casesensitive ? String(casesensitive) : "",
+            "placeholder": placeholder ? String(placeholder) : "",
+            "defaultValue": defaultValue ? String(defaultValue) : ""
         },
         "dtype": "S:文本",
         "fdtype": "S",

package/src/fields/fields/SCORE.js

@@ -1,7 +1,12 @@
 /**
  * 评分字段(SCORE)配置模板
+ * schemefieldLength：最大评分，控制星星图标个数；平台允许 1～100，默认 10
  */
-module.exports = function (objid, nameLabel, apiname, profileList) {
+module.exports = function (objid, nameLabel, apiname, helps = "", defaultValue = "", schemefieldLength = "10", profileList) {
+    const len =
+        schemefieldLength !== undefined && schemefieldLength !== null && String(schemefieldLength).trim() !== ""
+            ? String(schemefieldLength).trim()
+            : "10";
     return {
         "objid": objid,
         "obj": {
@@ -9,9 +14,9 @@ module.exports = function (objid, nameLabel, apiname, profileList) {
             "nameLabel": nameLabel,
             "apiname": apiname,
             "remark": "",
-            "helps": "",
-            "schemefieldLength": "10",
-            "defaultValue": ""
+            "helps": helps !== undefined && helps !== null ? String(helps) : "",
+            "schemefieldLength": len,
+            "defaultValue": defaultValue !== undefined && defaultValue !== null ? String(defaultValue) : ""
         },
         "dtype": "SCORE:评分",
         "fdtype": "SCORE",

package/src/fields/fields/T.js

@@ -1,17 +1,17 @@
 /**
  * 时间字段(T)配置模板
  */
-module.exports = function (objid, nameLabel, apiname, profileList) {
+module.exports = function (objid, nameLabel, apiname, helps = "", defaultValue = "", profileList) {
     return {
         "objid": objid,
         "obj": {
             "id": "",
             "nameLabel": nameLabel,
             "apiname": apiname,
-            "schemefieldLength": "255",
             "remark": "",
-            "helps": "",
-            "defaultValue": ""
+            "helps": helps !== undefined && helps !== null ? String(helps) : "",
+            "schemefieldLength": "20",
+            "defaultValue": defaultValue !== undefined && defaultValue !== null ? String(defaultValue) : ""
         },
         "dtype": "T:时间",
         "fdtype": "T",

package/src/fields/fields/U.js

@@ -1,18 +1,31 @@
 /**
  * URL字段(U)配置模板
  */
-module.exports = function (objid, nameLabel, apiname, profileList) {
+module.exports = function (objid, nameLabel, apiname, helps, edittype, defaultValue, profileList) {
+    const openMode = edittype && String(edittype).trim() !== ""
+        ? String(edittype).trim()
+        : "_blank";
+    const safeEdittype = openMode === "_self" ? "_self" : "_blank";
     return {
+        // 对象ID
         "objid": objid,
         "obj": {
+            // 字段ID
             "id": "",
+            // 字段名称
             "nameLabel": nameLabel,
+            // 字段API名称
             "apiname": apiname,
+            // 字段备注
             "remark": "",
-            "helps": "",
-            "edittype": "_blank",
-            "schemefieldLength": "255",
-            "defaultValue": ""
+            // 字段帮助
+            "helps": helps !== undefined && helps !== null ? String(helps) : "",
+            // 最大输入长度（字符）
+            "schemefieldLength": "2000",
+            // URL打开方式: _blank 新窗口打开, _self 当前窗口打开
+            "edittype": safeEdittype,
+            // 默认值
+            "defaultValue": defaultValue !== undefined && defaultValue !== null ? String(defaultValue) : ""
         },
         "dtype": "U:URL",
         "fdtype": "U",

package/src/fields/fields/X.js

@@ -1,7 +1,21 @@
 /**
- * 文本区字段(X)配置模板
+ * 文本区字段(X)配置模板（多行文本，schemefieldLength 为最大字符数，常见上限 4000）
  */
-module.exports = function (objid, nameLabel, apiname, profileList) {
+module.exports = function (
+    objid,
+    nameLabel,
+    apiname,
+    helps = "",
+    defaultValue = "",
+    schemefieldLength = "4000",
+    placeholder = "",
+    profileList
+) {
+    const len =
+        schemefieldLength !== undefined && schemefieldLength !== null && String(schemefieldLength).trim() !== ""
+            ? String(schemefieldLength).trim()
+            : "4000";
+    const ph = placeholder !== undefined && placeholder !== null ? String(placeholder) : "";
     return {
         "objid": objid,
         "obj": {
@@ -9,10 +23,10 @@ module.exports = function (objid, nameLabel, apiname, profileList) {
             "nameLabel": nameLabel,
             "apiname": apiname,
             "remark": "",
-            "helps": "",
-            "defaultValue": "",
-            "schemefieldLength": "255",
-            "placeholder": ""
+            "helps": helps !== undefined && helps !== null ? String(helps) : "",
+            "defaultValue": defaultValue !== undefined && defaultValue !== null ? String(defaultValue) : "",
+            "schemefieldLength": len,
+            "placeholder": ph
         },
         "dtype": "X",
         "fdtype": "X",

package/src/fields/fields/Y.js

@@ -1,7 +1,21 @@
 /**
  * 查找关系字段(Y)配置模板
+ * @param {string} lookupObjDefaultField 搜索辅助字段（`obj.lookupObjDefaultField`）；搜索时用于展示，可为 API 名字段等
  */
-module.exports = function (objid, nameLabel, apiname, lookupObj, profileList) {
+module.exports = function (
+    objid,
+    nameLabel,
+    apiname,
+    lookupObj,
+    helps = "",
+    defaultValue = "",
+    profileList,
+    lookupObjDefaultField = ""
+) {
+    const ldf =
+        lookupObjDefaultField !== undefined && lookupObjDefaultField !== null
+            ? String(lookupObjDefaultField).trim()
+            : "";
     return {
         "objid": objid,
         "obj": {
@@ -10,11 +24,10 @@ module.exports = function (objid, nameLabel, apiname, lookupObj, profileList) {
             "apiname": apiname,
             "schemefieldLength": "255",
             "remark": "",
-            "helps": "",
+            "helps": helps !== undefined && helps !== null ? String(helps) : "",
             "lookupObj": lookupObj,
-            "defaultValue": "",
             "childrelationName": nameLabel,
-            "lookupObjDefaultField": ""
+            "lookupObjDefaultField": ldf
         },
         "dtype": "Y:查找关系",
         "fdtype": "Y",

package/src/fields/index.js

@@ -1,6 +1,8 @@
 const cc = {}
 cc.get = require("./get")
+cc.detail = require("./detail")
 cc.create = require("./create")
+cc.update = require("./update")
 cc.delete = require("./delete")
 cc.doc = require("./doc")
 

package/src/fields/update.js

@@ -0,0 +1,148 @@
+const fs = require("fs");
+const path = require("path");
+const { postClass } = require("../../utils/http")
+const { getPackageJson } = require("../../utils/config");
+const chalk = require('chalk')
+const { buildFieldData } = require("./buildFieldData");
+
+/**
+ * 在 object/custom-objects 与 object/standard-objects 中按对象 id 查找 objprefix（供 queryField 使用）
+ */
+function findObjPrefixForObjId(projectPath, objid) {
+    if (!objid || String(objid).trim() === "") return null;
+    const roots = [
+        path.join(path.resolve(projectPath), "object/custom-objects"),
+        path.join(path.resolve(projectPath), "object/standard-objects"),
+    ];
+    for (const dir of roots) {
+        if (!fs.existsSync(dir)) continue;
+        let files;
+        try {
+            files = fs.readdirSync(dir);
+        } catch (_) {
+            continue;
+        }
+        for (const f of files) {
+            if (!f.endsWith(".json")) continue;
+            const fp = path.join(dir, f);
+            try {
+                const j = JSON.parse(fs.readFileSync(fp, "utf8"));
+                if (j && j.id === objid && j.objprefix) return String(j.objprefix).trim();
+            } catch (_) {}
+        }
+    }
+    return null;
+}
+
+/**
+ * saveField 需要与平台上已有字段一致的元数据（如 datafieldRef、schemetableId）。
+ * 在发起 saveField 前，用 queryField 拉取当前字段并合并进 payload。
+ */
+async function mergeUpdatePayloadFromServer(config, projectPath, fieldId, objid, fieldData) {
+    const prefix = findObjPrefixForObjId(projectPath, objid);
+    if (!prefix) {
+        console.error(
+            chalk.yellow(
+                "⚠ cloudcc update fields: 未在 object/custom-objects 或 object/standard-objects 中找到 objid=" +
+                    objid +
+                    " 的 objprefix；请先执行 cloudcc get object 同步对象清单后再试。"
+            )
+        );
+        if (fieldData.obj) fieldData.obj.schemetableId = String(objid).trim();
+        return;
+    }
+    const res = await postClass(
+        config.setupSvc + "/api/fieldSetup/queryField",
+        { prefix },
+        config.accessToken
+    );
+    if (!res || !res.result || !res.data) return;
+    const pool = [...(res.data.stdFields || []), ...(res.data.cusFields || [])];
+    const raw = pool.find((f) => f && f.id === fieldId);
+    if (!fieldData.obj) return;
+    fieldData.obj.schemetableId = String(objid).trim();
+    if (raw && raw.datafieldRef) fieldData.obj.datafieldRef = String(raw.datafieldRef);
+    if (raw && (raw.schemefieldName || raw.apiname)) {
+        fieldData.obj.apiname = String(raw.schemefieldName || raw.apiname);
+    }
+    if (raw && Array.isArray(raw.profileFieldJson) && raw.profileFieldJson.length > 0) {
+        fieldData.profileFieldJson = raw.profileFieldJson;
+    }
+    if (fieldData.layoutIds === undefined) fieldData.layoutIds = "";
+}
+
+/**
+ * create 使用 save，简档为 profileId + visible + readonly；saveField 需 profileid + permission。
+ */
+function normalizeProfileFieldJsonForSaveField(fieldData) {
+    if (!fieldData || !Array.isArray(fieldData.profileFieldJson)) return;
+    fieldData.profileFieldJson = fieldData.profileFieldJson
+        .map((row) => {
+            const pid = row.profileid || row.profileId;
+            if (!pid) return null;
+            if (row.permission != null && String(row.permission) !== "") {
+                return { profileid: String(pid), permission: String(row.permission) };
+            }
+            return { profileid: String(pid), permission: "1,0" };
+        })
+        .filter(Boolean);
+}
+
+/**
+ * 更新字段（与 create 共用同一套 payload 与类型分支；区别在于必须设置 `obj.id` 为字段 ID，且不请求 layout 绑定）
+ * @param {Array} argvs - 命令行参数数组
+ * @param {string} argvs[2] projectPath
+ * @param {string} argvs[3] fieldId（平台字段 id）
+ * @param {string} argvs[4] fieldType
+ * @param {string} argvs[5] objid
+ * @param {string} argvs[6] nameLabel
+ * @param {string} argvs[7] remark（与 create 相比各类型可选参数整体下标 +1）
+ * @returns {Promise<boolean>}
+ */
+async function update(argvs) {
+    try {
+        let projectPath = argvs[2];
+        const fieldId = argvs[3];
+        if (!fieldId || String(fieldId).trim() === "") {
+            throw new Error("Missing field id: argvs[3] (field id from platform)");
+        }
+        const config = await getPackageJson(projectPath);
+        let nameLabel = argvs[6];
+        let remarkText = argvs[7];
+        if (!remarkText) remarkText = "auto created by cloudcc-cli ai agent";
+        console.error(chalk.blue('\nUpdating field ' + nameLabel + ' (id=' + fieldId + ')...'));
+        let fieldData = await buildFieldData(argvs, { shift: 1 });
+        if (!fieldData) {
+            throw new Error("Unsupported or unknown fieldType for update");
+        }
+        if (fieldData.obj) fieldData.obj.id = String(fieldId).trim();
+        if (fieldData && fieldData.obj) fieldData.obj.remark = remarkText;
+        if (fieldData) fieldData.remark = remarkText;
+
+        const objid = argvs[5];
+        await mergeUpdatePayloadFromServer(config, projectPath, fieldId, objid, fieldData);
+        normalizeProfileFieldJsonForSaveField(fieldData);
+
+        const result = await postClass(
+            config.setupSvc + "/api/fieldSetup/saveField",
+            fieldData,
+            config.accessToken
+        );
+
+        if (result && result.result) {
+            const okId = result.data && (typeof result.data === "string" || typeof result.data === "number")
+                ? result.data
+                : (result.data && result.data.id) || fieldId;
+            console.error(chalk.green('✓ Field updated successfully! ID: ' + okId));
+            return true;
+        } else {
+            console.error(chalk.yellow('⚠ Field update completed with warnings: ' + (result && result.returnInfo)));
+            return false;
+        }
+    } catch (error) {
+        console.error(chalk.red("Failed to update field: "), error.message || error);
+        return false;
+    }
+}
+
+module.exports = update;

package/src/jsp/analyze.js

@@ -0,0 +1,17 @@
+const { analyzeJspMigration, parseCliJsonArg } = require("./migration")
+
+async function analyze(argvs) {
+  const params = parseCliJsonArg(
+    argvs[2],
+    "cloudcc analyze jsp <encodeURI(JSON.stringify(params))>"
+  )
+  const result = await analyzeJspMigration(params)
+  if (!result.success) {
+    throw new Error(result.text)
+  }
+
+  console.log(result.text)
+  return result.text
+}
+
+module.exports = analyze

package/src/jsp/doc.js

@@ -0,0 +1,18 @@
+const { readIntroductionDoc, readDevGuideDoc } = require("./docs")
+
+function doc(argvs) {
+  const subType = String(argvs[2] || "").trim().toLowerCase()
+  if (!subType || subType === "devguide") {
+    const content = readDevGuideDoc()
+    console.log(content)
+    return content
+  }
+  if (subType === "introduction") {
+    const content = readIntroductionDoc()
+    console.log(content)
+    return content
+  }
+  throw new Error(`cloudcc doc jsp 需要子命令：introduction 或 devguide`)
+}
+
+module.exports = doc

package/src/jsp/docs/devguide.md

@@ -0,0 +1,111 @@
+# CloudCC JSP 迁移开发指南
+
+## 1. 命令总览
+
+```bash
+cloudcc doc jsp devguide
+cloudcc analyze jsp <encodeURI(JSON.stringify(params))>
+cloudcc split jsp <encodeURI(JSON.stringify(params))>
+```
+
+## 2. 参数结构
+
+推荐将参数组织成 JSON，再使用 `encodeURI(JSON.stringify(params))` 传入 CLI。
+
+参数示例：
+
+```json
+{
+  "jspPath": "customize/wt_ly.jsp",
+  "helpDocPath": "jspTemp/help.md",
+  "projectPath": "/abs/project",
+  "outputProjectPath": "/abs/output-project",
+  "className": "WtLyMigratedService",
+  "componentName": "wt-ly-migrated",
+  "reportDir": "migration-report",
+  "mode": "apply",
+  "overwrite": false
+}
+```
+
+字段说明：
+
+- `jspPath`：必填，JSP 文件路径，可为绝对路径或相对 `projectPath`
+- `helpDocPath`：可选，帮助文档路径
+- `projectPath`：可选，项目根目录，默认当前工作目录
+- `outputProjectPath`：可选，输出项目目录，默认等于 `projectPath`
+- `className`：可选，生成的自定义类名
+- `componentName`：可选，生成的组件名
+- `reportDir`：可选，报告目录，默认 `migration-report`
+- `mode`：仅 `split jsp` 有意义，支持 `apply` / `dry-run`
+- `overwrite`：是否覆盖现有文件，默认 `false`
+
+## 3. 常用命令示例
+
+### 3.1 查看开发文档与规则
+
+```bash
+cloudcc doc jsp devguide
+```
+
+### 3.2 分析 JSP（不写文件）
+
+```bash
+cloudcc analyze jsp "$(node -e 'console.log(encodeURI(JSON.stringify({jspPath:\"customize/wt_ly.jsp\",projectPath:process.cwd()})))')"
+```
+
+### 3.3 生成迁移结果
+
+```bash
+cloudcc split jsp "$(node -e 'console.log(encodeURI(JSON.stringify({jspPath:\"customize/wt_ly.jsp\",projectPath:process.cwd(),overwrite:false})))')"
+```
+
+## 4. 输出结果
+
+`split jsp` 默认会输出：
+
+- `classes/<ClassName>/<ClassName>.java`
+- `classes/<ClassName>/<ClassName>Test.java`
+- `classes/<ClassName>/config.json`
+- `plugins/<componentName>/<componentName>.vue`
+- `plugins/<componentName>/config.json`
+- `<reportDir>/<jspBaseName>.migration.md`
+
+## 5. 推荐流程
+
+1. 先阅读 `cloudcc doc jsp devguide` 中的规则章节
+2. 根据旧 URL 或仓库结构定位 `customize/*.jsp`
+3. 用 `cloudcc analyze jsp ...` 做单文件分析
+4. 调整类名、组件名、输出目录等参数
+5. 用 `cloudcc split jsp ...` 生成迁移草稿
+6. 手工补全生成类中的业务逻辑并验证依赖
+
+## 6. JSP 迁移规则
+
+### 6.1 从旧系统 URL 定位 JSP 源文件
+
+- 若页面或配置中出现形如 `/controller.action?name=<name>` 的地址，应在项目根目录下的 `customize` 目录中查找对应 JSP
+- 常见约定：`<projectPath>/customize/<name>.jsp`
+- 解析出真实路径后，可将其作为 `jspPath` 传入 CLI `cloudcc analyze jsp` / `cloudcc split jsp`，或对应的 MCP 工具
+
+### 6.2 批量迁移时的建议流程
+
+1. 先查看本节规则；若走 CLI，可执行 `cloudcc doc jsp devguide`
+2. 在仓库中列举或搜索 `customize` 下需处理的 `.jsp`
+3. 对每个 JSP 单独执行 `cloudcc analyze jsp` 或 `cloudcc split jsp`
+4. 不要假设服务端会自动循环多个文件
+
+### 6.3 PageClsInvoker 调用约定
+
+在服务端自定义类中，通过 `PageClsInvoker` 调用其它自定义类方法，典型形式如下：
+
+```java
+Object result = new PageClsInvoker(userInfo).invoker("TargetClassName", "targetMethodName", argList);
+```
+
+迁移 JSP 内出现的同类调用时，保持上述调用形态，并核对目标类、方法在平台中已存在且参数类型一致。
+
+### 6.4 与迁移工具的配合
+
+- `cloudcc analyze jsp` / `cloudcc split jsp`（以及对应 MCP 工具）会从 JSP 文本中识别 `PageClsInvoker(userInfo).invoker("类名","方法名", ...)` 形式的依赖，并写入迁移报告
+- 具体业务实现仍需在生成后的自定义类中补全或调整

package/src/jsp/docs/introduction.md

@@ -0,0 +1,50 @@
+# CloudCC JSP 迁移介绍
+
+## 1. 模块定位
+
+`jsp` 模块用于辅助将旧 JSP 页面迁移为 CloudCC 自定义类与自定义组件。
+
+当前资源主要提供三类能力：
+
+- 读取固定迁移规则
+- 对单个 JSP 做 dry-run 分析
+- 对单个 JSP 输出迁移产物
+
+可通过以下命令查看：
+
+```bash
+cloudcc doc jsp introduction
+cloudcc doc jsp devguide
+```
+
+## 2. 当前支持的命令
+
+```bash
+cloudcc doc jsp devguide
+cloudcc analyze jsp <encodeURI(JSON.stringify(params))>
+cloudcc split jsp <encodeURI(JSON.stringify(params))>
+```
+
+其中 `params` 主要包含：
+
+- `jspPath`
+- `helpDocPath`
+- `projectPath`
+- `outputProjectPath`
+- `className`
+- `componentName`
+- `reportDir`
+- `mode`
+- `overwrite`
+
+## 3. 适用场景
+
+- 旧系统 JSP 页面迁移评估
+- 识别 `reason` 分支、对象依赖、`PageClsInvoker` 调用
+- 生成 CloudCC 自定义类、自定义组件和迁移报告草稿
+
+## 4. 使用建议
+
+- 先阅读 `cloudcc doc jsp devguide`
+- 再执行 `cloudcc analyze jsp ...` 做分析
+- 确认命名、输出目录和覆盖策略后，再执行 `cloudcc split jsp ...`

package/src/jsp/docs.js

@@ -0,0 +1,21 @@
+const fs = require("fs")
+const path = require("path")
+
+const DOCS_DIR = path.join(__dirname, "docs")
+
+function readDocFile(name) {
+  return fs.readFileSync(path.join(DOCS_DIR, `${name}.md`), "utf8")
+}
+
+function readIntroductionDoc() {
+  return readDocFile("introduction")
+}
+
+function readDevGuideDoc() {
+  return readDocFile("devguide")
+}
+
+module.exports = {
+  readIntroductionDoc,
+  readDevGuideDoc,
+}