[FEATURE] Add a virtual CodeFormatRule to stop silently swallowing formatting-only changes#430
Open
chrissonntag wants to merge 9 commits into
Open
[FEATURE] Add a virtual CodeFormatRule to stop silently swallowing formatting-only changes#430chrissonntag wants to merge 9 commits into
chrissonntag wants to merge 9 commits into
Conversation
- Add a CodeFormatRule label to AppliedRule (constant, factory, predicate) to represent a formatting-only change that has no backing rule class - Type the identifier precisely as class-string<FractorRule>|CodeFormatRule wherever it flows, and let the changelog extractor tolerate the label instead of reflecting on it as a real class - Count the label in the process result so a formatting-only change is reported and affects the dry-run exit code
- Add the CodeFormatRule to a file's applied rules whenever a processor changed it without attributing a real rule, or normalized the baseline, so a formatting-only reformat is reported and affects the exit code - Prove the runner attribution independently of any real processor with a plain-text fixture processor test
- Print "~ reformatted / normalized" for files whose only applied rule is the CodeFormatRule, instead of dumping a whole-file or empty diff
- Assert a pure XLIFF reformat is attributed to the CodeFormatRule, a real rule change to its own rule, and both when they occur together
- Assert the same CodeFormatRule attribution for the XML processor, which also reports a rule change and reformatting together
- Assert a pure TypoScript reformat is attributed to the CodeFormatRule while a rule change stays attributed to its own rule
- Re-print composer.json on every run so a formatting-only change (indentation) is reported instead of applied silently; the runner attributes it to the virtual CodeFormatRule - Keep a real rule attributed to itself; JSON has no comments, so the re-print round-trip preserves content - Cover the behaviour with a ComposerJsonProcessResult test (rule change, pure reformat, and an already-formatted no-op)
chrissonntag
force-pushed
the
feature/code-format-rule
branch
from
July 17, 2026 14:28
e7a6626 to
85b9714
Compare
- On a file a rule changes, use the re-dumped original as the diff baseline so the reported diff shows only the rule's change, and attribute the extra reformatting (indentation, comments the YAML dumper cannot keep) to the virtual CodeFormatRule - Leave files no rule touches byte-exact: never re-dump for formatting alone, so comment-only files are not rewritten project-wide - Cover the behaviour with a YamlProcessResult test (rule only, rule plus reformat, and a commented file left untouched)
- The YAML processor now attributes the virtual CodeFormatRule to a rule-rewritten file and reports the diff against a normalized baseline; update the e2e golden CLI output to match
chrissonntag
force-pushed
the
feature/code-format-rule
branch
from
July 17, 2026 14:34
85b9714 to
ea69980
Compare
|
|
||
|
|
||
| [OK] 1 file has been changed by Fractor | ||
| [OK] 1 file has been changed by Fractor |
Collaborator
There was a problem hiding this comment.
I'm wondering about the extra whitespace at the end here where it comes from and why it is not trimmed as before
Contributor
Author
There was a problem hiding this comment.
Those are coming from the symfony output and are technically always present in the console. I can only assume that the whitespaces had been trimmed by ones IDE in the past and therefore were formerly missing. They don't really matter and are only of cosmetic nature. We can savely remove them if you like to.
| - bar@domain.com: 'Bar' | ||
| + foo@domain.com: Bar | ||
| + bar@domain.com: Bar | ||
| bar@domain.com: Bar |
Collaborator
There was a problem hiding this comment.
why is there a diff?
Contributor
Author
There was a problem hiding this comment.
The YAML processor now diffs against a normalized baseline (the re-dumped original) instead of the raw source. Previously the diff was raw: 'Bar' against 'Bar'. After our change we diff against Bar without quotes. That's why the expected-output.txt had to change.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds a virtual
CodeFormatRuleso that formatting-only changes (a pure reformat, or reindentation riding along with a real rule) finally get counted, surfaced in the report, and factored into the dry-run exit code — instead of Fractor silently rewriting files with nobody the wiser. And by the way, it also fixes #427.CodeFormatRuleisn't a registrable rule, just a markerAppliedRuleknows about (codeFormat()/isCodeFormat()).FractorRunnerattaches it when no real rule ran or the normalized baseline differs from the raw input. In the console, a formatting-only file skips the diff dump and shows a~ reformatted / normalizedone-liner plusCodeFormatRuleunder "Applied rules"; real rule changes render as before.Also includes a small YAML fix (re-dump the original as baseline so the diff shows only the rule's change; skip re-dumping for formatting alone, since the dumper drops comments) and
ProcessResultcoverage for every reformatting format — composer.json, TypoScript, XML, XLIFF, YAML — plus coreCodeFormatRule/AppliedRuletests.