提到腳手架，大家想到的可能就是各種 xxx-cli蛋辈，本文介紹的是另一種方式：以 vscode 插件的形式實現(xiàn)瑟慈，提供 web 可視化操作，如下圖：
下面介紹如何安裝使用仔雷，以及實現(xiàn)原理蹂析。
安裝使用
vscode 安裝 lowcode 插件，此插件是一個效率工具碟婆，腳手架只是其中一個功能电抚，更多功能可以查看文檔，這集只講腳手架相關(guān)的竖共。
插件安裝之后蝙叛，打開腳手架界面，步驟如下圖：
可以直接使用分享的腳手架公给，勾選選項后直接創(chuàng)建即可：
制作腳手架
在模板項目根目錄下創(chuàng)建 lowcode.scaffold.config.json 文件借帘，將需要做內(nèi)容動態(tài)替換的文件加上 .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 表單設(shè)計器 導(dǎo)出的的 schema淌铐，會根據(jù) schema 構(gòu)建出表單界面肺然，formSchema.formData 為表單默認數(shù)據(jù)
創(chuàng)建項目的時候會將表單數(shù)據(jù)傳入 ejs 模板中進行編譯。
excludeCompile：配置不需要經(jīng)過 ejs 編譯的文件夾或文件腿准。
conditionFiles：根據(jù)表單項的值际起，在創(chuàng)建項目的時候?qū)⒛承┪募A或文件刪除，比如：
"conditionFiles": {
"noREADME": {
"value": true,
"exclude": ["README.md.ejs"]
},
"lint": {
"value": false,
"exclude": [".eslintrc.js", ".prettierrc.js"]
}
}
當(dāng) lint 這個表單項的值為 false 的時候，配置的文件夾或文件 ".eslintrc.js"街望，".prettierrc.js"校翔，將會在創(chuàng)建的項目中排除掉。
本地調(diào)試腳手架
參考模板
https://github.com/lowcode-scaffold/lowcode-mock
發(fā)布腳手架
將腳手架提交到 git 倉庫灾前，注意開放項目的公開訪問權(quán)限防症。
使用腳手架
直接使用 git 倉庫地址
注意使用 clone 地址，支持指定分支豫柬，比如
-b master https://github.com/lowcode-scaffold/lowcode-mock.git告希，內(nèi)部私有倉庫也可以使用
分享到模板列表中快速創(chuàng)建
修改 倉庫 中 index.json 內(nèi)容，提交 pr烧给。
實現(xiàn)原理
- 打開 webview 的時候從 cdn 拉取記錄了腳手架列表的 json 文件燕偶，渲染列表視圖。
- 點擊某個腳手架础嫡，將腳手架的 git 倉庫地址傳到插件后臺指么，插件后臺根據(jù) 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 {};
};
- webview 拿到
formSchema后彈框渲染動態(tài)表單伯诬，點提交后將動態(tài)表單數(shù)據(jù)以及生成目錄等信息傳給插件后臺。 - 插件后臺拿到表單數(shù)據(jù)后巫财，到臨時目錄中根據(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);
};
本地調(diào)試時赫舒，就是在步驟 2 中將選擇的文件夾內(nèi)容或者當(dāng)前 vscode 打開的項目內(nèi)容拷貝到臨時工作目錄。
下集再說插件其他功能闽瓢，插件源碼：https://github.com/lowcoding/lowcode-vscode
