Skip to content

Ignore non-ts/js files in move to file refactorΒ #56749

Open
@jasonlyu123

Description

@jasonlyu123

πŸ” Search Terms

move to file, has unknown extension.

βœ… Viability Checklist

⭐ Suggestion

In getMoveToRefactoringFileSuggestions, changes to use tryGetExtensionFromPath to filter candidate files to move to. And ignore the unknown file extension. It would be nice if it could fall back or switch to using SourceFile.scriptKind and SourceFile.isDeclarationFile, but ignoring unknown extensions for at least the candidates should be fine.

πŸ“ƒ Motivating Example

The "Move to file" refactor currently errors if the program contains any source files with a file extension unknown to TypeScript.
Is it possible to remove this restriction? The error is because the getMoveToRefactoringFileSuggestions method uses the extensionFromPath function to find candidates from all the files in the program. If any typescript plugin provides external files with non-ts/js file extension, This will result in a Debug.assert error. For example, mrmckeb/typescript-plugin-css-modules#241

Most of the other language service features don't have this restriction. At least it won't error whenever one external file is in the program. It would be nice if this feature could work with other file extensions. And even allow this feature to be used in other language servers that wrap typescript language service.

πŸ’» Use Cases

  • What do you want to use this for?
    Using the move to file refactor in projects where a typescript plugin adds a custom module, like vue and svelte.

  • Workarounds I can think of
    The TypeScript plugins monkey patch program.getSourceFiles before calling the getMoveToRefactoringFileSuggestions and restoring it afterwards.

Metadata

Metadata

Assignees

Labels

BugA bug in TypeScript

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions