feat(eslint-plugin): [no-type-alias] allowTemplateLiterals

[jasperwreed]

PR Checklist

• Addresses an existing open issue: Enhancement: [no-type-alias] allowTemplateLiterals #5095
• That issue was marked as accepting prs
• Steps in CONTRIBUTING.md were taken

Overview

This PR adds a configuration option allowTemplateLiterals that users can utilize to regulate template literals.

Fail

// with allowTemplateLiterals: false (default)
type SlashCommand = `/${string}`

Pass

// with allowTemplateLiterals: true (default)
type SlashCommand = `/${string}`

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 8e300eb. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

---

✅ Successfully ran 47 targets

• Node 18 - nx test @typescript-eslint/eslint-plugin
• Node 12 - nx test @typescript-eslint/eslint-plugin --coverage=false
• Node 18 - nx test @typescript-eslint/visitor-keys
• nx run-many --target=build --all --parallel --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=typecheck --all --parallel
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/utils
• Node 18 - nx test @typescript-eslint/type-utils
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/typescript-estree --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-internal
• Node 12 - nx test @typescript-eslint/eslint-plugin-internal --coverage=false
• Node 12 - nx test @typescript-eslint/ast-spec --coverage=false
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/scope-manager
• Node 18 - nx test @typescript-eslint/parser
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/typescript-estree
• Node 12 - nx test @typescript-eslint/scope-manager --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/eslint-plugin-tslint --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx test @typescript-eslint/eslint-plugin-tslint
• Node 12 - nx test @typescript-eslint/type-utils --coverage=false
• Node 18 - nx test @typescript-eslint/ast-spec
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/utils --coverage=false
• nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx test @typescript-eslint/visitor-keys --coverage=false
• Node 12 - nx test @typescript-eslint/parser --coverage=false
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 18 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• Node 12 - nx run-many --target=build --all --parallel --exclude website --exclude website
• nx run-many --target=build --all --parallel --exclude website --exclude website

---

Sent with 💌 from NxCloud.

[typescript-eslint]

Thanks for the PR, @jasperwreed!

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]

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	8e300eb
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/629ad7787ab8150008aeabd1
😎 Deploy Preview	https://deploy-preview-5097--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site settings.

[codecov]

Codecov Report

Merging #5097 (8e300eb) into main (dc58ff5) will increase coverage by 2.50%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #5097      +/-   ##
==========================================
+ Coverage   91.32%   93.83%   +2.50%     
==========================================
  Files         132      286     +154     
  Lines        1487     9841    +8354     
  Branches      224     2940    +2716     
==========================================
+ Hits         1358     9234    +7876     
- Misses         65      328     +263     
- Partials       64      279     +215     

Flag	Coverage Δ
unittest	93.83% <100.00%> (+2.50%)	⬆️

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

Impacted Files	Coverage Δ
packages/eslint-plugin/src/rules/no-type-alias.ts	100.00% <100.00%> (ø)
packages/eslint-plugin/src/rules/no-shadow.ts	78.48% <0.00%> (ø)
...ages/eslint-plugin/src/rules/no-empty-interface.ts	100.00% <0.00%> (ø)
...int-plugin/src/rules/require-array-sort-compare.ts	88.23% <0.00%> (ø)
...-plugin/src/rules/no-unnecessary-type-assertion.ts	94.66% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/space-infix-ops.ts	100.00% <0.00%> (ø)
packages/eslint-plugin/src/rules/require-await.ts	90.47% <0.00%> (ø)
...s/eslint-plugin/src/rules/no-non-null-assertion.ts	87.09% <0.00%> (ø)
...int-plugin/src/rules/prefer-literal-enum-member.ts	100.00% <0.00%> (ø)
...ackages/eslint-plugin/src/rules/no-explicit-any.ts	92.85% <0.00%> (ø)
... and 145 more

[JoshuaKGoldberg]

Code structure looks great, just requesting a design change (or repudiation of me being wrong)? 🙂

[JoshuaKGoldberg]

This should mention that the option falls back to the value for allowAliases. That's what I would expect.

[JoshuaKGoldberg]

Starting a new thread: let's make sure the existing behavior is preserved?

[JoshuaKGoldberg]

Could you add these test cases back in, please? This shouldn't be a breaking change PR. They should still be valid code.

[JoshuaKGoldberg]

👋 Just checking in @jasperwreed, is this PR still something you have the time to work on? No worries if not, just making sure the issue isn't blocked. 😄