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

feat(experimental-utils): upgrade eslint types for v7 #2023

Merged
merged 1 commit into from May 14, 2020

Conversation

bradzacher
Copy link
Member

BREAKING CHANGE:

  • Renames some interfaces to be closer to the underlying ESLint definitions.
  • Changes the definitions to use declare class instead of interface types so they're a little more sane.
  • Marks a lot of properties as readonly
    • some because it's correct (eg context and source code)
    • some because it makes some things easier
  • Removed types for APIs that have been deprecated.
    • Some had been deprecated for 3 major versions - it's time to move on.
  • Removed deprecated parser options.

Added a lot of jsdoc to the types. Like a lot. Some taken from eslint's site, some taken from the source code.

BREAKING CHANGE:
- Renames some interfaces to be closer to the underlying ESLint definitions.
- Changes the definitions to use `declare class` instead of interface types so they're a little more sane.
- Marks a lot of properties as readonly
  - some because it's correct (eg context and source code)
  - some because it makes some things easier
- Removed types for APIs that have been deprecated.
  - Some had been deprecated for 3 major versions - it's time to move on.
- Removed deprecated parser options.

Added a lot of jsdoc to the types. Like a lot. Some taken from eslint's site, some taken from the source code.
@bradzacher bradzacher added the enhancement New feature or request label May 14, 2020
@typescript-eslint
Copy link
Contributor

Thanks for the PR, @bradzacher!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!


🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

@bradzacher bradzacher added this to the 3.0.0 milestone May 14, 2020
@codecov
Copy link

codecov bot commented May 14, 2020

Codecov Report

Merging #2023 into v3 will decrease coverage by 0.00%.
The diff coverage is 31.57%.

@@            Coverage Diff             @@
##               v3    #2023      +/-   ##
==========================================
- Coverage   93.61%   93.61%   -0.01%     
==========================================
  Files         169      170       +1     
  Lines        7680     7679       -1     
  Branches     2195     2193       -2     
==========================================
- Hits         7190     7189       -1     
  Misses        231      231              
  Partials      259      259              
Flag Coverage Δ
#unittest 93.61% <31.57%> (-0.01%) ⬇️
Impacted Files Coverage Δ
...n/src/rules/indent-new-do-not-use/OffsetStorage.ts 100.00% <ø> (ø)
packages/eslint-plugin/src/util/misc.ts 92.59% <ø> (ø)
...experimental-utils/src/eslint-utils/RuleCreator.ts 66.66% <ø> (ø)
...ages/experimental-utils/src/ts-eslint/CLIEngine.ts 0.00% <ø> (ø)
...ackages/experimental-utils/src/ts-eslint/ESLint.ts 0.00% <0.00%> (ø)
...ackages/experimental-utils/src/ts-eslint/Linter.ts 100.00% <ø> (ø)
...ges/experimental-utils/src/ts-eslint/RuleTester.ts 100.00% <ø> (+71.42%) ⬆️
...ges/experimental-utils/src/ts-eslint/SourceCode.ts 100.00% <ø> (ø)
.../experimental-utils/src/eslint-utils/RuleTester.ts 8.88% <8.33%> (-0.87%) ⬇️
packages/eslint-plugin/src/rules/array-type.ts 94.28% <100.00%> (ø)
... and 5 more

@bradzacher bradzacher merged commit a8b8a6c into v3 May 14, 2020
@bradzacher bradzacher deleted the v3-eslint-v7-types branch May 14, 2020 08:16
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 14, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant