开源项目 `idea-gitignore` 使用教程

开源项目 idea-gitignore 使用教程

idea-gitignore项目地址:https://gitcode.com/gh_mirrors/ide/idea-gitignore

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

idea-gitignore 项目的目录结构如下：

idea-gitignore/
├── .github/
│   └── workflows/
│       └── main.yml
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── github/
│   │   │           └── hsz/
│   │   │               └── gitignore/
│   │   │                   ├── actions/
│   │   │                   ├── completion/
│   │   │                   ├── exceptions/
│   │   │                   ├── generators/
│   │   │                   ├── icons/
│   │   │                   ├── index/
│   │   │                   ├── lang/
│   │   │                   ├── model/
│   │   │                   ├── settings/
│   │   │                   ├── ui/
│   │   │                   └── utils/
│   │   └── resources/
│   │       └── META-INF/
│   │           └── plugin.xml
│   └── test/
│       └── java/
│           └── com/
│               └── github/
│                   └── hsz/
│                       └── gitignore/
│                           └── tests/
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
└── build.gradle

目录结构介绍

• .github/workflows/main.yml: GitHub Actions 的工作流配置文件。
• src/main/java/com/github/hsz/gitignore/: 项目的主要代码目录，包含各种功能模块的实现。
• src/main/resources/META-INF/plugin.xml: 插件的配置文件。
• src/test/java/com/github/hsz/gitignore/tests/: 项目的测试代码目录。
• .gitignore: Git 忽略文件配置。
• .travis.yml: Travis CI 的配置文件。
• LICENSE: 项目的许可证文件。
• README.md: 项目的说明文档。
• build.gradle: 项目的构建配置文件。

2. 项目的启动文件介绍

项目的启动文件主要是 src/main/resources/META-INF/plugin.xml，这是一个 IntelliJ IDEA 插件的配置文件。它定义了插件的名称、版本、作者、依赖关系以及插件的主要功能和入口点。

plugin.xml 主要内容

<idea-plugin>
    <id>com.github.hsz.gitignore</id>
    <name>Gitignore</name>
    <version>4.2.0</version>
    <vendor email="hsz@hsz.mobi" url="http://hsz.mobi">Jakub Chrzanowski</vendor>

    <description><![CDATA[
        Gitignore support for IntelliJ IDEs.
    ]]></description>

    <change-notes><![CDATA[
        <p>4.2.0</p>
        <ul>
            <li>Added support for new .gitignore templates</li>
            <li>Fixed various bugs</li>
        </ul>
    ]]></change-notes>

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

    <extensions defaultExtensionNs="com.intellij">
        <applicationService serviceImplementation="com.github.hsz.gitignore.settings.IgnoreSettings"/>
        <applicationConfigurable parentId="tools" instance="com.github.hsz.gitignore.settings.IgnoreConfigurable" id="com.github.hsz.gitignore.settings.IgnoreConfigurable" displayName="Gitignore"/>
    </extensions>

    <actions>
        <action id="com.github.hsz.gitignore.actions.NewIgnoreFileAction" class="com.github.hsz.gitignore.actions.NewIgnoreFileAction" text="New .gitignore File" description="Create new .gitignore file">
            <add-to-group group-id="NewGroup" anchor="last"/>
        </action>
    </actions>
</idea-plugin>

3. 项目的配置文件介绍

项目的配置文件主要包括 build.gradle 和 src/main/resources/META-INF/plugin.xml。

build.gradle

idea-gitignore项目地址:https://gitcode.com/gh_mirrors/ide/idea-gitignore