microsoft / microsoft/TypeScript

[language server] Apply codefix to all files

Open
#33,195 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

  • File is a CommonJS module; it may be converted to an ES6 module.
  • Apply codefixes to all files (vscode, visual studio code)
  • Convert all files from CommonJS to ES6

Suggestion

I would like to have some way to apply a specific codefix to all files in a directory. For example, convert a bunch of files from CommonJS format to the new ES6 module format using the codefix here.

Use Cases

I have a few hundred files in CommonJS module format that I want to convert to ES6 module syntax (export/import instead of exports/require).

Currently, my text editor (vscode) shows after some delay three dots at the top of the current file which, when hovered over with the mouse shows after a few more seconds delay a "quickFix" button that, when clicked, causes the current file to be converted. To convert all of my files with this method would take hours of tedious clicking.

I want some method of automating this process.

Examples

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/services/codefixes/convertToEs6Module.ts and trace how the TypeScript language server exposes and applies that codefix in VS Code. Determine the design for selecting a directory and applying one codefix across its files; done means the requested codefix can be automated for all applicable files.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript, vscode
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.