search

vercel / next.js

The React Framework
https://nextjs.org
MIT License
123.31k stars 26.32k forks source link

Docs: README for eslint-config-next just to link to ESLint rules #50843

Open sm-kc opened 1 year ago

sm-kc commented 1 year ago

What is the improvement or update you wish to see?

This is a very minor thing. As a brand new user of Next.js, I saw that it comes with an ESLint configuration, so from habit I went to its package page. However eslint-config-next doesn't have a README so that was a dead end. It would have saved me having to go search for the docs page (linked below) if there had been a README with a link to it.

Is there any context that might help us understand?

Just smoothing the path for new users of Next.js who don't know their way around the Next.js docs.

Does the docs page already exist? Please link to it.

https://nextjs.org/docs/pages/building-your-application/configuring/eslint

DX-1696

JesseKoldewijn commented 1 year ago

I agree that there should be a README but to be fair, the docs does include all the details about the eslint-config-next package.

manovotny commented 1 year ago

Good suggestion @sm-kc. I created a PR to add a README (https://github.com/vercel/next.js/pull/51059). However, it's sister package, eslint-plugin-next already has a README and it doesn't show up on NPM.

@ijjk @timneutkens @styfle is there any way we can get these READMEs published with the package so NPM can link to the documentation?

styfle commented 1 year ago

However, it's sister package, eslint-plugin-next already has a README and it doesn't show up on NPM.

That's because its no longer maintained. It hasn't been published in 3 years as seen on the Versions tab.

Looks like it was renamed to @next/eslint-plugin-next in package.json

manovotny commented 1 year ago

That's because its no longer maintained. It hasn't been published in 3 years as seen on the Versions tab.

@styfle should we run npm deprecate <package-spec> <message> on eslint-plugin-next then and have the message point to @next/eslint-plugin-next? That would automatically put at banner on top of NPM's page.

styfle commented 1 year ago

@manovotny Its not owned by Next.js

You'll have to talk to @Timer to add a deprecation message

image
scottdotweb commented 1 month ago

Commenting to take ownership, @sm-kc was my account at a former employer.