feat(eslint-plugin): [restrict-template-expressions] add support for intersection types #1803

ulrichb · 2020-03-26T13:45:32Z

@reviewers: I had to refactor the getBaseType() function (which extracted all union primitive/"other" types) into a predicate-receiving isUnderlyingExpressionTypeConfirmingTo().

IMO this is better anyways because it separates the two concerns:
a) "a property x applies to all underlying types", and
b) "some type x is primitive (in respect to the options)"

Also isUnderlyingExpressionTypeConfirmingTo() is more generic (easier to re-use).

Better ideas for the name "isUnderlyingExpressionTypeConfirmingTo"?

typescript-eslint · 2020-03-26T13:45:38Z

Thanks for the PR, @ulrichb!

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 · 2020-03-26T14:02:18Z

Codecov Report

Merging #1803 into master will decrease coverage by 0.00%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##           master    #1803      +/-   ##
==========================================
- Coverage   94.38%   94.37%   -0.01%     
==========================================
  Files         164      164              
  Lines        7585     7572      -13     
  Branches     2180     2175       -5     
==========================================
- Hits         7159     7146      -13     
  Misses        183      183              
  Partials      243      243

Flag	Coverage Δ
#unittest	`94.37% <100.00%> (-0.01%)`	⬇️

Impacted Files	Coverage Δ
...-plugin/src/rules/restrict-template-expressions.ts	`100.00% <100.00%> (ø)`

