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

Generated plugin README has legacy config file reference #193

Closed
MikeMcC399 opened this issue Oct 15, 2024 · 3 comments · Fixed by #194
Closed

Generated plugin README has legacy config file reference #193

MikeMcC399 opened this issue Oct 15, 2024 · 3 comments · Fixed by #194
Labels

Comments

@MikeMcC399
Copy link
Contributor

MikeMcC399 commented Oct 15, 2024

Current behavior

When yo:eslint:plugin is used to generate a new plugin, the Usage section of the generated README.md file says

Add name-of-plugin to the plugins section of your .eslintrc configuration file.

and provides instructions to configure a deprecated legacy configuration file .eslintrc.

Expected behavior

When yo:eslint:plugin is used to generate a new plugin, the Usage section of the generated README.md file should provide instructions to configure a current configuration file, for example eslint.config.mjs, compatible with ESLint v9.

Versions

Component Version
Ubuntu 24.04.1 LTS
Node.js v20.18.0 LTS
npm 10.8.2
yo 5.0.0
generator-eslint 5.1.0

Steps to repoduce

npm install yo@latest -g
npm install generator-eslint@latest -g
mkdir generator-eslint-test
cd generator-eslint-test

Execute yo eslint:plugin and accept defaults:

$ yo eslint:plugin
? What is your name? Tester
? What is the plugin ID? template-test
? Type a short description of this plugin: Template test
? Does this plugin contain custom ESLint rules? Yes
? Does this plugin contain one or more processors? No
   create package.json
   create eslint.config.mjs
   create lib/index.js
   create README.md

Changes to package.json were detected.
Error detecting the package manager. Falling back to npm.

Running npm install for you to install the required dependencies.
npm warn ERESOLVE overriding peer dependency
npm warn deprecated [email protected]: This module is not supported, and leaks memory. Do not use it. Check out lru-cache if you want a good and tested way to coalesce async requests by a key value, which is much more comprehensive and powerful.
npm warn deprecated [email protected]: Glob versions prior to v9 are no longer supported

added 230 packages, and audited 231 packages in 4s

55 packages are looking for funding
  run `npm fund` for details

found 0 vulnerabilities
@eslintbot eslintbot added this to Triage Oct 15, 2024
@github-project-automation github-project-automation bot moved this to Needs Triage in Triage Oct 15, 2024
@nzakas
Copy link
Member

nzakas commented Oct 18, 2024

Yes, that should be updated. Do you want to submit a pull request?

@nzakas nzakas moved this from Needs Triage to Ready to Implement in Triage Oct 18, 2024
@MikeMcC399
Copy link
Contributor Author

@nzakas

Yes, that should be updated. Do you want to submit a pull request?

Yes, I will submit a PR for this.

@MikeMcC399
Copy link
Contributor Author

@github-project-automation github-project-automation bot moved this from Ready to Implement to Complete in Triage Oct 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants