Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
dimitropoulos opened this issue Jun 1, 2020 · 0 comments
Closed

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

dimitropoulos opened this issue Jun 1, 2020 · 0 comments

Comments

@dimitropoulos
Copy link
Contributor

@dimitropoulos dimitropoulos commented Jun 1, 2020

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,
};
@bradzacher bradzacher added this to the 4.0.0 milestone Jun 1, 2020
bradzacher added a commit that referenced this issue Aug 3, 2020
…rror` to `allow-with-description`

Fixes #2146

BREAKING CHANGE:

Default rule options is a breaking change.
bradzacher added a commit that referenced this issue Aug 3, 2020
…rror` to `allow-with-description` (#2351)

BREAKING CHANGE:

Default rule options is a breaking change.
Fixes #2146
@bradzacher bradzacher closed this Aug 3, 2020
bradzacher added a commit that referenced this issue Aug 3, 2020
…rror` to `allow-with-description` (#2351)

BREAKING CHANGE:

Default rule options is a breaking change.
Fixes #2146
bradzacher added a commit that referenced this issue Aug 9, 2020
…rror` to `allow-with-description` (#2351)

BREAKING CHANGE:

Default rule options is a breaking change.
Fixes #2146
bradzacher added a commit that referenced this issue Aug 10, 2020
…rror` to `allow-with-description` (#2351)

BREAKING CHANGE:

Default rule options is a breaking change.
Fixes #2146
bradzacher added a commit that referenced this issue Aug 19, 2020
…rror` to `allow-with-description` (#2351)

BREAKING CHANGE:

Default rule options is a breaking change.
Fixes #2146
bradzacher added a commit that referenced this issue Aug 29, 2020
…rror` to `allow-with-description` (#2351)

BREAKING CHANGE:

Default rule options is a breaking change.
Fixes #2146
bradzacher added a commit that referenced this issue Aug 29, 2020
…rror` to `allow-with-description` (#2351)

BREAKING CHANGE:

Default rule options is a breaking change.
Fixes #2146
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 3, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
2 participants