Skip to content

docs(tsconfig): show the object syntax for the plugins option#3592

Open
ELHart05 wants to merge 1 commit into
microsoft:v2from
ELHart05:docs/plugins-tsconfig-example
Open

docs(tsconfig): show the object syntax for the plugins option#3592
ELHart05 wants to merge 1 commit into
microsoft:v2from
ELHart05:docs/plugins-tsconfig-example

Conversation

@ELHart05

Copy link
Copy Markdown

The plugins copy calls it a "list of language service plugins" and gives no example, so it reads like you pass a list of strings. It actually takes an array of objects, each with a name. This adds a short tsconfig.json example showing the real shape, in the same json tsconfig style the other option pages (like paths) already use.

Fixes #3039

The `plugins` copy calls it a "list of language service plugins" and gives
no example, so it reads like you pass a list of strings. It actually takes
an array of objects, each with a `name`. This adds a short `tsconfig.json`
example showing the real shape, in the same `json tsconfig` style the other
option pages (like `paths`) already use.

Fixes microsoft#3039
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for tsconfig.Plugins is wrong

1 participant