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(eslint-plugin): [no-throw-literal] add options to to disallow any/unknown #4207

Merged

Conversation

hedgepigdaniel
Copy link
Contributor

@hedgepigdaniel hedgepigdaniel commented Nov 23, 2021

PR Checklist

Overview

This PR adds the following options to @typescript-eslint/no-throw-literal:

{
  "allowThrowingAny": true, // Default is to allow throwing values of type any
  "allowThrowingUnknown": true // Default is to allow throwing values of type unknown
}

When enabled, these rules result in an error being generated from code such as:

function fun(value: any) {
  throw value;
}

function fun(value: unknown) {
  throw value;
}

This is useful when using this rule to prevent the throwing of values that aren't instances of Error - because values of type any and unknown are not necessarily instances of Error.

The default values have the same behaviour as the current code.

@typescript-eslint
Copy link
Contributor

Thanks for the PR, @hedgepigdaniel!

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.

@netlify
Copy link

netlify bot commented Nov 23, 2021

✔️ Deploy Preview for typescript-eslint ready!

🔨 Explore the source changes: c8e8941

🔍 Inspect the deploy log: https://app.netlify.com/sites/typescript-eslint/deploys/619c6d31544b6c00073e3443

😎 Browse the preview: https://deploy-preview-4207--typescript-eslint.netlify.app

@nx-cloud
Copy link

nx-cloud bot commented Nov 23, 2021

☁️ Nx Cloud Report

CI ran the following commands for commit c8e8941. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 44 targets

Sent with 💌 from NxCloud.

@codecov
Copy link

codecov bot commented Nov 23, 2021

Codecov Report

Merging #4207 (c8e8941) into main (2e2ff5d) will increase coverage by 0.60%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #4207      +/-   ##
==========================================
+ Coverage   92.76%   93.37%   +0.60%     
==========================================
  Files         332      152     -180     
  Lines       11524     8056    -3468     
  Branches     3285     2587     -698     
==========================================
- Hits        10690     7522    -3168     
+ Misses        361      179     -182     
+ Partials      473      355     -118     
Flag Coverage Δ
unittest 93.37% <100.00%> (+0.60%) ⬆️

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

Impacted Files Coverage Δ
...ckages/eslint-plugin/src/rules/no-throw-literal.ts 95.34% <100.00%> (+0.34%) ⬆️
packages/scope-manager/src/lib/esnext.intl.ts
packages/typescript-estree/src/convert-comments.ts
...s/scope-manager/src/lib/es2020.symbol.wellknown.ts
packages/scope-manager/src/lib/esnext.full.ts
packages/scope-manager/src/lib/es2015.generator.ts
...ges/experimental-utils/src/ast-utils/predicates.ts
packages/scope-manager/src/scope/TSEnumScope.ts
packages/typescript-estree/src/node-utils.ts
packages/scope-manager/src/lib/es2017.string.ts
... and 171 more

Copy link
Member

@JoshuaKGoldberg JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

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

💯. Thanks!

@bradzacher bradzacher changed the title feat(eslint-plugin): add options to no-throw-literal to disallow any/unknown feat(eslint-plugin): [no-throw-literal] add options to to disallow any/unknown Dec 20, 2021
@bradzacher bradzacher merged commit ff0adf9 into typescript-eslint:main Dec 20, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 20, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement: plugin rule option New rule option for an existing eslint-plugin rule
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants