Microsoft/TypeScript

Import auto-import doesn't take into account the current import statement

Open

#52,788 opened on Feb 15, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (6,726 forks)batch import
Experience EnhancementHelp WantedSuggestion

Repository metrics

Stars
 (48,455 stars)
PR merge metrics
 (Avg merge 6d 17h) (9 merged PRs in 30d)

Description

Bug Report

🔎 Search Terms

  • import
  • auto-import

💻 Code

Use Visual Studio for the following:

  1. In file1.ts, write export zero = 0;
  2. In file2.ts, write import ze and notice the completion entry for zero.

🙁 Actual behavior

If the completion entry for zero is selected, the contents in file2.ts will be replaced by:

import { zero } from "./file1.ts";
import z

After discussing the bug with @andrewbranch, he pointed out how this is the correct behavior because the entry that VS is showing corresponds to an auto-import.

🙂 Expected behavior

The auto-import completion entry shouldn't show up if the current line corresponds to an import statement itself (in case the editor doesn't have preferences.includeCompletionsForImportStatements and preferences.includeCompletionsWithInsertText set).

Contributor guide

Research direction
Examine the auto import completion logic in TypeScript's language service to determine why import completions appear on an existing import statement line. Look at how completion entries are filtered based on context, particularly the `includeCompletionsForImportStatements` and `includeCompletionsWithInsertText` preferences.
Tech stack
typescript
Domain
backenddeveloper experience
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
TypeScriptVSCode
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30