Skip to content

Docs: order differs between Options and defaultOptions #8477

@BBosman

Description

@BBosman

Before You File a Documentation Request Please Confirm You Have Done The Following...

Suggested Changes

If you look at the documentation for the consistent-type-imports rule the Options are given as this:

type Options = [
  {
    disallowTypeAnnotations?: boolean;
    fixStyle?: 'inline-type-imports' | 'separate-type-imports';
    prefer?: 'no-type-imports' | 'type-imports';
  },
];

const defaultOptions: Options = [
  {
    prefer: 'type-imports',
    disallowTypeAnnotations: true,
    fixStyle: 'separate-type-imports',
  },
];

As you can see the order of the properties in the defaultOptions differs from the ones in Options. While semantically not invalid I found it somewhat confusing.

I did not check any other rules for similar issues.

Affected URL(s)

https://typescript-eslint.io/rules/consistent-type-imports/

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updatinggood first issueGood for newcomerslocked due to agePlease open a new issue if you'd like to say more. See https://typescript-eslint.io/contributing.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions