Change Request: Consolidate `update-readme` script across repositories

[lumirlumir]

Which packages would you like to change?

• @eslint/compat
• @eslint/config-array
• @eslint/config-helpers
• @eslint/core
• @eslint/migrate-config
• @eslint/object-schema
• @eslint/plugin-kit

What problem do you want to solve?

Hello,

I couldn’t find the appropriate repository to open this issue, so I’m writing it here!

Currently, the update-readme.js script—typically located in the tools directory of various repositories—performs essentially the same function across multiple projects.

For example:

• css
• markdown
• json
• code-explorer
• and others...

To improve maintainability and reduce duplication, I’d like to suggest extracting this script into a standalone CLI package that can be reused across the ESLint repositories.

What do you think is the correct solution?

Let's make the update-readme script a separate CLI package to improve reusability across repositories.

Additionally, I suggest dropping the got package and replacing it with the native fetch method in Node.js. Since fetch has been supported natively since Node.js v18.0.0, it would be a good fit for ESLint repositories and help reduce the overall dependency footprint. (https://nodejs.org/docs/latest/api/globals.html#fetch)

Participation

• I am willing to submit a pull request for this change.

Additional comments

No response

[nzakas]

Interesting idea. I'm not convinced that creating a separate package makes sense, as that's additional overhead for very little gain.

I wonder if there's another approach, maybe a reusable GitHub Action, that would allow us to reuse the same functionality in multiple repos without the overheard of managing another package.

[lumirlumir]

... as that's additional overhead for very little gain.

@nzakas

Thanks for the review! I agree with your point.

It might take a little time, but I'll try to find a simpler and more concrete way to reuse the update-readme script.

[nzakas]

Sounds good! No hurry.