Einführung

Ursprünglich hat jedes Teammitglied das Format in der IDE festgelegt und das Format ausgeführt. Es wäre schön, wenn es beim Formatieren auf Github automatisch formatiert würde. Also habe ich es eingeführt, also werde ich die Methode zusammenfassen.

1. Maven-Einstellungen

Dieses Mal verwenden wir das Formatierer-Maven-Plugin.

1.1. Plugin zu pom.xml hinzugefügt.

<project ...>
    ...
    <plugins>
      <plugin>
        <groupId>net.revelc.code.formatter</groupId>
        <artifactId>formatter-maven-plugin</artifactId>
        <version>2.11.0</version>
      </plugin>
    </plugins>
    ...
</project>

Nach dem Einstellen können Sie das Format ausführen oder mit dem folgenden Befehl validieren.

//Format ausführen
mvn formatter:format
//prüfen
mvn formatter:validate

1.2. Verzeichniseinstellungen

Wenn Sie ein anderes Verzeichnis als src / main / java oder src / test / java angeben

<plugin>
  <groupId>net.revelc.code.formatter</groupId>
  <artifactId>formatter-maven-plugin</artifactId>
  <version>2.11.0</version>
  <configuration>
    <directories>
      <directory>${project.build.sourceDirectory}</directory>
      <directory>${project.build.directory}/generated-sources</directory>
    </directories>
  </configuration>
</plugin>

Wenn Sie ein Verzeichnis oder eine Datei in src / main / java oder src / test / java angeben

--inklusive: Verzeichnisse und Dateien, auf die Sie abzielen möchten --exclus: Verzeichnisse und Dateien, die Sie ausschließen möchten ** Hinweis: Schreiben Sie richtig bis / **

<plugin>
  <groupId>net.revelc.code.formatter</groupId>
  <artifactId>formatter-maven-plugin</artifactId>
  <version>2.11.0</version>
  <configuration>
    <includes>
      <include>jp/****/****/****/formatter/</include>
    </includes>
    <excludes>
      <exclude>jp/relativitas/maven/plugins/formatter/special/</exclude>
      <exclude>**/*Test.java</exclude>
    </excludes>
  </configuration>
</plugin>

1.3. Dateieinstellungen formatieren

Um Ihr eigenes Format festzulegen, müssen Sie eine Konfigurationsdatei für das Eclipse-Format angeben. Die Empfehlung lautet von Google veröffentlichtes Format.

<plugin>
  <groupId>net.revelc.code.formatter</groupId>
  <artifactId>formatter-maven-plugin</artifactId>
  <version>2.11.0</version>
  <configuration>
    <configFile>${project.basedir}/eclipse-java-google-style.xml</configFile>
  </configuration>
</plugin>

2. Einstellungen für Github-Aktionen

2.1. Erstellen einer YAML-Datei

Erstellen Sie eine YAML-Datei in .github / workflows /. Die Ausführungsinhalte sind die folgenden drei.

Code-Format --Überprüfen Sie nach dem Format
Commit für formatierten Code

 name: auto-format
on:
  push:
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Set up JDK 1.8
        uses: actions/setup-java@v1
        with:
          java-version: 1.8
      - name: format
        run: |
          mvn formatter:format
          mvn formatter:validate
      - uses: stefanzweifel/[email protected]
        with:
          commit_message: Formatted code

abschließend

Mit den obigen Einstellungen wird ein festgeschriebenes Commit erstellt, wenn der Code an github gesendet wird. Dies verhindert, dass Sie das Format lokal vergessen, und Sie können bequem Codeüberprüfungen durchführen.

[JAVA] Automatisieren Sie das Format mit dem Maven-Formatierer