비계도 플러그인 형태로 제공됩니다! 다음 글에서는 vscode 플러그인 비주얼 제작 및 관리 스캐폴딩과 원리 분석에 대해 소개하겠습니다.
스캐폴딩에 관해서는 다양한 xxx-cli를 생각할 수 있습니다. 이 기사에서는 아래와 같이 웹 시각적 작업을 제공하기 위해 vscode 플러그인 형태로 구현되는 다른 방법을 소개합니다.
아래에는 설치 및 사용 방법과 구현 원리를 소개합니다.
vscode를 사용하여 lowcode 플러그인을 설치하세요. 이 플러그인은 효율성 도구 중 하나일 뿐이며, 더 많은 기능을 보려면 문서를 확인하세요. 단지 비계에 대해서만 이야기합니다. [추천 학습: "vscode 입문 튜토리얼"]
플러그인이 설치된 후 스캐폴딩 인터페이스를 열면 단계는 다음과 같습니다.
공유 스캐폴딩을 직접 사용할 수 있으며 옵션을 확인하고 직접 생성하세요:
템플릿 프로젝트의 루트 디렉터리에 lowcode.scaffold.config.json
파일을 생성하고 .ejs를 추가하세요. code>를 동적으로 교체해야 하는 파일에 추가합니다. <code>lowcode.scaffold.config.json
文件,将需要做内容动态替换的文件加上 .ejs
后缀。
ejs 语法:
https://ejs.bootcss.com/
配置
一个完整 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
ejs 구문: 🎜🎜https://ejs.bootcss.com/🎜🎜🎜🎜🎜구성🎜🎜🎜완전한 <코드> lowcode.scaffold.config.json 구성: 🎜
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
: 🎜🎜formSchema.schema
for x-render 양식 디자이너🎜 내보낸 스키마는 스키마를 기반으로 양식 인터페이스를 구축합니다. < 코드 >formSchema.formData는 양식의 기본 데이터입니다🎜🎜🎜🎜프로젝트를 생성할 때 양식 데이터는 컴파일을 위해 ejs 템플릿으로 전달됩니다. 🎜🎜excludeCompile
: ejs로 컴파일할 필요가 없는 폴더나 파일을 구성합니다. 🎜🎜conditionFiles
: 다음과 같이 양식 항목의 값을 기반으로 프로젝트를 생성할 때 특정 폴더나 파일을 삭제합니다. 🎜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); };
lint
값이 false
인 경우 구성된 폴더 또는 ".eslintrc.js" 및 ".prettierrc.js" 파일이 생성된 프로젝트에서 제외됩니다. 🎜🎜🎜로컬 디버깅 스캐폴딩🎜🎜🎜🎜🎜🎜참조 프로젝트🎜🎜🎜https ://github.com/lowcode-scaffold/lowcode-mock🎜
🎜사용에 주의하세요 클론 주소, -b master https://github.com/lowcode-scaffold/lowcode-mock.git
와 같은 지점 지정 지원, 내부 개인 창고도 사용할 수 있습니다🎜
🎜🎜🎜🎜< span style="max-width:90%">빠른 생성을 위해 템플릿 목록에 공유🎜🎜🎜🎜🎜수정저장소 🎜 index.json
콘텐츠, PR을 제출하세요. 🎜打开 webview 的时候从 cdn 拉取记录了脚手架列表的 json 文件,渲染列表视图。
点击某个脚手架,将脚手架的 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 {}; };
webview 拿到 formSchema
后弹框渲染动态表单,点提交后将动态表单数据以及生成目录等信息传给插件后台。
插件后台拿到表单数据后,到临时目录中根据 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
原文地址:https://juejin.cn/post/7080787567192309797
作者:若邪
更多关于VSCode的相关知识,请访问:vscode教程!!
위 내용은 비계도 플러그인 형태로 제공됩니다! vscode는 스캐폴딩 플러그인을 구현합니다.의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!