GrepConsole 插件使用教程

GrepConsole 插件使用教程

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

GrepConsole 是一个 IntelliJ IDEA 插件，用于在控制台中进行日志的过滤和高亮显示。以下是项目的目录结构介绍：

GrepConsole/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── krasa/
│   │   │   │   │   ├── grepconsole/
│   │   │   │   │   │   ├── action/
│   │   │   │   │   │   ├── filter/
│   │   │   │   │   │   ├── gui/
│   │   │   │   │   │   ├── plugin/
│   │   │   │   │   │   ├── settings/
│   │   │   │   │   │   ├── utils/
│   │   │   │   │   │   └── ...
│   │   │   └── ...
│   │   └── resources/
│   │       └── META-INF/
│   │           └── plugin.xml
│   └── test/
│       └── java/
│           └── com/
│               └── krasa/
│                   └── grepconsole/
│                       └── ...
├── .gitignore
├── .travis.yml
├── LICENSE
├── README.md
└── ...

目录结构说明

• src/main/java/com/krasa/grepconsole/：包含插件的主要代码，包括动作、过滤器、图形界面、插件配置、设置和工具类等。
• src/main/resources/META-INF/plugin.xml：插件的配置文件，定义了插件的元数据和依赖关系。
• src/test/java/com/krasa/grepconsole/：包含插件的测试代码。
• .gitignore：Git 忽略文件列表。
• .travis.yml：Travis CI 配置文件。
• LICENSE：项目的许可证文件。
• README.md：项目的说明文档。

2. 项目的启动文件介绍

GrepConsole 插件的启动文件是 plugin.xml，位于 src/main/resources/META-INF/ 目录下。该文件定义了插件的元数据、依赖关系和启动配置。

plugin.xml 文件内容示例

<idea-plugin>
    <id>com.krasa.grepconsole</id>
    <name>Grep Console</name>
    <version>8.3.162</version>
    <vendor email="support@example.com" url="http://example.com">Your Company</vendor>

    <description><![CDATA[
        Grep Console is an IntelliJ IDEA plugin that allows you to filter and highlight logs in the console.
    ]]></description>

    <change-notes><![CDATA[
        Version 8.3.162: Added new features and fixed bugs.
    ]]></change-notes>

    <idea-version since-build="191"/>

    <extensions defaultExtensionNs="com.intellij">
        <!-- 定义插件的扩展点 -->
    </extensions>

    <actions>
        <!-- 定义插件的动作 -->
    </actions>
</idea-plugin>

启动文件说明

• <id>：插件的唯一标识符。
• <name>：插件的名称。
• <version>：插件的版本号。
• <vendor>：插件的提供者信息。
• <description>：插件的描述信息。
• <change-notes>：插件的更新日志。
• <idea-version>：插件支持的 IntelliJ IDEA 版本。
• <extensions>：定义插件的扩展点。
• <actions>：定义插件的动作。

3. 项目的配置文件介绍

GrepConsole 插件的配置文件主要包括 plugin.xml 和用户在 IntelliJ IDEA 中的设置。

plugin.xml 配置文件

如上所述，plugin.xml 文件定义了插件的元数据和启动配置。

用户设置

用户可以在 IntelliJ IDEA 的设置界面中配置 GrepConsole 插