如何在多个Maven项目间共享单个.editorconfig文件？

Great question—maintaining duplicate config files across multiple repos is such a headache, especially when you’re all working with the same tooling stack. Since you’re using Maven and IntelliJ, here are a few solid approaches to share a single .editorconfig across all your Java projects:

This method leverages Maven’s build lifecycle to automatically copy a shared .editorconfig to each project’s root during initialization. It’s cross-platform, works with CI/CD, and requires minimal setup for new team members.

How to set it up: #

1. Store your shared .editorconfig in a central location—either a dedicated "config" module in your existing repo, or publish it as a lightweight Maven artifact (packaged as a JAR with the config file in its resources).
2. Add this configuration to each project’s pom.xml:

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-resources-plugin</artifactId>
            <version>3.3.1</version>
            <executions>
                <execution>
                    <id>copy-shared-editorconfig</id>
                    <phase>initialize</phase>
                    <goals>
                        <goal>copy-resources</goal>
                    </goals>
                    <configuration>
                        <!-- Adjust this path to point to your shared .editorconfig -->
                        <resources>
                            <resource>
                                <directory>${project.parent.basedir}/shared-config</directory>
                                <includes>
                                    <include>.editorconfig</include>
                                </includes>
                            </resource>
                        </resources>
                        <!-- Output to the project root -->
                        <outputDirectory>${project.basedir}</outputDirectory>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

3. For IntelliJ users: Enable "Auto-Import" in Maven settings, and the IDE will pick up the copied .editorconfig automatically whenever you run a build. You can also manually run mvn initialize to generate the file right after cloning a repo.

If your team prefers avoiding build-time steps for local work, you can create symbolic links from each project’s root to a single shared .editorconfig file on your machine. Note that this is system-specific:

• Unix/Mac: Run ln -s /path/to/shared/.editorconfig /path/to/project/root/.editorconfig
• Windows (Command Prompt, admin): mklink .editorconfig C:\path\to\shared\.editorconfig
• Windows (PowerShell, admin): New-Item -ItemType SymbolicLink -Path .editorconfig -Target C:\path\to\shared\.editorconfig

Caveats: #

New team members will need to set up these links manually, and this won’t help with CI/CD environments unless you configure symlinks there too.

If you want to track changes to your .editorconfig in version control, put it in a dedicated Git repo and add it as a submodule or subtree to each project. This lets you update the config in one place and pull changes into all projects.

Quick setup: #

1. Create a new Git repo containing only your .editorconfig.
2. In each project, run git submodule add https://your-git-repo-url/editorconfig-shared.git
3. Either create a symlink from the submodule’s .editorconfig to the project root, or configure IntelliJ to recognize the submodule directory’s config (IntelliJ reads .editorconfig files hierarchically, so you may need to adjust the config to ensure it takes priority).

Caveats: #

Submodules add a bit of complexity for new team members (they’ll need to run git submodule update --init when cloning), and updating across all projects requires extra steps compared to the Maven approach.

Final Recommendation #

For your stack (Maven + IntelliJ), the Maven resource plugin approach is the most consistent—it works across all environments, requires minimal manual setup, and ensures every project has the latest config without duplicate files.

内容的提问来源于stack exchange，提问作者David DeMar