提到腳手架，大家想到的可能就是各種 xxx-cli，本文介紹的是另一種方式：以 vscode 插件的形式實現(xiàn)，提供 web 可視化操作，如下圖：
創(chuàng)新互聯(lián)公司專注于青秀企業(yè)網站建設,成都響應式網站建設,電子商務商城網站建設。青秀網站建設公司,為青秀等地區(qū)提供建站服務。全流程按需制作網站，專業(yè)設計，全程項目跟蹤，創(chuàng)新互聯(lián)公司專業(yè)和態(tài)度為您提供的服務
下面介紹如何安裝使用，以及實現(xiàn)原理。
vscode 安裝 lowcode 插件，此插件是一個效率工具，腳手架只是其中一個功能，更多功能可以查看文檔，這集只講腳手架相關的。
插件安裝之后，打開腳手架界面，步驟如下圖：
可以直接使用分享的腳手架，勾選選項后直接創(chuàng)建即可：
在模板項目根目錄下創(chuàng)建 lowcode.scaffold.config.json 文件，將需要做內容動態(tài)替換的文件加上 .ejs 后綴。
ejs 語法
一個完整 lowcode.scaffold.config.json 配置：
重慶分公司
重慶分公司
{
"formSchema": {
"schema": {
"type": "object",
"ui:displayType": "row",
"ui:showDescIcon": true,
"properties": {
"port": {
"title": "監(jiān)聽端口",
"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，會根據(jù) schema 構建出表單界面，formSchema.formData 為表單默認數(shù)據(jù)
創(chuàng)建項目的時候會將表單數(shù)據(jù)傳入 ejs 模板中進行編譯。
excludeCompile：配置不需要經過 ejs 編譯的文件夾或文件。
conditionFiles：根據(jù)表單項的值，在創(chuàng)建項目的時候將某些文件夾或文件刪除，比如：
"conditionFiles": {
"noREADME": {
"value": true,
"exclude": ["README.md.ejs"]
},
"lint": {
"value": false,
"exclude": [".eslintrc.js", ".prettierrc.js"]
}
}
當 lint 這個表單項的值為 false 的時候，配置的文件夾或文件 ".eslintrc.js"，".prettierrc.js"，將會在創(chuàng)建的項目中排除掉。
https://github.com/lowcode-scaffold/lowcode-mock
將腳手架提交到 git 倉庫，注意開放項目的公開訪問權限。
注意使用 clone 地址，支持指定分支，比如
-b master https://github.com/lowcode-scaffold/lowcode-mock.git
修改 倉庫 中 index.json 內容，提交 pr。
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 {};
};
formSchema 后彈框渲染動態(tài)表單，點提交后將動態(tài)表單數(shù)據(jù)以及生成目錄等信息傳給插件后臺。conditionFiles 配置刪除掉不需要的文件。然后根據(jù)表單數(shù)據(jù)編譯所有 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
