Skip to content

[ban-ts-comment] require comment descriptions by default #2146

@dimitropoulos

Description

@dimitropoulos

now that #2099 is merged and users can specify allow-with-description for the comment directives specified in ban-ts-comment, this issue serves as a reminder to make this change for 4.0.

with the next major, we can consider setting the default to ts-expect-error: 'allow-with-comment'
@bradzacher 2020 05 25

Aside from the tests to be updated, the breaking change will look something like this:

const defaultOptions: Options = {
- 'ts-expect-error': true,
+ 'ts-expect-error': 'allow-with-description',
  'ts-ignore': true,
  'ts-nocheck': true,
- 'ts-check': false,
+ 'ts-check': 'allow-with-description',
  minimumDescriptionLength: 3,
};

Metadata

Metadata

Assignees

No one assigned

    Labels

    breaking changeThis change will require a new major version to be releaseddefault rule optionsDiscussions about default rule optionspackage: eslint-pluginIssues related to @typescript-eslint/eslint-plugin

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy