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

Remove some formatters from the core #14277

Closed
nzakas opened this issue Mar 31, 2021 · 5 comments · Fixed by #14316
Closed

Remove some formatters from the core #14277

nzakas opened this issue Mar 31, 2021 · 5 comments · Fixed by #14316
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion breaking This change is backwards-incompatible core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint

Comments

@nzakas
Copy link
Member

nzakas commented Mar 31, 2021

The version of ESLint you are using.

v7.x

The problem you want to solve.

We ship a lot of formatters with the core, and some of them require dependencies that aren't necessary elsewhere in ESLint. If we remove these formatters, we reduce the overall size of ESLint by removing these dependencies.

Spawned from #14098.

Your take on the correct solution to problem.

Remove these formatters:

  • codeframe - depends on @babel/code-frame
  • table - depends on table

Note that @fregante has already packaged all of the built-in formatters into separate packages on npm: https://github.com/fregante/eslint-formatters. So we would be able to tell people, for example, to install eslint-formatter-table if they are using the table formatter.

Are you willing to submit a pull request to implement this change?

Yes.

@nzakas nzakas added enhancement This change enhances an existing feature of ESLint core Relates to ESLint's core APIs and features breaking This change is backwards-incompatible labels Mar 31, 2021
@eslint-github-bot eslint-github-bot bot added this to Needs Triage in Triage Mar 31, 2021
@nzakas nzakas moved this from Needs Triage to Evaluating in Triage Mar 31, 2021
@fregante
Copy link
Contributor

Keep in mind that they after this they will become unmaintained. I'll gladly pass on the mentioned formatter packages to their original writers.

@nzakas
Copy link
Member Author

nzakas commented Apr 1, 2021

I think that’s fine. Formatters don’t change a lot, so they might not even need maintenance.

@mdjermanovic mdjermanovic added this to Need Discussion in v8.0.0 Apr 7, 2021
@nzakas nzakas moved this from Need Discussion to Planned in v8.0.0 Apr 8, 2021
@btmills btmills added the accepted There is consensus among the team that this change meets the criteria for inclusion label Apr 12, 2021
@btmills btmills moved this from Evaluating to Ready to Implement in Triage Apr 12, 2021
@btmills
Copy link
Member

btmills commented Apr 12, 2021

This change is accepted for ESLint v8.0.0.

@fregante
Copy link
Contributor

I'll take it

@mdjermanovic mdjermanovic moved this from Ready to Implement to Pull Request Opened in Triage Apr 12, 2021
@mdjermanovic mdjermanovic moved this from Planned to Pull Request Opened in v8.0.0 Apr 12, 2021
@nzakas
Copy link
Member Author

nzakas commented Apr 12, 2021

@fregante Thanks! Keep in mind that it still may be several weeks before v8.0.0 is released so we may leave the PR open until we are ready.

@nzakas nzakas moved this from Pull Request Opened to Ready for Merge in v8.0.0 Jun 17, 2021
Triage automation moved this from Pull Request Opened to Complete Aug 5, 2021
v8.0.0 automation moved this from Ready for Merge to Done Aug 5, 2021
@eslint-github-bot eslint-github-bot bot locked and limited conversation to collaborators Feb 2, 2022
@eslint-github-bot eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 2, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
accepted There is consensus among the team that this change meets the criteria for inclusion archived due to age This issue has been archived; please open a new issue for any further discussion breaking This change is backwards-incompatible core Relates to ESLint's core APIs and features enhancement This change enhances an existing feature of ESLint
Projects
Archived in project
v8.0.0
  
Done
Triage
Complete
Development

Successfully merging a pull request may close this issue.

3 participants