njk-tool 0.0.26 → 0.1.0

package/dist/bundle/type.d.ts

@@ -1,3 +1,7 @@
+/**
+ * 组件标签类型枚举
+ * 包含所有支持的组件类型
+ */
 declare enum TagType {
     Title = "title",
     Date = "date",
@@ -7,8 +11,16 @@ declare enum TagType {
     Toc = "toc",
     Notice = "notice",
     Block = "block",
-    Table = "table"
+    Table = "table",
+    Divider = "divider",
+    Tag = "tag",
+    ContentTitle = "title_content",
+    Html = "html"
 }
+/**
+ * 基础配置接口
+ * 所有组件共享的基础属性
+ */
 interface BaseConfItem {
     tag: TagType;
     type?: string;
@@ -18,24 +30,63 @@ interface BaseConfItem {
     cssFiles?: string[];
     jsFiles?: string[];
 }
+/**
+ * 目录和代码块配置
+ */
 interface ListConfItem extends BaseConfItem {
     tag: TagType.Toc | TagType.Block;
     data?: Array<object>;
 }
+/**
+ * 表格配置接口
+ * 支持两种数据格式：
+ * 1. 对象数组格式：columns + data
+ * 2. 二维数组格式：th + tbody
+ */
 interface TableConfItem extends BaseConfItem {
     tag: TagType.Table;
-    columns?: Array<{
-        key: string;
-        label: string;
-    }>;
-    data?: Array<object>;
-    th?: Array<{
-        key: string;
-        width?: string;
-    }>;
-    tbody?: Array<object[]>;
+    title?: string;
+    columns?: string[];
+    data?: Record<string, any>[];
+    th?: string[];
+    tbody?: any[][];
+}
+/**
+ * 标签组件配置
+ */
+interface TagConfItem extends BaseConfItem {
+    tag: TagType.Tag;
+    color?: string;
+    size?: 'small' | 'medium' | 'large';
+}
+/**
+ * 内容标题配置
+ */
+interface ContentTitleConfItem extends BaseConfItem {
+    tag: TagType.ContentTitle;
+    type?: 'h3' | 'hover_h3' | 'remain_h3' | 'hover' | 'remain';
+    hover?: boolean;
+    remain?: boolean;
+}
+/**
+ * 分隔符配置
+ */
+interface DividerConfItem extends BaseConfItem {
+    tag: TagType.Divider;
+}
+/**
+ * HTML 组件配置
+ * 直接嵌入 HTML 代码，适用于邮件模板
+ */
+interface HtmlConfItem extends BaseConfItem {
+    tag: TagType.Html;
+    html?: string;
+    code?: string;
 }
-type ConfItem = BaseConfItem | ListConfItem | TableConfItem;
+/**
+ * 组件配置联合类型
+ */
+type ConfItem = BaseConfItem | ListConfItem | TableConfItem | TagConfItem | ContentTitleConfItem | DividerConfItem | HtmlConfItem;
 
 interface Options {
     cssUrl?: string | string[];

package/package.json

@@ -1,59 +1,58 @@
-{
-  "name": "njk-tool",
-  "version": "0.0.26",
-  "description": "nunjucks no JavaScript 模板工具，兼容jinja",
-  "types": "dist/bundle/type.d.ts",
-  "exports": {
-    ".": {
-      "require": "./dist/bundle/app.min.cjs",
-      "import": "./dist/bundle/app.min.js"
-    }
-  },
-  "author": "zggong",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/SHgzg/njk-tool.git"
-  },
-  "type": "module",
-  "peerDependencies": {
-    "nunjucks": "^3.2.4"
-  },
-  "files": [
-    "dist/bundle",
-    "LICENSE",
-    "README.md"
-  ],
-  "scripts": {
-    "build": "rollup -c && rollup -c rollup.dts.config.js",
-    "build:type": "rollup -c rollup.dts.config.js",
-    "dev": "npx tsc && node ./dist/dev/main.js"
-  },
-  "keywords": [
-    "nunjucks",
-    "template"
-  ],
-  "packageManager": "pnpm@10.9.0",
-  "dependencies": {
-    "nodemailer": "^7.0.5",
-    "nunjucks": "^3.2.4"
-  },
-  "devDependencies": {
-    "@rollup/plugin-commonjs": "^28.0.6",
-    "@rollup/plugin-json": "^6.1.0",
-    "@rollup/plugin-node-resolve": "^16.0.1",
-    "@rollup/plugin-typescript": "^12.1.4",
-    "@types/express": "^5.0.2",
-    "@types/node": "^22.15.30",
-    "@types/nodemailer": "^6.4.17",
-    "@types/nunjucks": "^3.2.6",
-    "chokidar": "3.6.0",
-    "dotenv": "^16.5.0",
-    "express": "^5.1.0",
-    "rollup": "^4.45.1",
-    "rollup-plugin-copy": "^3.5.0",
-    "rollup-plugin-dts": "^6.2.1",
-    "tslib": "^2.8.1",
-    "typescript": "^5.8.3"
-  }
-}
+{
+  "name": "njk-tool",
+  "version": "0.1.0",
+  "description": "nunjucks no JavaScript 模板工具，兼容jinja",
+  "types": "dist/bundle/type.d.ts",
+  "exports": {
+    ".": {
+      "require": "./dist/bundle/app.min.cjs",
+      "import": "./dist/bundle/app.min.js"
+    }
+  },
+  "author": "zggong",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/SHgzg/njk-tool.git"
+  },
+  "type": "module",
+  "files": [
+    "dist/bundle",
+    "LICENSE",
+    "README.md",
+    ".env.example"
+  ],
+  "scripts": {
+    "build": "rollup -c && rollup -c rollup.dts.config.js",
+    "build:type": "rollup -c rollup.dts.config.js",
+    "dev": "npx tsc && node ./dist/dev/main.js",
+    "predev": "npm run build"
+  },
+  "keywords": [
+    "nunjucks",
+    "template"
+  ],
+  "packageManager": "pnpm@10.9.0",
+  "dependencies": {
+    "nodemailer": "^7.0.5",
+    "nunjucks": "^3.2.4"
+  },
+  "devDependencies": {
+    "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-json": "^6.1.0",
+    "@rollup/plugin-node-resolve": "^16.0.1",
+    "@rollup/plugin-typescript": "^12.1.4",
+    "@types/express": "^5.0.2",
+    "@types/node": "^22.19.7",
+    "@types/nodemailer": "^6.4.17",
+    "@types/nunjucks": "^3.2.6",
+    "chokidar": "3.6.0",
+    "dotenv": "^16.5.0",
+    "express": "^5.1.0",
+    "rollup": "^4.45.1",
+    "rollup-plugin-copy": "^3.5.0",
+    "rollup-plugin-dts": "^6.2.1",
+    "tslib": "^2.8.1",
+    "typescript": "^5.8.3"
+  }
+}

package/readme.md

@@ -1,9 +1,87 @@
-zhzddzfhypwzfbji
-
----
-```javascript
-function macro() { 
-    for (var _len = arguments.length, macroArgs = new Array(_len), _key = 0; _key < _len; _key++) { 
-        macroArgs[_key] = arguments[_key]; } var argCount = numArgs(macroArgs); var args; var kwargs = getKeywordArgs(macroArgs); if (argCount > argNames.length) { args = macroArgs.slice(0, argNames.length); // Positional arguments that should be passed in as // keyword arguments (essentially default values) 
-macroArgs.slice(args.length, argCount).forEach(function (val, i) { if (i < kwargNames.length) { kwargs[kwargNames[i]] = val; } }); args.push(kwargs); } else if (argCount < argNames.length) { args = macroArgs.slice(0, argCount); for (var i = argCount; i < argNames.length; i++) { var arg = argNames[i]; // Keyword arguments that should be passed as // positional arguments, i.e. the caller explicitly // used the name of a positional arg args.push(kwargs[arg]); delete kwargs[arg]; } args.push(kwargs); } else { args = macroArgs; } return func.apply(this, args); }
-```
+# njk-tool
+
+> Nunjucks 模板渲染工具，用于快速生成 HTML 报告和文档
+
+## 特性
+
+- 🎨 **丰富的组件系统** - 标题、表格、提示框、目录等
+- 📧 **邮件集成** - 支持将渲染结果直接发送邮件
+- 🔧 **零 JavaScript 编程** - 通过 JSON 配置即可生成 HTML
+- 📱 **响应式设计** - 内置移动端适配样式
+
+## 快速开始
+
+### 安装
+
+```bash
+npm install njk-tool
+```
+
+### 基础用法
+
+```typescript
+import { njkRenderSync } from 'njk-tool';
+
+const html = njkRenderSync([
+  {
+    tag: 'title',
+    type: 'h1',
+    text: '我的报告'
+  },
+  {
+    tag: 'table',
+    columns: ['Name', 'Age'],
+    data: [
+      { Name: 'Alice', Age: 25 },
+      { Name: 'Bob', Age: 30 }
+    ]
+  }
+]);
+```
+
+## 开发
+
+### 安装依赖
+
+```bash
+pnpm install
+```
+
+### 启动开发服务器
+
+```bash
+pnpm run dev
+```
+
+访问 http://localhost:3007/example/report_test 查看示例
+
+### 配置邮件功能（可选）
+
+复制 `.env.example` 为 `.env` 并配置：
+
+```env
+SMTP_HOST=smtp.qq.com
+SMTP_PORT=465
+SMTP_SECURE=true
+SMTP_USER=your@qq.com
+SMTP_PASS=your授权码
+SMTP_TO=receiver@example.com
+```
+
+## 组件列表
+
+- `title` - 标题组件（h1-h6）
+- `table` - 表格组件
+- `notice` - 提示框（info/success/warning/error）
+- `date` - 日期显示
+- `checker` - 检查人信息
+- `toc` - 目录导航
+- `block` - 代码块
+- `text` - 文本内容
+- `divider` - 分隔线
+- `tag` - 标签
+- `title_content` - 可折叠内容块
+
+## License
+
+MIT