Vuerd-vscode 项目启动与配置教程

1. 项目的目录结构及介绍

Vuerd-vscode 是一个基于 Visual Studio Code 的 ERD (Entity-Relationship Diagram) 编辑器扩展。以下是项目的目录结构及其简要介绍：

• .github/：存放 GitHub 仓库的配置文件，例如 issue 模板和行动工作流。
• .vscode/：包含 Visual Studio Code 的配置文件。
• img/：存储项目相关的图像文件。
• src/：源代码目录，包含扩展的主要逻辑和资源。
• static/：静态文件目录，可能包含静态资源如样式表或脚本。
• .eslintignore：ESLint 忽略文件，指定哪些文件不进行语法检查。
• .eslintrc.json：ESLint 配置文件，定义了代码语法检查的规则。
• .gitignore：Git 忽略文件，指定哪些文件和目录不进行版本控制。
• .gitmodules：如果项目包含子模块，此文件会列出它们。
• .prettierrc.json：Prettier 配置文件，用于代码格式化。
• .vscodeignore：Visual Studio Code 忽略文件，指定哪些文件不显示在工作区中。
• LICENSE：项目的许可文件，本项目采用 MIT 许可。
• README.md：项目的自述文件，包含项目描述、安装和使用说明。
• package-lock.json：npm 的依赖锁定文件，确保安装的依赖与锁定版本一致。
• package.json：项目的包描述文件，定义了项目的依赖、脚本和元数据。
• rollup.config.js：Rollup 打包配置文件，用于构建和打包扩展。
• tsconfig.json：TypeScript 配置文件，定义了项目的 TypeScript 编译选项。

2. 项目的启动文件介绍

项目的启动主要是通过 Visual Studio Code 扩展市场来安装 Vuerd-vscode 扩展。用户可以从 Visual Studio Code 的扩展市场中搜索 vuerd-vscode 并安装它。

安装完成后，可以在 Visual Studio Code 中通过以下步骤启动 ERD 编辑器：

1. 打开或创建一个新的 Visual Studio Code 项目。
2. 在 Visual Studio Code 中按下 Ctrl+Shift+P (或 Cmd+Shift+P 在 Mac 上) 打开命令面板。
3. 输入 Vuerd: Create New ERD File 并选择该命令。
4. 这将在项目中创建一个新的 ERD 文件，并在 Visual Studio Code 中打开 ERD 编辑器。

3. 项目的配置文件介绍

Vuerd-vscode 扩展的配置主要是通过 Visual Studio Code 的设置系统来完成的。以下是一些主要的配置文件和它们的用途：

• settings.json：Visual Studio Code 的用户设置文件，可以在这里自定义扩展的行为。例如，可以配置同步当前 Visual Studio Code 主题的设置，以及定义快捷键等。
• keymap.json：键盘快捷键配置文件，用户可以在这里定义或修改扩展的快捷键。

以下是一个 settings.json 的配置示例：

{
  "dineug.vuerd-vscode.themeSync": true,
  "dineug.vuerd-vscode.theme": {
    "keyPK": "#B4B400",
    "keyFK": "#dda8b1",
    "keyPFK": "#60b9c4",
    "edit": "#ffc107"
  }
}

在这个配置中，themeSync 设置为 true 表示同步当前的 Visual Studio Code 主题，而 theme 对象中的属性定义了不同的颜色设置。

要修改这些设置，可以在 Visual Studio Code 中按下 Ctrl+Comma (或 Cmd+, 在 Mac 上) 打开设置界面，然后搜索 vuerd-vscode 进行相应的配置修改。