microsoft / microsoft/TypeScript
Code completion: suggest tokens from "paths" in tsconfig.json
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Search Terms
Code completion; module
Suggestion
Use Cases
For those paths which contains no wildcard character, can we suggest tokens from module it points?
For example:
{
"baseUrl": '.',
"paths": {
"my-base-module": [
"../../dest/base"
],
}
in the example, we can say that bare module specifier "my-base-module" is mapped to path "../../dest/base", which is actually a .d.ts.
However, my IDE(Visual Studio Code) do not list available symbols in "my-base-module",
such as, When I type:
const v: Ve // I 'm going to type Vec3, which is defined in "../../dest/base".
I hopo IDE can suggest Vec3 and auto-complete the importing statement as:
import { Vec3 } from "my-base-module";
You may ask: Why don't you put "../../dest/base" in "types" option in tsconfig.json.
Well, the "../../dest/base" is just a library of me. It is indeed another Typescript project's output bundle file(bundling use rollup). It is bundled as a single module, which, in later, maybe registered as a SystemJS module with name "my-base-module" because I hope users of the library treat the library as a single JS module so they can write:
import /* xx */ from "my-base-module";
Examples
As stated above, I would upload my example if it's needed.
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
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
The issue provides a tsconfig.json paths example and a TypeScript code-completion scenario, but names no repository files or tests. Begin by reproducing the missing completion for Vec3 through the mapped bare module; done means symbols from the mapped bundle are suggested and the import uses "my-base-module".
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 28/100