Skip to content

Add inline summaries in --write-changes mode#3836

Merged
DimitriPapadopoulos merged 3 commits intocodespell-project:mainfrom
pgbaumann:feat/show-detailed-changes-when-using-w-flag
Dec 7, 2025
Merged

Add inline summaries in --write-changes mode#3836
DimitriPapadopoulos merged 3 commits intocodespell-project:mainfrom
pgbaumann:feat/show-detailed-changes-when-using-w-flag

Conversation

@pgbaumann
Copy link
Copy Markdown
Contributor

@pgbaumann pgbaumann commented Nov 23, 2025 •
edited
Loading

Fixes #3663

When using the -w flag to automatically fix spelling errors, codespell now displays a list of changes made below the "FIXED: filename" message, similar to the output in non-write mode.

Before:
FIXED: foo.h

After:
FIXED: foo.h
foo.h:63: Creats ==> Creates

Changes:

  • Added changes_made list to track fixes made to a file during write mode
  • Print list of changes after "FIXED: filename"
  • Moved color formatting code into a function to avoid code duplication
  • Added a test

@pgbaumann pgbaumann changed the title Feat/show detailed changes when using w flag Feat/add inline summaries in --write-changes mode Nov 23, 2025
@pgbaumann pgbaumann changed the title Feat/add inline summaries in --write-changes mode Add inline summaries in --write-changes mode Nov 23, 2025
@DimitriPapadopoulos
Copy link
Copy Markdown
Collaborator

DimitriPapadopoulos commented Nov 23, 2025

Ah, the test is an excellent idea, thank you for that.

@larsoner
Copy link
Copy Markdown
Member

larsoner commented Nov 24, 2025

@DimitriPapadopoulos feel free to merge if you're happy

@DimitriPapadopoulos
Copy link
Copy Markdown
Collaborator

DimitriPapadopoulos commented Nov 24, 2025

@pgbaumann I'm afraid #3832 refactored the code you've modified — mostly moving part of a function into its own function. Do you think you can find time to rebase this PR? Sorry about the annoyance.

@pgbaumann
Copy link
Copy Markdown
Contributor Author

pgbaumann commented Nov 25, 2025

@pgbaumann I'm afraid #3832 refactored the code you've modified — mostly moving part of a function into its own function. Do you think you can find time to rebase this PR? Sorry about the annoyance.

Hi @DimitriPapadopoulos. Sure, I will have a look next weekend.

@pgbaumann pgbaumann force-pushed the feat/show-detailed-changes-when-using-w-flag branch from f4e0cc9 to d0f15fa Compare November 26, 2025 20:23
@pgbaumann
Copy link
Copy Markdown
Contributor Author

pgbaumann commented Nov 26, 2025

@DimitriPapadopoulos I have updated the PR by resolving conflicts with #3832.
Please take a look when you have a chance.

@pgbaumann
Copy link
Copy Markdown
Contributor Author

pgbaumann commented Dec 7, 2025 •
edited
Loading

Hey @DimitriPapadopoulos

Just a friendly ping. I've resolved the conflicts with #3832, so this should be ready for review whenever you have time. Thanks!

@DimitriPapadopoulos DimitriPapadopoulos merged commit 3f286a4 into codespell-project:main Dec 7, 2025
16 checks passed
@DimitriPapadopoulos
Copy link
Copy Markdown
Collaborator

DimitriPapadopoulos commented Dec 7, 2025

Thank you @pgbaumann.

@pgbaumann pgbaumann deleted the feat/show-detailed-changes-when-using-w-flag branch December 7, 2025 21:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@DimitriPapadopoulos DimitriPapadopoulos DimitriPapadopoulos approved these changes

@larsoner larsoner Awaiting requested review from larsoner larsoner is a code owner

@peternewman peternewman Awaiting requested review from peternewman peternewman is a code owner

Assignees

No one assigned

Labels

enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add inline summaries in --write-changes mode

3 participants

@pgbaumann @DimitriPapadopoulos @larsoner