VSCode DotENV 扩展使用教程

VSCode DotENV 扩展使用教程

vscode-dotenvDotENV extension for vscode with 1M+ installs项目地址:https://gitcode.com/gh_mirrors/vs/vscode-dotenv

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

vscode-dotenv/
├── .github/
│   └── workflows/
│       └── ci.yml
├── images/
│   └── icon.png
├── src/
│   ├── test/
│   │   └── extension.test.ts
│   ├── extension.ts
│   └── package.json
├── .gitignore
├── .vscodeignore
├── CHANGELOG.md
├── LICENSE
├── README.md
└── package.json

• .github/workflows/ci.yml: GitHub Actions 的 CI 配置文件。
• images/icon.png: 扩展的图标文件。
• src/test/extension.test.ts: 扩展的测试文件。
• src/extension.ts: 扩展的主逻辑文件。
• src/package.json: 扩展的元数据文件，包含依赖和脚本。
• .gitignore: Git 忽略文件配置。
• .vscodeignore: VSCode 打包时忽略的文件配置。
• CHANGELOG.md: 版本变更日志。
• LICENSE: 许可证文件。
• README.md: 项目说明文档。
• package.json: 项目的主配置文件，包含扩展的名称、版本、依赖等信息。

2. 项目的启动文件介绍

项目的启动文件是 src/extension.ts。这个文件包含了扩展的主要逻辑，当用户在 VSCode 中打开一个 .env 文件时，这个文件会被执行，从而实现对 .env 文件的语法高亮和其他功能。

3. 项目的配置文件介绍

项目的配置文件是 package.json。这个文件包含了扩展的所有元数据和配置信息，例如：

• name: 扩展的名称。
• version: 扩展的版本号。
• publisher: 扩展的发布者。
• engines: 扩展支持的 VSCode 版本。
• activationEvents: 扩展的激活事件，例如 onLanguage:dotenv 表示在打开 .env 文件时激活扩展。
• contributes: 扩展的贡献点，例如语法高亮、命令等。

{
  "name": "vscode-dotenv",
  "version": "1.0.0",
  "publisher": "mikestead",
  "engines": {
    "vscode": "^1.50.0"
  },
  "activationEvents": [
    "onLanguage:dotenv"
  ],
  "contributes": {
    "languages": [{
      "id": "dotenv",
      "extensions": [
        ".env"
      ]
    }],
    "grammars": [{
      "language": "dotenv",
      "scopeName": "source.env",
      "path": "./syntaxes/dotenv.tmLanguage.json"
    }]
  }
}

通过这些配置，VSCode 可以正确地识别和处理 .env 文件，并提供相应的语法高亮和其他功能。

vscode-dotenvDotENV extension for vscode with 1M+ installs项目地址:https://gitcode.com/gh_mirrors/vs/vscode-dotenv