Skip to content

Refactored converters to have names match intent #714

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

Merged
merged 11 commits into from
Sep 20, 2020

Conversation

JoshuaKGoldberg
Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg commented Sep 12, 2020

PR Checklist

Overview

This one's a big one! It's kind of a culmination of a bunch of inconsistencies that have existed for a while in the codebase:

  • Converters passed to runCli are now called converters and of type RuleConverter instead of configConverter; rule converters are now RuleConverters accordingly.
    • convertConfig is now convertLintConfig to match the existing convertEditorConfig
  • Comment conversion is moved into a root-level convertComments instead of a part of convert(Lint)Config
    • Finding original configurations is now a part of runCli and all original config data is passed to all those converters
    • ruleEquivalents is passed to all root-level converters along with settings and configurations, with the intent that they add to it
  • Moves reporting/ logic into the individual folders for each section

Waiting for #712 and #713 to land before making resolving merge conflicts and updating documentation. ✔️

@JoshuaKGoldberg JoshuaKGoldberg marked this pull request as ready for review September 20, 2020 01:43
@JoshuaKGoldberg
Copy link
Member Author

Ok @KingDarBoja sorry this ended up being so scope creep-y 😅! If you're interested in reviewing but finding it's not well described or readable, I'm down to set up a pairing with you on getting this more comprehensible over Gitter. Let me know! 🙌

(if you don't have time to review, that's ok too!)

@KingDarBoja
Copy link
Collaborator

A general overview seems to be okay as now the documentation is clear about how this package operates and the underlying architecture for TSLint rules conversion to ESLint ones.

I trust your work and most of these changes are either file or variable renames for the sake of clarity 🥂

@JoshuaKGoldberg
Copy link
Member Author

Ok swell, that's great to hear. Thanks greatly!

@JoshuaKGoldberg JoshuaKGoldberg merged commit 34484ad into main Sep 20, 2020
@JoshuaKGoldberg JoshuaKGoldberg deleted the refactor-all-the-things branch September 20, 2020 20:49
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.

Refactor naming, file and folder structure of editor configurations in contrast to existing lint rules
2 participants