提到脚手架,大家想到的可能就是各种 xxx-cli,本文介绍的是另一种形式:以 vscode 插件的模式实现,提供 web 可视化操作,如下图:

上面介绍如何装置应用,以及实现原理。

装置应用

vscode 装置 lowcode 插件,此插件是一个效率工具,脚手架只是其中一个性能,更多功能能够查看文档,这集只讲脚手架相干的。

插件装置之后,关上脚手架界面,步骤如下图:

能够间接应用分享的脚手架,勾选选项后间接创立即可:

制作脚手架

在模板我的项目根目录下创立 lowcode.scaffold.config.json 文件,将须要做内容动静替换的文件加上 .ejs 后缀。

ejs 语法

配置

一个残缺 lowcode.scaffold.config.json 配置:

{    "formSchema": {        "schema": {            "type": "object",            "ui:displayType": "row",            "ui:showDescIcon": true,            "properties": {                "port": {                    "title": "监听端口",                    "type": "string",                    "props": {},                    "default": "3000"                },                "https": {                    "title": "https",                    "type": "boolean",                    "ui:widget": "switch"                },                "lint": {                    "title": "eslint + prettier",                    "type": "boolean",                    "ui:widget": "switch",                    "default": true                },                "noREADME": {                    "title": "移除README文件",                    "type": "boolean",                    "ui:widget": "switch",                    "ui:width": "100%",                    "ui:labelWidth": 0,                    "ui:hidden": "{{rootValue.emptyREADME === true}}",                    "default": false                },                "emptyREADME": {                    "title": "空README文件",                    "type": "boolean",                    "ui:widget": "switch",                    "ui:hidden": "{{rootValue.noREADME === true}}"                }            },            "labelWidth": 120,            "displayType": "row"        },        "formData": {            "port": 3000,            "https": false,            "lint": true,            "noREADME": false,            "emptyREADME": false        }    },    "excludeCompile": ["codeTemplate/", "materials/"],    "conditionFiles": {        "noREADME": {            "value": true,            "exclude": ["README.md.ejs"]        },        "lint": {            "value": false,            "exclude": [".eslintrc.js", ".prettierrc.js"]        }    }}

formSchema

formSchema.schema 为 x-render 表单设计器 导出的的 schema,会依据 schema 构建出表单界面,formSchema.formData 为表单默认数据

创立我的项目的时候会将表单数据传入 ejs 模板中进行编译。

excludeCompile:配置不须要通过 ejs 编译的文件夹或文件。

conditionFiles:依据表单项的值,在创立我的项目的时候将某些文件夹或文件删除,比方:

"conditionFiles": {    "noREADME": {        "value": true,        "exclude": ["README.md.ejs"]    },    "lint": {        "value": false,        "exclude": [".eslintrc.js", ".prettierrc.js"]    }}

lint 这个表单项的值为 false 的时候,配置的文件夹或文件 ".eslintrc.js",".prettierrc.js",将会在创立的我的项目中排除掉。

本地调试脚手架

参考我的项目

https://github.com/lowcode-scaffold/lowcode-mock

公布脚手架

将脚手架提交到 git 仓库,留神凋谢我的项目的公开拜访权限。

应用脚手架

间接应用 git 仓库地址

留神应用 clone 地址,反对指定分支,比方 -b master https://github.com/lowcode-scaffold/lowcode-mock.git

分享到模板列表中疾速创立

批改 仓库 中 index.json 内容,提交 pr。

实现原理

  1. 关上 webview 的时候从 cdn 拉取记录了脚手架列表的 json 文件,渲染列表视图。
  2. 点击某个脚手架,将脚手架的 git 仓库地址传到插件后盾,插件后盾依据 git 地址下载模版到长期工作目录,并且读取 lowcode.scaffold.config.json 文件中的 formSchema 返回给 webview。

    export const downloadScaffoldFromGit = (remote: string) => {  fs.removeSync(tempDir.scaffold);  execa.sync('git', ['clone', ...remote.split(' '), tempDir.scaffold]);  fs.removeSync(path.join(tempDir.scaffold, '.git'));  if ( fs.existsSync(path.join(tempDir.scaffold, 'lowcode.scaffold.config.json'))  ) { return fs.readJSONSync(   path.join(tempDir.scaffold, 'lowcode.scaffold.config.json'), );  }  return {};};
  3. webview 拿到 formSchema 后弹框渲染动静表单,点提交后将动静表单数据以及生成目录等信息传给插件后盾。
  4. 插件后盾拿到表单数据后,到长期目录中依据 conditionFiles 配置删除掉不须要的文件。而后依据表单数据编译所有 ejs 文件,最初将所有文件拷贝到生成目录。

    export const compileScaffold = async (model: any, createDir: string) => {  if ( fs.existsSync(path.join(tempDir.scaffold, 'lowcode.scaffold.config.json'))  ) { const config = fs.readJSONSync(   path.join(tempDir.scaffold, 'lowcode.scaffold.config.json'), ); const excludeCompile: string[] = config.excludeCompile || []; if (config.conditionFiles) {   Object.keys(model).map((key) => {     if (       config.conditionFiles[key] &&       config.conditionFiles[key].value === model[key] &&       Array.isArray(config.conditionFiles[key].exclude)     ) {       config.conditionFiles[key].exclude.map((exclude: string) => {         fs.removeSync(path.join(tempDir.scaffold, exclude));       });     }   }); } await renderEjsTemplates(model, tempDir.scaffold, excludeCompile); fs.removeSync(path.join(tempDir.scaffold, 'lowcode.scaffold.config.json'));  }  fs.copySync(tempDir.scaffold, createDir);};
本地调试时,就是在步骤 2 中将抉择的文件夹内容或者以后 vscode 关上的我的项目内容拷贝到长期工作目录。

下集再说插件其余性能,插件源码:https://github.com/lowcoding/lowcode-vscode