feat(eslint-plugin): [consistent-type-imports] support fixing to inline types #5050

snewcomer · 2022-05-23T14:11:18Z

PR Checklist

Addresses an existing open issue: fixes [consistent-type-imports] prefer inline type import syntax #4338
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

This PR adds a configuration option inline-type-imports that users can utilize to inline their type imports.

Previously, as on Typescript 3.8, we had the ability to import type. This import would be elided from the build deterministically.

import A, { CType } from 'foo';
import type { AType } from 'foo';
import { BType } from 'foo';

As of 4.5, we can inline that type, making it easier to manage top level imports.

import A, { type CType } from 'foo';
import type { AType } from 'foo';
import { type BType } from 'foo';

The summation of the discussion and work is as follows.

fixes a Type import to Inline Type - [New] consistent-type-specifier-style: add rule import-js/eslint-plugin-import#2473.
(this PR) fixes a Value import to Inline Type
adds support for resolving duplicate Type imports to Inline Types to existing import source [New] no-duplicates: support inline type import with prefer-inline option import-js/eslint-plugin-import#2475

nx-cloud · 2022-05-23T14:11:20Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit f92cefd. 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 46 targets

Sent with 💌 from NxCloud.

typescript-eslint · 2022-05-23T14:11:24Z

Thanks for the PR, @snewcomer!

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 · 2022-05-23T14:11:26Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`f92cefd`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6369892a4ef328000850035b
😎 Deploy Preview	https://deploy-preview-5050--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.

packages/eslint-plugin/src/rules/consistent-type-imports.ts

snewcomer · 2022-05-25T17:43:19Z

Fixing a bug with inlining to a value ImportDefaultSpecifier....leaving in draft

snewcomer · 2022-05-28T20:18:24Z

Just a small fYI. Looks like the ember.js repo with this fixer ran on it works.

emberjs/ember.js#20101

JoshuaKGoldberg

This PR looks very snazzy and great at first glance, thanks for sending it! I just want to confirm with @bradzacher that it's not doing more than it should? (I suspect the part of the fixer that merges imports together is not needed)

packages/eslint-plugin/tests/rules/consistent-type-imports.test.ts

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

…t.ts Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

JoshuaKGoldberg

Awesome - thanks so much for iterating on this with us @snewcomer! I'm pumped to get this shipped 😄

addressed

ysulyma · 2022-11-13T15:30:01Z

Can this be removed from the docs (https://typescript-eslint.io/rules/consistent-type-imports/#fixstyle) until it is released? I just spent several minutes troubleshooting

Error: .eslintrc.json:
	Configuration for rule "@typescript-eslint/consistent-type-imports" is invalid:
	Value {"fixStyle":"inline-type-imports"} should NOT have additional properties.

JoshuaKGoldberg · 2022-11-13T15:48:09Z

@ysulyma sorry about that - please see #5939

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.42.1` -> `5.43.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2feslint-plugin/5.42.1/5.43.0) | | [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint) | devDependencies | minor | [`5.42.1` -> `5.43.0`](https://renovatebot.com/diffs/npm/@typescript-eslint%2fparser/5.42.1/5.43.0) | --- ### Release Notes <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/eslint-plugin)</summary> ### [`v5.43.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/eslint-plugin/CHANGELOG.md#5430-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5421v5430-2022-11-14) [Compare Source](typescript-eslint/typescript-eslint@v5.42.1...v5.43.0) ##### Bug Fixes - **eslint-plugin:** \[no-shadow] handle false positives on generics and parameters ([#5902](typescript-eslint/typescript-eslint#5902)) ([769e8c8](typescript-eslint/typescript-eslint@769e8c8)) - **eslint-plugin:** \[promise-function-async] handle keyword token ([#5907](typescript-eslint/typescript-eslint#5907)) ([f25a94f](typescript-eslint/typescript-eslint@f25a94f)) ##### Features - **eslint-plugin:** \[consistent-type-imports] support fixing to inline types ([#5050](typescript-eslint/typescript-eslint#5050)) ([75dcdf1](typescript-eslint/typescript-eslint@75dcdf1)) - **eslint-plugin:** \[naming-convention] add support for "override" and "async" modifiers ([#5310](typescript-eslint/typescript-eslint#5310)) ([#5610](typescript-eslint/typescript-eslint#5610)) ([c759da1](typescript-eslint/typescript-eslint@c759da1)) - **eslint-plugin:** \[prefer-optional-chain] support suggesting `!foo || !foo.bar` as a valid match for the rule ([#5594](typescript-eslint/typescript-eslint#5594)) ([923d486](typescript-eslint/typescript-eslint@923d486)) #### [5.42.1](typescript-eslint/typescript-eslint@v5.42.0...v5.42.1) (2022-11-07) ##### Bug Fixes - **eslint-plugin:** isTypeReadonly stack overflow ([#5875](typescript-eslint/typescript-eslint#5875)) ([#5876](typescript-eslint/typescript-eslint#5876)) ([2d9a33c](typescript-eslint/typescript-eslint@2d9a33c)) </details> <details> <summary>typescript-eslint/typescript-eslint (@typescript-eslint/parser)</summary> ### [`v5.43.0`](https://github.com/typescript-eslint/typescript-eslint/blob/HEAD/packages/parser/CHANGELOG.md#5430-httpsgithubcomtypescript-eslinttypescript-eslintcomparev5421v5430-2022-11-14) [Compare Source](typescript-eslint/typescript-eslint@v5.42.1...v5.43.0) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) #### [5.42.1](typescript-eslint/typescript-eslint@v5.42.0...v5.42.1) (2022-11-07) **Note:** Version bump only for package [@typescript-eslint/parser](https://github.com/typescript-eslint/parser) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about these updates again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1639 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

snewcomer changed the title ~~feat: inline types~~ feat(eslint-plugin): inline types May 23, 2022

snewcomer force-pushed the sn/inline-type branch 5 times, most recently from 6386e8f to c050a8f Compare May 23, 2022 14:53

chriskrycho reviewed May 23, 2022

View reviewed changes

packages/eslint-plugin/src/rules/consistent-type-imports.ts Show resolved Hide resolved

bradzacher changed the title ~~feat(eslint-plugin): inline types~~ feat(eslint-plugin): [consistent-type-imports] support fixing to inline types May 23, 2022

bradzacher added the enhancement: plugin rule option New rule option for an existing eslint-plugin rule label May 23, 2022

snewcomer force-pushed the sn/inline-type branch 4 times, most recently from 1b8e40e to 19c73d2 Compare May 25, 2022 14:57

snewcomer force-pushed the sn/inline-type branch 4 times, most recently from d54fbf9 to 3d525af Compare May 26, 2022 13:10

snewcomer mentioned this pull request May 26, 2022

feat: type modifier on imports emberjs/ember.js#20101

Closed

snewcomer force-pushed the sn/inline-type branch 5 times, most recently from 3cdb01f to fe407d4 Compare May 28, 2022 20:09

snewcomer marked this pull request as ready for review May 28, 2022 20:17

JoshuaKGoldberg reviewed Jun 2, 2022

View reviewed changes

packages/eslint-plugin/tests/rules/consistent-type-imports.test.ts Outdated Show resolved Hide resolved

snewcomer and others added 17 commits November 7, 2022 16:39

better doc with link to 4.5

4f43a77

fix lint

043933e

cleanup comments

a50cd23

Update packages/eslint-plugin/docs/rules/consistent-type-imports.md

cf703a0

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Update packages/eslint-plugin/docs/rules/consistent-type-imports.md

6798d7e

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Update packages/eslint-plugin/docs/rules/consistent-type-imports.md

055db8d

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Update packages/eslint-plugin/src/rules/consistent-type-imports.ts

7104930

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

Update packages/eslint-plugin/src/rules/consistent-type-imports.ts

696ddb5

Co-authored-by: Josh Goldberg <me@joshuakgoldberg.com>

fix changelog formatting

821add2

Update packages/eslint-plugin/docs/rules/consistent-type-imports.md

849c2eb

Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

try single quotest

77298af

cleanup not valid comment anymore

2b18686

Update packages/eslint-plugin/tests/rules/consistent-type-imports.tes…

ec60d5b

…t.ts Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

Update packages/eslint-plugin/tests/rules/consistent-type-imports.tes…

83d095b

…t.ts Co-authored-by: Josh Goldberg <git@joshuakgoldberg.com>

rm comment

12dad78

improve documentation with feedback

5c26e08

add tabs

f92cefd

snewcomer force-pushed the sn/inline-type branch from 0f997e8 to f92cefd Compare November 7, 2022 22:39

snewcomer requested review from JoshuaKGoldberg and removed request for bradzacher November 7, 2022 22:41

JoshuaKGoldberg approved these changes Nov 7, 2022

View reviewed changes

JoshuaKGoldberg merged commit 75dcdf1 into typescript-eslint:main Nov 7, 2022

snewcomer deleted the sn/inline-type branch November 8, 2022 00:00

mrmckeb mentioned this pull request Nov 8, 2022

Configure fixStyle in consistent-type-imports vercel/style-guide#38

Closed

fregante mentioned this pull request Nov 8, 2022

Update rule to prefer import {type X} over import type {X} xojs/eslint-config-xo-typescript#64

Closed

github-actions bot locked as resolved and limited conversation to collaborators Nov 21, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(eslint-plugin): [consistent-type-imports] support fixing to inline types #5050

feat(eslint-plugin): [consistent-type-imports] support fixing to inline types #5050

snewcomer commented May 23, 2022 •

edited

Loading

nx-cloud bot commented May 23, 2022 •

edited

Loading

typescript-eslint bot commented May 23, 2022

netlify bot commented May 23, 2022 •

edited

Loading

snewcomer commented May 25, 2022

snewcomer commented May 28, 2022

JoshuaKGoldberg left a comment

JoshuaKGoldberg left a comment

ysulyma commented Nov 13, 2022

JoshuaKGoldberg commented Nov 13, 2022

feat(eslint-plugin): [consistent-type-imports] support fixing to inline types #5050

feat(eslint-plugin): [consistent-type-imports] support fixing to inline types #5050

Conversation

snewcomer commented May 23, 2022 • edited Loading

PR Checklist

Overview

nx-cloud bot commented May 23, 2022 • edited Loading

☁️ Nx Cloud Report

typescript-eslint bot commented May 23, 2022

netlify bot commented May 23, 2022 • edited Loading

✅ Deploy Preview for typescript-eslint ready!

snewcomer commented May 25, 2022

snewcomer commented May 28, 2022

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

ysulyma commented Nov 13, 2022

JoshuaKGoldberg commented Nov 13, 2022

snewcomer commented May 23, 2022 •

edited

Loading

nx-cloud bot commented May 23, 2022 •

edited

Loading

netlify bot commented May 23, 2022 •

edited

Loading