microsoft / microsoft/TypeScript
JSDoc for file/directory autocompletion
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 2d 4h
- Merged PRs (30d)
- 132
Description
Suggestion
🔍 Search Terms
directory autocompletion
file autocompletion
path autocompletion
path intellisense
cwd autocompletion
✅ Viability 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, new syntax sugar for JS, etc.)
- This feature would agree with the rest of TypeScript's Design Goals.
⭐ Suggestion
An new JSDoc like /* @ts-ignore */ for directory/file autocompletion for an folder (e.g. default: cwd)
e.g.:
Plugin Options:
interface PluginOptions {
/* @ts-path-autocompletion (optional define path; default: cwd) */
file: string
}
📃 Motivating Example
It can help to choose the path instead of typing it.
And maybe warn if the path does not exist. (Disabling would be handy for files and folders that are still being created)
💻 Use Cases
IntelliSense for an path in another folder for e.g. webpack plugin options.
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 proposal does not mention any files, tests, or entry points. Start by determining where JSDoc/plugin options and path completion are handled, then define the supported annotation behavior, path scope, and handling of missing files before implementation; done means the requested completion works for the described use cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- developer-experience
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100