…intersection types (fixes typescript-eslint#1797)

ulrichb · 2020-03-27T14:46:00Z

@bradzacher Also adapted the commit message (fix=>feat)

bradzacher

A few comments, otherwise LGTM.
Thanks for your work!

there was a minor update to this rule in d44c0f9, please update accordingly.
make sure you merge master in. there were some lint rule changes which will fire on your pr that will need to be addressed
please also add an example to the rule doc.

bradzacher · 2020-04-12T20:37:10Z

packages/eslint-plugin/src/rules/restrict-template-expressions.ts

-    }
+      return rec(
+        // "Extracts" generic constraint, indexed access and conditional types:
+        typeChecker.getBaseConstraintOfType(expressionType) ?? expressionType,


We've got a utility function for this!

Suggested change

typeChecker.getBaseConstraintOfType(expressionType) ?? expressionType,

util.getConstrainedTypeAtLocation(typeChecker, expression),

bradzacher · 2020-04-12T20:41:28Z

packages/eslint-plugin/src/rules/restrict-template-expressions.ts

+        util.isTypeFlagSet(
+          type,
+          ts.TypeFlags.NumberLike | ts.TypeFlags.BigIntLike,
+        ) &&
+        options.allowNumber


nit - do the option check first to save some cycles

Suggested change

util.isTypeFlagSet(

type,

ts.TypeFlags.NumberLike | ts.TypeFlags.BigIntLike,

) &&

options.allowNumber

options.allowNumber &&

util.isTypeFlagSet(

type,

ts.TypeFlags.NumberLike | ts.TypeFlags.BigIntLike,

)

bradzacher · 2020-04-12T20:41:38Z

packages/eslint-plugin/src/rules/restrict-template-expressions.ts

+        util.isTypeFlagSet(type, ts.TypeFlags.BooleanLike) &&
+        options.allowBoolean


ditto

Suggested change

util.isTypeFlagSet(type, ts.TypeFlags.BooleanLike) &&

options.allowBoolean

options.allowBoolean &&

util.isTypeFlagSet(type, ts.TypeFlags.BooleanLike)

bradzacher · 2020-04-12T20:42:02Z

packages/eslint-plugin/src/rules/restrict-template-expressions.ts

+        util.isTypeFlagSet(type, ts.TypeFlags.Null | ts.TypeFlags.Undefined) &&
+        options.allowNullable


ditto

Suggested change

util.isTypeFlagSet(type, ts.TypeFlags.Null | ts.TypeFlags.Undefined) &&

options.allowNullable

options.allowNullable &&

util.isTypeFlagSet(type, ts.TypeFlags.Null | ts.TypeFlags.Undefined)

…ssions_intersesion_types # Conflicts: # packages/eslint-plugin/src/rules/restrict-template-expressions.ts

ulrichb · 2020-04-14T15:19:08Z

@bradzacher

Merged master and added "allowAny" from d44c0f9
Refactor to util.getConstrainedTypeAtLocation()
Move the option-checks before the isTypeFlagSet()-checks
Add example: stringWithKind: string & { kind?: 'MyString' }

bradzacher

LGTM - thanks for this

ulrichb · 2020-04-14T16:04:55Z

Thanks for reviewing!

ulrichb force-pushed the feat/restrict-template-expressions_intersesion_types branch 2 times, most recently from 30e03ab to 88b8d4a Compare March 26, 2020 13:55

ulrichb force-pushed the feat/restrict-template-expressions_intersesion_types branch 3 times, most recently from cede642 to 3610756 Compare March 26, 2020 14:25

bradzacher added the enhancement New feature or request label Mar 26, 2020

bradzacher changed the title ~~fix(eslint-plugin): [restrict-template-expressions] add support for intersection types~~ feat(eslint-plugin): [restrict-template-expressions] add support for intersection types Mar 26, 2020

feat(eslint-plugin): [restrict-template-expressions] add support for …

054e62e

…intersection types (fixes typescript-eslint#1797)

ulrichb force-pushed the feat/restrict-template-expressions_intersesion_types branch from 3610756 to 054e62e Compare March 27, 2020 14:45

bradzacher requested changes Apr 12, 2020

View reviewed changes

bradzacher added the awaiting response Issues waiting for a reply from the OP or another party label Apr 12, 2020

ulrichb added 2 commits April 14, 2020 16:22

Merge commit 'refs/tags/v2.28.0^{}' into feat/restrict-template-expre…

27ed61f

…ssions_intersesion_types # Conflicts: # packages/eslint-plugin/src/rules/restrict-template-expressions.ts

Manually merge "allowAny" option

df0ad14

ulrichb force-pushed the feat/restrict-template-expressions_intersesion_types branch from 97be444 to df0ad14 Compare April 14, 2020 14:33

ulrichb added 3 commits April 14, 2020 16:43

Refactor to util.getConstrainedTypeAtLocation()

f2fab58

Move the options check before isTypeFlagSet() check

9ebb323

Bring the options order in sync and add missing allowAny in docs

8d74671

ulrichb force-pushed the feat/restrict-template-expressions_intersesion_types branch from b82ca11 to fde1f38 Compare April 14, 2020 14:58

ulrichb added 2 commits April 14, 2020 17:07

Add intersection type example

8df74f4

Fix linter errors

dfe2c64

ulrichb force-pushed the feat/restrict-template-expressions_intersesion_types branch from fde1f38 to dfe2c64 Compare April 14, 2020 15:08

bradzacher removed the awaiting response Issues waiting for a reply from the OP or another party label Apr 14, 2020

Improve / fix example

e46717c

bradzacher approved these changes Apr 14, 2020

View reviewed changes

bradzacher merged commit cc70e4f into typescript-eslint:master Apr 14, 2020

ulrichb deleted the feat/restrict-template-expressions_intersesion_types branch April 14, 2020 16:19

github-actions bot locked as resolved and limited conversation to collaborators May 15, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [restrict-template-expressions] add support for intersection types #1803

feat(eslint-plugin): [restrict-template-expressions] add support for intersection types #1803

ulrichb commented Mar 26, 2020 •

edited

Loading

typescript-eslint bot commented Mar 26, 2020

codecov bot commented Mar 26, 2020 •

edited

Loading

ulrichb commented Mar 27, 2020

bradzacher left a comment

bradzacher Apr 12, 2020

bradzacher Apr 12, 2020

bradzacher Apr 12, 2020

bradzacher Apr 12, 2020

ulrichb commented Apr 14, 2020

bradzacher left a comment

ulrichb commented Apr 14, 2020

	typeChecker.getBaseConstraintOfType(expressionType) ?? expressionType,
	util.getConstrainedTypeAtLocation(typeChecker, expression),

		util.isTypeFlagSet(type, ts.TypeFlags.BooleanLike) &&
		options.allowBoolean

		util.isTypeFlagSet(type, ts.TypeFlags.Null \| ts.TypeFlags.Undefined) &&
		options.allowNullable

feat(eslint-plugin): [restrict-template-expressions] add support for intersection types #1803

feat(eslint-plugin): [restrict-template-expressions] add support for intersection types #1803

Conversation

ulrichb commented Mar 26, 2020 • edited Loading

typescript-eslint bot commented Mar 26, 2020

codecov bot commented Mar 26, 2020 • edited Loading

Codecov Report

ulrichb commented Mar 27, 2020

bradzacher left a comment

Choose a reason for hiding this comment

bradzacher Apr 12, 2020

Choose a reason for hiding this comment

bradzacher Apr 12, 2020

Choose a reason for hiding this comment

bradzacher Apr 12, 2020

Choose a reason for hiding this comment

bradzacher Apr 12, 2020

Choose a reason for hiding this comment

ulrichb commented Apr 14, 2020

bradzacher left a comment

Choose a reason for hiding this comment

ulrichb commented Apr 14, 2020

ulrichb commented Mar 26, 2020 •

edited

Loading

codecov bot commented Mar 26, 2020 •

edited

Loading