Skip to content

Enhancement: Error if configuration options aren't provided as expected #6403

Open
@JoshuaKGoldberg

Description

@JoshuaKGoldberg

Before You File a Proposal Please Confirm You Have Done The Following...

Relevant Package

typescript-estree

My proposal is suitable for this project

  • I believe my proposal would be useful to the broader TypeScript community (meaning it is not a niche proposal).

Description

Spinning out from #6367 (comment): we have logic in typescript-estree to ensure provided configuration options are the expected types. But we don't show any indication about incorrect types to users who configure us incorrectly.

Fail

{
  parserOptions: {
    project: 123
  }
}

Pass

{
  parserOptions: {
    project: ['tsconfig.eslint.json']
  }
}

Additional Info

Proposal:

  • console.warn in v6?
  • throw an error in v7?

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuebreaking changeThis change will require a new major version to be releasedenhancementNew feature or requestpackage: typescript-estreeIssues related to @typescript-eslint/typescript-estree

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions