从 Checkstyle config with M2E 为 Eclipse Formatter 自动配置制表符

Posted 2023-02-21

【中文标题】从 Checkstyle config with M2E 为 Eclipse Formatter 自动配置制表符

【英文标题】：Configure automatically tab character for Eclipse Formatter from Checkstyle config with M2E

【发布时间】：2016-04-08 02:05:19

【问题描述】：

我想完全和自动配置我的代码格式化程序关于我的checkstyle 配置，已经外部化。它几乎可以工作...... 但不完全：至少制表符不会反映在 Eclipse Formatter 中。

配置

工具

我已经在使用以下工具和插件

maven (3.3+) & eclipse 4.5 显然 用于 Eclipse 的 checkstyle 插件，等等 checkstyle 6.11.1 M2E 的 checkstyle 配置 (1.0.0.201503101518) maven-checkstyle-plugin2.17

结构

这是一个深度多模块分层项目。主要思想是 checkstyle 配置被外部化（在 fmk-qa 中）并在 fmk-core 中被称为依赖项。

fmk-parent
|-- fmk-core
|   |-- fmk-front
|   |   |-- front-sub1
|   |   |-- front-sub2
|   |   |-- ...
|   |   `-- pom.xml
|   |-- fmk-back
|   |   |-- back-sub1
|   |   |-- back-sub2
|   |   |-- ...
|   |   `-- pom.xml
|   |-- fmk-commons
|   |   `-- pom.xml
|   `-- pom.xml
`-- fmk-qa
    |-- pom.xml
    `-- checkstyle-config.xml

配置

Maven 父配置

[...]

<build>
    <pluginManagement>
        <plugins>
        <!-- Checkstyle Dependency where configuration is externalized  -->
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-checkstyle-plugin</artifactId>
                <version>2.17</version>
                <dependencies>
                    <dependency>
                        <groupId>corp.framework</groupId>
                        <artifactId>fmk-qa</artifactId>
                        <version>$project.version</version>
                    </dependency>
                </dependencies>
            </plugin>
            [...]
        <plugins>
    <pluginManagement>

核心项目配置

<build>

<plugins>

    <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-checkstyle-plugin</artifactId>

        <configuration>
            <configLocation>checkstyle-config.xml</configLocation>
        </configuration>

        <!-- Binding to indicate to M2E that it should trigger analysis in Eclipse -->
        <executions>
            <execution>
                <id>validate</id>
                <phase>validate</phase>
                <configuration>
                    <configLocation>checkstyle-config.xml</configLocation>
                    <failsOnError>false</failsOnError>
                    <linkXRef>true</linkXRef>
                </configuration>
                <goals>
                    <goal>check</goal>
                </goals>
            </execution>
        </executions>

        <inherited>true</inherited>
    </plugin>

检查样式配置

<module name = "Checker">
[...]
<!-- Checks for whitespace                               -->
<!-- See http://checkstyle.sf.net/config_whitespace.html -->
    <module name="FileTabCharacter">
        <property name="eachLine" value="true"/>
    </module>
    [...]
</module>

到目前为止的工作原理

Eclipse 会自动检测一堆东西并配置它们，也就是说

在导入期间将 CheckstyleNature 添加到项目中（感谢 m2e 和良好的 maven 绑定） 触发检查样式分析 直接在 Java 编辑器中报告错误 当我触发格式化时格式化代码......几乎就像我想要的那样

（这也适用于 PMD 和 FindBugs）。

什么不起作用

当我尝试自动格式化代码（CTRL+SHIFT+F）时，它会格式化代码，但是用制表符替换空格，这显然不是我想要的。

我怎样才能告诉 自动 eclipse 如何实现 正确 ？

我显然不想让开发人员单独配置它。 此外，我知道我可以根据 Checkstyle 配置 (How to generate an Eclipse formatter configuration from a checkstyle configuration?) 手动生成代码格式化程序。所以希望可以通过插件自动实现。

欢迎所有建议，即使是“预先设置的工作区分布”，即使我正在寻找更复杂的解决方案。我也准备好看看（这可能是我自己的答案）：这还不可能，你自己做，为社区做贡献；）

【参考方案1】：

不是开箱即用的。因此，您最好的选择是向m2e-code-quality Plugin 提交增强请求，使其在 Eclipse 中导入或更新项目时在其M2Eclipse's project configurator 中生成 Eclipse 格式化程序配置。