@nasl/cli 0.3.0 → 0.3.1

package/README.md

@@ -76,6 +76,20 @@ nasl check "src/app.logics.*.ts"
 nasl check "src/*.tsx"
 ```
 
+### 检查 plan 文档中的 NaturalTS（nasl-doc / nasld）
+
+用于检查 plan 目录下 markdown 里 `naturalts` 代码块的语法（与 `nasl check` 面向 `src` 的 NASL 源码检查不同）。
+
+安装 `@nasl/cli` 后，可使用 **`nasl-doc`** 或 **`nasld`**（同一命令的短名）：
+
+```bash
+nasl-doc check path/to/plan.md
+# 或
+nasld check path/to/plan.md
+```
+
+支持的文档类型包括：`enums.md`、`entity-*.md`、`structure-*.md`、`logic-*.md`、`view-*.md` 等（详见命令帮助：`nasl-doc check --help`）。
+
 ### 依赖分析（nasl dep）
 
 建议指定入口文件，否则会扫描整个 src 目录，输出量较大。

package/dist/bin/nasl.mjs

@@ -29331,7 +29331,7 @@ function validateExtensionsFile(file, errors) {
 /**
  * 验证普通文件（枚举、实体、数据结构、逻辑、页面）
  */
-function validateNormalFile(file, nameFromPath, namespace, errors) {
+function validateNormalFile(file, nameFromPath, namespace, errors, options) {
     const matchArr = Array.from(file.content.matchAll(/^(export\s+)?(declare\s+)?(function|class|interface)\s+(\w+)/gm));
     if (matchArr.length === 0)
         errors.push(`${file.path} 必须有一个函数或类，错误代码：${file.content}`);
@@ -29343,14 +29343,14 @@ function validateNormalFile(file, nameFromPath, namespace, errors) {
         if (!isExport)
             errors.push(`${file.path} 必须使用 export，错误代码：${match[0]}`);
         if (name !== nameFromPath)
-            errors.push(`${file.path} 的函数或类名必须与文件名一致，错误代码：${match[0]}`);
+            errors.push(`${file.path} 的函数或类名必须与${options?.isDocCheck ? ' path 属性' : '文件名'}一致，错误代码：${match[0]}`);
         if (/\.(entities|enums|structures)/.test(namespace) && type !== 'class')
             errors.push(`${file.path} 实体、数据结构和枚举只能使用 class 定义，错误代码：${match[0]}`);
         if (/\.(logics|views)/.test(namespace) && type !== 'function')
             errors.push(`${file.path} 逻辑和页面只能使用 function 定义，错误代码：${match[0]}`);
     }
 }
-function composeToString(files) {
+function composeToString(files, options) {
     files.sort((a, b) => sorter(a.path, b.path));
     const errors = [];
     let currentLine = 1;
@@ -29365,7 +29365,7 @@ function composeToString(files) {
         const isExtensionsFile = arr[0] === 'extensions';
         const isThemeCss = ext === 'css' && nameFromPath === 'theme';
         const isSpecialFile = isVariablesFile || isExtensionsFile || isThemeCss;
-        // 特殊文件的 namespace 包含文件名，普通文件不包含
+        // 特殊文件的 namespace ${包含文件名，普通文件不包含
         const namespace = isSpecialFile ? [...arr, nameFromPath].join('.') : arr.join('.');
         let content = file.content;
         if (['ts', 'tsx'].includes(ext)) {
@@ -29376,7 +29376,7 @@ function composeToString(files) {
                 validateExtensionsFile(file, errors);
             }
             else {
-                validateNormalFile(file, nameFromPath, namespace, errors);
+                validateNormalFile(file, nameFromPath, namespace, errors, options);
             }
         }
         else if (isThemeCss) {
@@ -39035,6 +39035,170 @@ async function transformJson2FilesApi(json, options) {
     return data.result;
 }
 
+// src/codeBlock.ts
+function extractCodeBlocks(markdown) {
+  const codeBlocks = [];
+  const lines = markdown.split("\n");
+  let inCodeBlock = false;
+  let codeBlockStart = 0;
+  let currLang = "";
+  let currLangExtra = "";
+  let currCode = [];
+  for (let i = 0; i < lines.length; i++) {
+    const line = lines[i];
+    if (line.startsWith("```")) {
+      if (!inCodeBlock) {
+        inCodeBlock = true;
+        codeBlockStart = i + 1;
+        const langPart = line.slice(3).trim();
+        const spaceIndex = langPart.indexOf(" ");
+        let potentialLang = "";
+        let potentialExtra = "";
+        if (spaceIndex > 0) {
+          potentialLang = langPart.slice(0, spaceIndex);
+          potentialExtra = langPart.slice(spaceIndex + 1).trim();
+        } else {
+          potentialLang = langPart;
+          potentialExtra = "";
+        }
+        const isLikelyLanguage = potentialLang && !potentialLang.includes("=") && !potentialLang.startsWith("/") && !potentialLang.startsWith(".") && potentialLang !== "";
+        if (isLikelyLanguage) {
+          currLang = potentialLang;
+          currLangExtra = potentialExtra;
+        } else {
+          currLang = "text";
+          currLangExtra = langPart;
+        }
+        currCode = [];
+      } else {
+        inCodeBlock = false;
+        codeBlocks.push({
+          lang: currLang,
+          langExtra: currLangExtra || void 0,
+          code: currCode.join("\n"),
+          startLine: codeBlockStart,
+          endLine: i
+        });
+        currLang = "";
+        currLangExtra = "";
+        currCode = [];
+      }
+    } else if (inCodeBlock) {
+      currCode.push(line);
+    }
+  }
+  return codeBlocks;
+}
+
+const DOC_PATTERNS = [
+    /^enums\.md$/,
+    /^entity-.+\.md$/,
+    /^structure-.+\.md$/,
+    /^logic-.+\.md$/,
+    /^view-.+\.md$/,
+];
+// 文档类型前缀 → NASL 文件类型名
+const DOC_TO_NASL_TYPE = {
+    enums: 'enums',
+    entity: 'entities',
+    structure: 'structures',
+    logic: 'logics',
+    view: 'views',
+};
+/**
+ * 从 tsx FileInfo 中解析出所有祖先 view，生成空壳 stub
+ * 例如 path=a.views.dashboard.views.knowledgeAccess.views.accessBrowse.tsx
+ * 会生成 dashboard 和 knowledgeAccess 的 stub
+ */
+function buildViewStubs(files) {
+    const existingPaths = new Set(files.map((f) => f.path));
+    const stubs = [];
+    for (const file of files) {
+        if (!file.path.endsWith('.tsx'))
+            continue;
+        const parts = file.path.split('.').slice(0, -2);
+        for (let i = 0; i < parts.length - 1; i++) {
+            if (parts[i] === 'views') {
+                const viewName = parts[i + 1];
+                if (!viewName)
+                    continue;
+                const stubPath = [...parts.slice(0, i + 2), 'tsx'].join('.');
+                if (!existingPaths.has(stubPath)) {
+                    existingPaths.add(stubPath);
+                    stubs.push({
+                        path: stubPath,
+                        content: `$View({\n    title: "",\n    auth: false,\n    isIndex: false,\n});\nexport function ${viewName}() {\n    return ( <ElRouterView /> );\n}`,
+                    });
+                }
+            }
+        }
+    }
+    return stubs;
+}
+/**
+ * 从 plan markdown 文件中提取并组装 fullNaturalTS，返回字符串或错误信息
+ */
+function extractFullNaturalTS(filePath, logger = defaultLogger) {
+    // 1. 验证路径模式（只检查文件名）
+    const basename = path$1.basename(filePath);
+    if (!DOC_PATTERNS.some((p) => p.test(basename))) {
+        logger.error(`路径不匹配任何支持的文档类型：${basename}\n` +
+            `支持的类型：enums.md, entity-*.md, structure-*.md, logic-*.md, view-*.md`);
+        return { success: false };
+    }
+    // 2. 读取文件
+    if (!libExports.existsSync(filePath)) {
+        logger.error(`文件不存在：${filePath}`);
+        return { success: false };
+    }
+    const content = libExports.readFileSync(filePath, 'utf-8');
+    // 3. 提取 naturalts 代码块，转换为 FileInfo[]
+    const blocks = extractCodeBlocks(content).filter((b) => b.lang === 'naturalts');
+    if (blocks.length === 0) {
+        // logger.warn('未发现 naturalts 代码块');
+        return { fullNaturalTS: '' };
+    }
+    const isViewDoc = /^view-.+\.md$/.test(basename);
+    const expectedExt = isViewDoc ? '.tsx' : '.ts';
+    const docTypePrefix = basename.split(/[-.]/)[0] ?? '';
+    const naslTypeName = DOC_TO_NASL_TYPE[docTypePrefix];
+    const expectedPattern = NASL_FILE_TYPES.find((t) => t.name === naslTypeName)?.fileNamePattern;
+    const errors = [];
+    const files = blocks.map((block) => {
+        const match = block.langExtra?.match(/path="([^"]+)"/);
+        if (!match) {
+            errors.push(`代码块缺少 path 属性（第 ${block.startLine} 行）`);
+            return null;
+        }
+        const blockPath = match[1];
+        if (!blockPath.endsWith(expectedExt)) {
+            errors.push(`代码块 path 扩展名不正确，应为 ${expectedExt}（第 ${block.startLine} 行）：${blockPath}`);
+            return null;
+        }
+        if (!isKnownFileType(blockPath)) {
+            const hint = expectedPattern ? `\n正确格式应匹配：${expectedPattern}` : '';
+            errors.push(`代码块 path 不是合法的 NASL 文件类型（第 ${block.startLine} 行）：${blockPath}${hint}`);
+            return null;
+        }
+        const fileInfo = { path: blockPath, content: block.code };
+        return fileInfo;
+    }).filter((f) => f !== null);
+    if (errors.length > 0) {
+        logger.error(`在 ${filePath} 检测到以下错误：\n` + errors.join('\n'));
+        return { success: false };
+    }
+    // 4. 补充父级 view stub（tsx 文件需要祖先页面定义）
+    const stubs = buildViewStubs(files);
+    // 5. 复用 composeToString 组装（包含排序和 namespace 构建）
+    try {
+        return { fullNaturalTS: composeToString([...files, ...stubs], { isDocCheck: true }) };
+    }
+    catch (err) {
+        logger.error(`在 ${filePath} 检测到以下错误：\n` + err.message);
+        return { success: false };
+    }
+}
+
 const transformFns = {
     /**
      * 将 src 中的文件组合成 fullNaturalTS
@@ -39061,6 +39225,33 @@ const transformFns = {
         writeFileWithLog(outputPath, fullNaturalTS, logger);
         logger.success(`文件已输出到: ${outputPath}`);
     },
+    /**
+     * 将 plan markdown 文档中的 naturalts 代码块组合成 fullNaturalTS 文件
+     */
+    async doc2full(entry, options) {
+        const logger = options?.logger || defaultLogger;
+        if (!entry) {
+            logger.error('请指定 plan 文档路径');
+            logger.exit(1);
+            return;
+        }
+        const extracted = extractFullNaturalTS(entry, logger);
+        if ('success' in extracted) {
+            logger.exit(1);
+            return;
+        }
+        if (!extracted.fullNaturalTS) {
+            logger.warn('未发现 naturalts 代码块，跳过输出');
+            return;
+        }
+        // 确定输出路径
+        const projectRoot = getProjectRoot();
+        const outputPath = options?.output
+            ? path$1.resolve(projectRoot, options.output)
+            : path$1.join(projectRoot, './full-natural.ts');
+        writeFileWithLog(outputPath, extracted.fullNaturalTS, logger);
+        logger.success(`文件已输出到: ${outputPath}`);
+    },
     /**
      * 将 JSON 文件转换成 src 的 files
      * TODO: 待实现
@@ -39193,7 +39384,7 @@ async function installByJSON(json, options) {
     logger.success(`成功写入 ${writtenCount} 个依赖文件到 ${config.srcDir} 目录`);
 }
 
-var version = "0.3.0";
+var version = "0.3.1";
 var pkg = {
 	version: version};
 
@@ -39355,12 +39546,12 @@ program
 });
 program
     .command('transform <transformType> [entry]')
-    .description('转换文件格式\n  transformType: files2full (将 src 文件组合成 fullNaturalTS), json2files (将 JSON 转换为文件), files2json (将 src 文件转换为 JSON)')
+    .description('转换文件格式\n  transformType: files2full (将 src 文件组合成 fullNaturalTS), json2files (将 JSON 转换为文件), files2json (将 src 文件转换为 JSON), doc2full (将 plan markdown 文档组合成 fullNaturalTS)')
     .option('-o, --output <outputPath>', '指定输出路径')
     .option('-v, --verbose', '显示详细信息，如依赖分析树')
     .action(async (transformType, entry, options) => {
     try {
-        const validTypes = ['files2full', 'json2files', 'files2json'];
+        const validTypes = ['files2full', 'json2files', 'files2json', 'doc2full'];
         if (!validTypes.includes(transformType)) {
             defaultLogger.error(`无效的转换类型: ${transformType}。支持的类型: ${validTypes.join(', ')}`);
             process.exit(1);