microsoft / microsoft/TypeScript-Website

Documentation for tsconfig.Plugins is wrong

Open Beginner friendly
#3,039 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
2.6k
Forks
1.5k
Avg merge
2d 2h
Merged PRs (30d)
7

Description

"List of language service plugins to run inside the editors" implies a list of strings, which does not match the schema.
See https://www.typescriptlang.org/tsconfig#plugins

"plugins": {
  "description": "Specify a list of language service plugins to include.",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "name": {
        "description": "Plugin name.",
        "type": "string"
      }
    }
  },
  "markdownDescription": "Specify a list of language service plugins to include.\n\nSee more: https://www.typescriptlang.org/tsconfig#plugins"
}

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the tsconfig plugins documentation at the linked TypeScript configuration page and compare its wording with the schema shown in the issue. Update the description so it accurately reflects the object-array schema, then verify the rendered documentation and schema output agree.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.