Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore!: rename ec to editorconfig-checker #371

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

klaernie
Copy link
Member

@klaernie klaernie commented Sep 6, 2024

This is the replacement for #255

Still TODO:

  • replace image in README.md

jay-babu and others added 4 commits September 6, 2024 17:40
Why breaking: the archive name is depending on the archive name,
downstream projects will probably need to adjust their build tooling.
Technically these tests are not affected by the change, but for
consistency I think this is the right thing to do.
Copy link

codecov bot commented Sep 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.04%. Comparing base (d6c17be) to head (3696ae9).
Report is 39 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #371      +/-   ##
==========================================
+ Coverage   84.89%   87.04%   +2.15%     
==========================================
  Files           8        8              
  Lines         695      610      -85     
==========================================
- Hits          590      531      -59     
+ Misses         81       55      -26     
  Partials       24       24              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@mstruebing mstruebing left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will be a hard breaking change.
I will leave it open for other maintainers to have a look at.

Once we are fine with it and we want to release a new version I can go ahead an do the release until the release process is sorted out.

@klaernie
Copy link
Member Author

klaernie commented Sep 6, 2024

Of cause! Please tell me if I missed any spot, I tried to be as thorough as possible, but could still have missed a spot.

Copy link
Member

@theoludwig theoludwig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

BREAKING CHANGE indeed, might be worth it, to avoid confusions, and avoid having too many way to execute the same binary.

What about .ecrc? Should the configuration file named .editorconfig-checkerrc? (might be a separate issue, but as it's a JSON file, we should support the file with the extension, so .editorconfig-checkerrc.json).
EDIT: Issue already open for JSON config: #306

Also, wrappers will need to be updated:

We had issues with releasing major version with Go from v2 to v3 (ref: #338), so we should not forgot to update it the same way as #339 did for v4 (of course in a separated PR).

We might first release v3.1.0 (hopefully with a automation), and then we'll see how to proceed with major version.

Blocking as "Request changes" for the moment.

@ccoVeille
Copy link
Contributor

ccoVeille commented Sep 7, 2024

What about .ecrc? Should the configuration file named .editorconfig-checkerrc?

I commented #306 about this point.

But let me sum up here, I think this PR is a good candidate for checking a new name in addition of .ecrc file

I suggest .editorconfig-checker.json (not .editorconfig-checkerrc.jsonas suggested here, there is no reason for me to keep the rc suffix)

It might not need to be addressed in this exact PR, but in another PR that will be added to the same release that where the binary name changes would be shipped)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Confusion on official cli binary name
5 participants