Skip to content

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

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issueenhancementNew feature or requestgood first issueGood for newcomerslocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy