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(typescript-estree): throw custom error instead of plain object #3011

Merged
merged 7 commits into from Feb 28, 2021

Conversation

armano2
Copy link
Member

@armano2 armano2 commented Feb 7, 2021

throw custom error instead of plain object
additionally expose fileName of file that error got reported

I'm unsure if ParseError TSError name is correct.

see: https://github.com/Microsoft/TypeScript-wiki/blob/master/Breaking-Changes.md#extending-built-ins-like-error-array-and-map-may-no-longer-work


note: depends how we look at this change, this can be considered a breaking change, even if names of exposed public fields did not change

fixes #2400

@armano2 armano2 added enhancement New feature or request package: typescript-estree Issues related to @typescript-eslint/typescript-estree labels Feb 7, 2021
@typescript-eslint
Copy link
Contributor

Thanks for the PR, @armano2!

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.

@codecov
Copy link

codecov bot commented Feb 7, 2021

Codecov Report

Merging #3011 (582ff63) into master (5e2a993) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##           master    #3011   +/-   ##
=======================================
  Coverage   92.87%   92.88%           
=======================================
  Files         314      314           
  Lines       10670    10677    +7     
  Branches     3026     3026           
=======================================
+ Hits         9910     9917    +7     
  Misses        344      344           
  Partials      416      416           
Flag Coverage Δ
unittest 92.88% <100.00%> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
packages/typescript-estree/src/node-utils.ts 97.83% <100.00%> (+0.08%) ⬆️

@armano2 armano2 marked this pull request as draft February 7, 2021 15:34
@armano2 armano2 marked this pull request as ready for review February 7, 2021 17:30
Copy link
Member

@bradzacher bradzacher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we want to add either a snapshot serialiser so that we can show the line/column in the snapshot output?
This will help us verify things don't regress.

packages/typescript-estree/src/node-utils.ts Outdated Show resolved Hide resolved
packages/typescript-estree/src/node-utils.ts Outdated Show resolved Hide resolved
@bradzacher bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Feb 8, 2021
@armano2
Copy link
Member Author

armano2 commented Feb 8, 2021

do we want to add either a snapshot serialiser so that we can show the line/column in the snapshot output?
This will help us verify things don't regress.

simple serializer for this error is added, i'm unsure about format tho

@armano2 armano2 removed the awaiting response Issues waiting for a reply from the OP or another party label Feb 8, 2021
@armano2 armano2 force-pushed the feat/typescript-estree-throw-cusom-error branch from 4a0c760 to b183890 Compare February 8, 2021 07:56
@armano2 armano2 added the breaking change This change will require a new major version to be released label Feb 15, 2021
@armano2 armano2 marked this pull request as draft February 15, 2021 13:11
@armano2 armano2 force-pushed the feat/typescript-estree-throw-cusom-error branch from d4b5844 to 2bae582 Compare February 15, 2021 13:17
@armano2 armano2 marked this pull request as ready for review February 15, 2021 13:17
@armano2 armano2 removed the breaking change This change will require a new major version to be released label Feb 15, 2021
@armano2 armano2 force-pushed the feat/typescript-estree-throw-cusom-error branch from 897bedb to 582ff63 Compare February 27, 2021 17:38
@bradzacher bradzacher merged commit ae14bf5 into master Feb 28, 2021
@bradzacher bradzacher deleted the feat/typescript-estree-throw-cusom-error branch February 28, 2021 19:15
This was referenced Mar 15, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 31, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request package: typescript-estree Issues related to @typescript-eslint/typescript-estree
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Throw an appropriate Error (an instance of Error class), instead of Object
2 participants