Skip to content

Pulumi ESLint Plugin lacks docs #15540

@jkodroff

Description

@jkodroff

Create a page in the docs under "Languages and SDKs" -> "TypeScript" titles "ESLint Plugin". This page should go after the SDK docs links in the navigation to be consistent with how "Blocking and Async" is laid out for Python.

The page should have roughly the same content as https://github.com/pulumi/eslint-plugin-pulumi/blob/main/README.md, with a few notes:

  • Reference https://eslint.org/docs/latest/use/getting-started for instructions on installing configuring ESLint.
  • Indicate that the user must install the package @pulumi/eslint-plugin as a dev-only dependency.
  • Do not use words like "simply" as they conflict with our style guide.
  • We should summarize what the rules cover and refer to the GH repo docs (README.md) for detailed information.
  • Note that Linting with Type Information must be enabled.
  • Note that the rules must be enabled in the eslint config file.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions