VSCode Elm 插件项目教程

VSCode Elm 插件项目教程

vscode-elm-old 项目地址: https://gitcode.com/gh_mirrors/vsc/vscode-elm

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

vscode-elm/
├── examples/
├── images/
├── schemas/
├── snippets/
├── src/
├── syntaxes/
├── test/
├── typings/
├── .gitignore
├── .travis.yml
├── .vscodeignore
├── CHANGELOG.md
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE.txt
├── README.md
├── elm.configuration.json
├── package.json
├── tsconfig.json
├── tslint.json
├── typings.json
└── yarn.lock

目录结构介绍

• examples/: 包含示例代码文件。
• images/: 包含项目中使用的图片文件。
• schemas/: 包含项目的JSON Schema文件。
• snippets/: 包含代码片段文件。
• src/: 包含项目的源代码文件。
• syntaxes/: 包含语法高亮文件。
• test/: 包含项目的测试文件。
• typings/: 包含TypeScript类型定义文件。
• .gitignore: Git忽略文件配置。
• .travis.yml: Travis CI配置文件。
• .vscodeignore: VSCode忽略文件配置。
• CHANGELOG.md: 项目更新日志。
• CODE_OF_CONDUCT.md: 项目行为准则。
• CONTRIBUTING.md: 项目贡献指南。
• LICENSE.txt: 项目许可证。
• README.md: 项目介绍和使用说明。
• elm.configuration.json: Elm配置文件。
• package.json: Node.js项目配置文件。
• tsconfig.json: TypeScript配置文件。
• tslint.json: TSLint配置文件。
• typings.json: TypeScript类型定义配置文件。
• yarn.lock: Yarn包管理器锁定文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/ 目录下的源代码文件。这些文件负责插件的核心功能实现，包括语法高亮、代码补全、错误检查等。

3. 项目的配置文件介绍

elm.configuration.json

这个文件包含了Elm编译器和相关工具的配置信息，例如：

{
  "elm.compiler": "/node_modules/bin/elm",
  "elm.makeCommand": "/node_modules/bin/elm-make"
}

package.json

这个文件是Node.js项目的配置文件，包含了项目的依赖、脚本命令等信息。例如：

{
  "name": "vscode-elm",
  "version": "1.0.0",
  "dependencies": {
    "elm": "^0.19.0"
  },
  "scripts": {
    "build": "tsc",
    "test": "jest"
  }
}

tsconfig.json

这个文件是TypeScript的配置文件，定义了TypeScript编译器的选项。例如：

{
  "compilerOptions": {
    "target": "ES6",
    "module": "commonjs",
    "strict": true
  }
}

tslint.json

这个文件是TSLint的配置文件，定义了代码风格检查的规则。例如：

{
  "rules": {
    "no-console": false,
    "indent": [true, "spaces", 2]
  }
}

通过以上配置文件，可以对项目进行编译、测试和代码风格检查等操作。

vscode-elm-old 项目地址: https://gitcode.com/gh_mirrors/vsc/vscode-elm