{"_id":"@aligov/plugin-gff-thymeleaf-html","_rev":"3-fd2523107ebff93fa1d740cf1a8af54d","name":"@aligov/plugin-gff-thymeleaf-html","description":"build-scripts plugin template for developers","dist-tags":{"latest":"2.0.11"},"versions":{"2.0.11":{"name":"@aligov/plugin-gff-thymeleaf-html","version":"2.0.11","author":"","license":"MIT","_id":"@aligov/plugin-gff-thymeleaf-html@2.0.11","maintainers":[{"name":"huguoxin","email":"hgxjyh@163.com"},{"name":"shenyu.wsy","email":"shenyu.wsy@alibaba-inc.com"},{"name":"liunian","email":"dengjij@gmail.com"},{"name":"tao1991123","email":"tao360907796@gmail.com"},{"name":"itrip","email":"1198488651@qq.com"},{"name":"xiazhiqiang","email":"xiazhiqiangcuc@126.com"},{"name":"mo.zhou","email":"bjfuzm@163.com"},{"name":"guoliang.hgl","email":"guoliang.hgl@alibaba-inc.com"},{"name":"daip","email":"15858208586@163.com"},{"name":"baizhao","email":"ethan.cqw@alibaba-inc.com"}],"dist":{"shasum":"10ca04f11a2091c51d6535acf1a193bcb33e630b","tarball":"https://registry.npmjs.org/@aligov/plugin-gff-thymeleaf-html/-/plugin-gff-thymeleaf-html-2.0.11.tgz","fileCount":18,"integrity":"sha512-sMwg3rjqdV4CE+3y/5p9g/IyXYwA9LhIpXVNsRD42PIggOhl2h+dZGq+RukDlIksSxNjuWw7ICI4VIK4gxaQsw==","signatures":[{"sig":"MEUCIQC6Xt/u+JnIRdPfSnjXrIDAnedOG/bhjLkJyoPK7u6csQIgIkboHhHRaxxpuaf8tTxguf43xSmAfEnuJIE+bNV9vv8=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":26289},"jest":{"preset":"ts-jest","collectCoverage":true,"coverageDirectory":"./coverage/"},"main":"lib/index.js","gitHead":"66f6da0e7a75c708ffbc510843f8e1ef9b245f15","scripts":{"test":"jest","build":"npx tsc && rm -rf lib && tsc","start":"tsc -w","coverage":"codecov","prepublish":"npm run build"},"_npmUser":{"name":"daip","email":"15858208586@163.com"},"_npmVersion":"6.14.13","description":"build-scripts plugin template for developers","directories":{},"_nodeVersion":"16.14.0","dependencies":{"lodash.get":"^4.4.2","html-loader":"^1.3.2","@ali/thymeleaf":"^0.20.3-rc.3","node-html-parser":"^4.0.0","html-webpack-plugin":"^4.5.2"},"_hasShrinkwrap":false,"originTemplate":"build-plugin-template","devDependencies":{"got":"^11.0.2","jest":"^25.4.0","ts-jest":"^25.4.0","fs-extra":"^9.0.0","typescript":"^4.3.5","@types/jest":"^25.2.1","@types/node":"^16.3.1","webpack-chain":"^6.4.0","@types/fs-extra":"^8.1.0","@alib/build-scripts":"^0.1.20","@types/webpack-chain":"^5.2.0","@types/webpack-dev-server":"^3.10.1"},"_npmOperationalInternal":{"tmp":"tmp/plugin-gff-thymeleaf-html_2.0.11_1696755416284_0.7773086644113067","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-10-08T08:56:56.184Z","modified":"2024-07-04T09:19:49.181Z","2.0.11":"2023-10-08T08:56:56.423Z"},"maintainers":[{"email":"wanyi.css@alibaba-inc.com","name":"wanyi.css"},{"email":"17682318001@163.com","name":"jasoncapricorn"},{"email":"chris_jun@aliyun.com","name":"qingkaili"},{"email":"hgxjyh@163.com","name":"huguoxin"},{"email":"shenyu.wsy@alibaba-inc.com","name":"shenyu.wsy"},{"email":"dengjij@gmail.com","name":"liunian"},{"email":"tao360907796@gmail.com","name":"tao1991123"},{"email":"1198488651@qq.com","name":"itrip"},{"email":"xiazhiqiangcuc@126.com","name":"xiazhiqiang"},{"email":"bjfuzm@163.com","name":"mo.zhou"},{"email":"guoliang.hgl@alibaba-inc.com","name":"guoliang.hgl"},{"email":"15858208586@163.com","name":"daip"},{"email":"ethan.cqw@gmail.com","name":"baizhao"}],"license":"MIT","readme":"# 用途\n\n用途, 用于 gff 的 thymeamf 模板渲染。\n`npm start`时候, 会被渲染成为 html, `npm run build`时候会被把 thymleaf 模板做预处理, 保持模板输出。\n\n## 使用方式\n\n本地安装 `tnpm i @ali/plugin-gff-thymeleaf-html -D` 然后再 build.json 中添加配置\n\n```\n\"plugins\": [\n    ....\n    '@ali/plugin-gff-thymeleaf-html',\n    ....\n],\n```\n\n也可以增加参数\n```\n[\n      \"@ali/plugin-gff-thymeleaf-html\",\n      {\n        \"data\": \"index.json\",\n        \"filename\": \"indexV2.html\",\n      },\n],\n```\n\n| 参数名   | 作用                                        | 类型   | 默认值       | 备注                                    |\n| -------- | ------------------------------------------- | ------ | ------------ | --------------------------------------- |\n| data     | 用于 thymleaf 模板渲染的数据 json 地址      | string | \"\"           | 默认使用 npm 包内置的 tempate/data.json |\n| filename | 构建后的文件名,  | string | \"index.html\" |                                         | 只在 npm run build 时候生效 |\n\n## 基础扩展\n`@ali/plugin-gff-thymeleaf-html` 内置扩展点,可以方便进行扩展。\n\n```\n<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <!-- 其他代码 -->\n    <!-- gff-thymleaf:head -->\n</head>\n<body>\n  <!-- gff-thymleaf:bodyBefore -->\n  <!-- 其他代码 -->\n  <!-- gff-thymleaf:bodyAfter -->\n</body>\n</html>\n```\n\n例如想要在 html头部插入额外HTML 代码片段, 可以在根目录编写一个 head.html。\n```\n<script>\n   // head.html文件内容\n  console.log('head inject');\n</script>\n```\n\n并这增加配置\n```\n[\n      \"@ali/plugin-gff-thymeleaf-html\",\n      {\n        // 其他配置....\n\n        \"fragments\": {\n            \"head\": \"head.html\"\n        }\n      },\n],\n```\n\n那么原模板会被渲染为\n```\n<!DOCTYPE html>\n<html lang=\"en\">\n<head>\n    <!-- 其他代码 -->\n    <script>\n        // head.html文件内容\n        console.log('head inject');\n    </script>\n</head>\n<body>\n  <!-- gff-thymleaf:bodyBefore -->\n  <!-- 其他代码 -->\n  <!-- gff-thymleaf:bodyAfter -->\n</body>\n</html>\n```\n\n| 参数名   | 作用                                        | 类型   | 默认值       | 备注                                    |\n| -------- | ------------------------------------------- | ------ | ------------ | --------------------------------------- |\n| fragments     | 扩展点配置      | Map<string, string> | {}          | 目前支持的key为head / bodyBefore / bodyAfter |\n\n\n## 高级扩展\n\n如果想要彻底定制模板, 可以自行写一个模板 foo-bar.html\n```\n<!DOCTYPE html>\n<html lang=\"zh-CN\">\n<head>\n    <!-- balabalabla -->\n</head>\n<body>\n    <!-- balabalabla -->\n</body>\n</html>\n```\n\n并修改配置项 `template`, 即可使用。\n```\n[\n      \"@ali/plugin-gff-thymeleaf-html\",\n      {\n        // 其他配置....\n\n        \"template\": \"foo-bar.html\"\n      },\n],\n```\n\n\n| 参数名   | 作用                                        | 类型   | 默认值       | 备注                                    |\n| -------- | ------------------------------------------- | ------ | ------------ | --------------------------------------- |\n| template     | 模板地址     | string | \"\"          | 默认使用包内置的 tempate/index.thymleaf.html |\n\n","readmeFilename":"README.md"}