Skip to content

Performance: [eslint-plugin] Stop publishing docs/ directory to npm #11234

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.

Sign up for GitHub

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

Jump to bottom
Closed
4 tasks done
JoshuaKGoldberg opened this issue May 21, 2025 · 1 comment · Fixed by #11251
Closed
4 tasks done

Performance: [eslint-plugin] Stop publishing docs/ directory to npm #11234

JoshuaKGoldberg opened this issue May 21, 2025 · 1 comment · Fixed by #11251
Labels
accepting prs Go ahead, send a pull request that resolves this issue enhancement New feature or request good first issue Good for newcomers

Comments

@JoshuaKGoldberg
Copy link
Member

Before You File a Proposal Please Confirm You Have Done The Following...

Relevant Package

eslint-plugin

My proposal is suitable for this project

  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

https://app.unpkg.com/@typescript-eslint/eslint-plugin@8.32.1 shows a 526 kB docs/ directory is published with the package. It includes a bunch of rules/*.md(x) files that are source code for what gets published to https://typescript-eslint.io/rules.

I don't think we need to publish this. Proposal: let's get rid of it?

Additional Info

Granted, 526 kB is ~0.26% of the total ~2 MB the package publishes on its own, let alone the ~9 MB including all the dependencies. But if there's no need to publish that stuff, I don't think we should.
@JoshuaKGoldberg JoshuaKGoldberg added enhancement New feature or request triage Waiting for team members to take a look labels May 21, 2025
@bradzacher
Copy link
Member

I always wanted to do this but I left it in cos people used to reference the docs back when they were just markdown files. Now that they're abominations that get processed by docusaurus it seems useless to keep them. Really we just forgot they were there lol.

@bradzacher bradzacher added accepting prs Go ahead, send a pull request that resolves this issue good first issue Good for newcomers and removed triage Waiting for team members to take a look labels May 26, 2025
@roottool roottool mentioned this issue May 28, 2025
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
accepting prs Go ahead, send a pull request that resolves this issue enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: exclude docs/ directory from eslint-plugin package roottool/typescript-eslint
2 participants
@JoshuaKGoldberg @bradzacher