IntelliJ Elm 插件使用教程

2024-08-20 12:10:37作者：滑思眉Philip

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

IntelliJ Elm 插件的 GitHub 仓库目录结构如下：

intellij-elm/
├── build.gradle
├── CHANGELOG.md
├── gradle
│   └── wrapper
│       ├── gradle-wrapper.jar
│       └── gradle-wrapper.properties
├── gradle.properties
├── gradlew
├── gradlew.bat
├── LICENSE
├── README.md
├── resources
│   └── META-INF
│       └── plugin.xml
├── settings.gradle
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── klazuka
    │   │           └── intellij
    │   │               └── elm
    │   │                   ├── actions
    │   │                   ├── codeInspection
    │   │                   ├── codeInsight
    │   │                   ├── ElmFileType.java
    │   │                   ├── ElmIcons.java
    │   │                   ├── ElmLanguage.java
    │   │                   ├── ElmLightPlatformCodeInsightFixtureTestCase.java
    │   │                   ├── ElmParserDefinition.java
    │   │                   ├── ElmProjectComponent.java
    │   │                   ├── ElmStructureViewModel.java
    │   │                   ├── ElmTestUtil.java
    │   │                   ├── ElmUtil.java
    │   │                   ├── ElmVisitor.java
    │   │                   ├── framework
    │   │                   ├── intentions
    │   │                   ├── lang
    │   │                   ├── psi
    │   │                   ├── refactoring
    │   │                   ├── run
    │   │                   ├── settings
    │   │                   ├── spellchecker
    │   │                   ├── tree
    │   │                   └── util
    │   └── resources
    │       └── com
    │           └── klazuka
    │               └── intellij
    │                   └── elm
    │                       ├── elm.bnf
    │                       ├── elm.flex
    │                       ├── elm.parsing.bnf
    │                       ├── elm.parsing.flex
    │                       ├── elm.parsing.psi.xml
    │                       ├── elm.psi.xml
    │                       ├── elm.tree.structure.xml
    │                       └── elm.xml
    └── test
        ├── java
        │   └── com
        │       └── klazuka
        │           └── intellij
        │               └── elm
        │                   ├── ElmCodeInsightFixtureTestCase.java
        │                   ├── ElmParsingTest.java
        │                   ├── ElmPsiTest.java
        │                   ├── ElmStructureViewTest.java
        │                   └── ElmTestUtil.java
        └── resources
            └── testData
                ├── codeInsight
                ├── parsing
                ├── psi
                └── structureView

目录结构介绍

build.gradle：Gradle 构建脚本。
CHANGELOG.md：项目更新日志。
gradle：Gradle 包装器相关文件。
gradle.properties：Gradle 属性文件。
gradlew 和 gradlew.bat：Gradle 包装器脚本。
LICENSE：项目许可证。
README.md：项目说明文档。
resources：插件资源文件，包括 plugin.xml 插件描述文件。
settings.gradle：Gradle 设置文件。
src：源代码目录，包含主代码和测试代码。

2. 项目的启动文件介绍

IntelliJ Elm 插件的启动文件主要是 plugin.xml，位于 resources/META-INF/ 目录下。该文件是插件的描述文件，包含了插件的基本信息、依赖关系、扩展点等。

plugin.xml 文件内容示例

<idea-plugin>
    <id>com.klazuka.intellij.elm</id>
    <name>Elm</name>
    <version>1.0</version>
    <vendor email="support@example.com" url="http://example.com">Your Company</vendor>

    <description><![CDATA[
        Elm language support for IntelliJ IDEA.
    ]]></description>

    <change-notes><![CDATA[
        Initial release of the Elm plugin.
    ]]></change-notes>

    <depends>com.intellij.modules.platform</depends>