Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

A non-converging file is skipped with a zero exit, so spotlessCheck reports success for a file it did not check

オープン
  • 何か問題がありますか？
#3,143 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
4/5
見積もり時間
3〜5日
初心者へのやさしさ
28/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
java
領域
build-system, ci-cd

調査の方向性

Start from the 'Skipping ... because it does not converge' message and find where the Gradle check task decides a non-converging file is skipped rather than failed. Reproduce with a markdown file that has a six-space-indented fenced block under a checklist item, using Prettier 3.9.6, then run spotlessMarkdownCheck. Done means a green check implies every target file was checked, through a failOnSkip-style option or a non-zero exit, and the maintainers still need to agree on the design first.

索引モデルが issue の本文から書いたものです。

説明

What happens

For a file the formatter cannot converge on, Spotless prints

Skipping '<path>' because it does not converge.  Run {@code spotlessDiagnose} to understand why

and the check task passes — exit 0, BUILD SUCCESSFUL. The file is neither formatted nor reported as a violation,
so a green spotlessCheck is not evidence about that file at all.

Why it matters

In CI the file is silently ungated: the gate reports success while the file may be arbitrarily unformatted. A formatter
or plugin bump can also turn a previously-formatted file non-convergent with no signal — the gate goes from green to
green. It took a review of ours to notice a file was being skipped, and only because the message happened to be read.

Reproduction

Spotless 8.10.4 (Gradle plugin), format("markdown") with Prettier pinned at 3.9.6 — the trigger: the same file
converges under 3.9.10, so a reader on 3.9.10 sees no skip:

  1. Add a markdown file whose fenced block is indented six spaces under a checklist item:

    - [ ] a task

      ```bash
      echo hi
      ```

  2. ./gradlew spotlessMarkdownCheck --rerun-tasks prints the Skipping '<path>' because it does not converge. line
    above and exits 0.

With Prettier 3.9.10 the same file converges and no skip is printed; with 3.9.6 it does not. So the trigger in this case
is a version difference, but the silent skip is the gap either way — nothing about the message or the exit status
distinguishes "checked and formatted" from "not checked".

What would help

A way to make a skip fail the check — a failOnSkip-style option on the check task, or a non-zero exit when a target
file was not checked. A warning would help a human but not CI; the property worth having is that a green check means
every target file was actually checked.

Related, but a different ask: #1689 reports a convergence failure for ktlint — that the formatter converge on a
construct, not that a skip be visible.

主要言語
Java
スター
5.7k
フォーク
562
平均マージ
3日 2時間
マージ済み PR（30日）
30

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

diffplug/spotless のほかの issue

diffplug/spotless の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。