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

Documentation for Shared Configuration #434

Open
ProfessorManhattan opened this issue Mar 27, 2023 · 1 comment
Open

Documentation for Shared Configuration #434

ProfessorManhattan opened this issue Mar 27, 2023 · 1 comment
Labels
question Further information is requested

Comments

@ProfessorManhattan
Copy link

Hey, I would like to use this CLI to generate documentation for a shared configuration that I am using with NPM. However, when I run the CLI, I get the following:

❯ eslint-doc-generator
Unable to determine plugin entry point.

The configuration works with ESLint and other ESLint tools. I have the ESLint configuration stored in my package.json like this:

"eslintConfig": {
    "extends": "eslint-config-strict-mode",
    "rules": {
      "import/no-extraneous-dependencies": "warn"
    }
  },

When I edit the shared configuration and try to point eslint-doc-generator directly to the .js entrypoint for the shared configuration, I get the following:

❯ eslint-doc-generator dist/main.js
Could not find package.json of ESLint plugin.

Any idea on how I can use this plugin to generate sweet documentation for my shared config?

@ljharb
Copy link

ljharb commented Mar 27, 2023

eslintConfig is only for your own project. Does your package.json have a main field?

@bmish bmish added the question Further information is requested label Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants