Typescript: Add option to disable TS using inline import types in quick fixes

Created on 13 Nov 2019  路  5Comments  路  Source: microsoft/TypeScript


TypeScript Version: 3.8.0-dev.20191112


Search Terms:

  • Implement interface
  • quick fix
  • code action
  • add missing imports

Code
For a small project:

iface.ts

export interface IValue {
    value: number;
}

export interface IFace {
    do(value: IValue): void;
}

index.ts

import { IFace } from "./iface";

export class Foo implements IFace {}
  1. Run implement interface on Foo

Current Behavior:
The generated code is:

import { IFace } from "./iface";

export class Foo implements IFace {
    do(value: import("./iface").IValue): void {
        throw new Error("Method not implemented.");
    }
}

Request
We would like an option to tell TypeScript to not use inline imports and instead always add normal imports at the top of the file.

import { IFace, IValue } from "./iface";

export class Foo implements IFace {
    do(value: IValue): void {
        throw new Error("Method not implemented.");
    }
}

/cc @bpasero Since I know you were passionate about this issue

Quick Fixes Fix Available In Discussion Suggestion

Most helpful comment

For VS Code, we would prefer adding regular imports. I agree though that this should not introduce an error, so observing importsNotUsedAsValues and using import type instead makes sense to me

All 5 comments

In #32910, @DanielRosenwasser said

We should always prefer an import statement at the top of the file.

In that fix, we didn鈥檛 discuss adding an option, we just made it always do an import declaration. @mjbvz do people really want an option, or does it seem like most people just want the import declaration?

It should also be noted that #35200 could have an impact on this discussion, so we may want to wait and see where it lands, particularly on whether the default behavior of the compiler鈥檚 elision of imports used only in type positions is going to change.

@andrewbranch Yes I think VS Code would prefer that imports always be added at the top of the file. I'm not sure if other users prefer inline imports however, which is why I proposed having a setting to control this. We should try getting actual user feedback on this

Also 馃憤 for #35200

@mjbvz @DanielRosenwasser: with type-only imports in master, the discussion at #36038, and #36412 looking likely to be merged, what鈥檚 the latest feeling on the right thing to do here?

On one hand, auto-imports will not use import type, so maybe we should match that here and use a regular import at the top of the file. On the other hand, that has unwanted effects if importsNotUsedAsValues is preserve or error. Could that be used as a heuristic to write a type-only import? (And actually, should that same heuristic be used for auto-imports?)

For VS Code, we would prefer adding regular imports. I agree though that this should not introduce an error, so observing importsNotUsedAsValues and using import type instead makes sense to me

Was this page helpful?
0 / 5 - 0 ratings

Related issues

bgrieder picture bgrieder  路  3Comments

seanzer picture seanzer  路  3Comments

kyasbal-1994 picture kyasbal-1994  路  3Comments

uber5001 picture uber5001  路  3Comments

weswigham picture weswigham  路  3Comments