如何通过Vscode插件高效可视化构建和管理脚手架并解析其原理？

2026-05-19 17:301阅读0评论SEO资源

内容介绍
文章标签
相关推荐

本文共计1107个文字，预计阅读时间需要5分钟。

提到脚手架，大家可能想到的是各种+xxx-cli工具，这些是大家熟悉的命令行方式。而另一种介绍方式则是通过+vscode+插件的形式，提供可视化操作，如图所示：

![可视化操作示例图]

下面介绍如何安装和使用，以及实现原理。

安装使用：

1.打开VSCode。

2.点击左侧的扩展图标，搜索并安装相应的插件。

3.安装完成后，在VSCode中即可使用该插件提供的功能。

实现原理：

该插件通过扩展VSCode的功能，将原本需要通过命令行操作的工具，转化为可视化的界面操作。用户可以通过界面选择不同的功能，插件内部则调用相应的命令行工具，实现所需的功能。

提到脚手架，大家想到的可能就是各种 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" }, "github.com/lowcode-scaffold/lowcode-mock


发布脚手架
将脚手架提交到 git 仓库，注意开放项目的公开访问权限。
使用脚手架
直接使用 git 仓库地址


注意使用 clone 地址，支持指定分支，比如 -b master github.com/lowcode-scaffold/lowcode-mock.git


分享到模板列表中快速创建

修改 仓库 中 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 打开的项目内容拷贝到临时工作目录。


下集再说插件其他功能，插件源码：github.com/lowcoding/lowcode-vscode

标签：使用vscode插件可视化制作

本文共计1107个文字，预计阅读时间需要5分钟。

提到脚手架，大家可能想到的是各种+xxx-cli工具，这些是大家熟悉的命令行方式。而另一种介绍方式则是通过+vscode+插件的形式，提供可视化操作，如图所示：

![可视化操作示例图]

下面介绍如何安装和使用，以及实现原理。

安装使用：

1.打开VSCode。

2.点击左侧的扩展图标，搜索并安装相应的插件。

3.安装完成后，在VSCode中即可使用该插件提供的功能。

实现原理：

该插件通过扩展VSCode的功能，将原本需要通过命令行操作的工具，转化为可视化的界面操作。用户可以通过界面选择不同的功能，插件内部则调用相应的命令行工具，实现所需的功能。
提到脚手架，大家想到的可能就是各种 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"
				},
				"github.com/lowcode-scaffold/lowcode-mock

发布脚手架
将脚手架提交到 git 仓库，注意开放项目的公开访问权限。
使用脚手架
直接使用 git 仓库地址


注意使用 clone 地址，支持指定分支，比如 -b master github.com/lowcode-scaffold/lowcode-mock.git


分享到模板列表中快速创建

修改 仓库 中 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 打开的项目内容拷贝到临时工作目录。


下集再说插件其他功能，插件源码：github.com/lowcoding/lowcode-vscode

标签：使用vscode插件可视化制作

相关推荐

相关推荐

`相关推荐`

`相关推荐`