microsoft / microsoft/TypeScript
Handle JSDoc {@link ... } inline tags for OS
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- Avg merge
- 1d 19h
- Merged PRs (30d)
- 117
Description
🔍 Search Terms
JSDoc @link for local OS
✅ Viability Checklist
- 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 isn't a request to add a new utility type: https://github.com/microsoft/TypeScript/wiki/No-New-Utility-Types
- This feature would agree with the rest of our Design Goals: https://github.com/Microsoft/TypeScript/wiki/TypeScript-Design-Goals
⭐ Suggestion
like this post :
https://github.com/microsoft/TypeScript/issues/16498
can we also add support for local OS drive ?
I work on 2 project, and i would like to be able to open external file to another projet .
📃 Motivating Example
ex:
iif am in project projets\ANFTECS-WEB , i would like to add a clickable note link to projets\ANFTECS
/** @see {@link D:\Users\jonle\Documents\DEV\projets\ANFTECS\src\game\enum\battle.enums.ts} */
Actually, the link is not clickable, and I need to open the folder and the file manually.
It's just not very time-efficient and productive!
I would like to open the file when I ctrl+click on it, like a web address. Is it possible to add this support ?
Thank you
💻 Use Cases
- What do you want to use this for?
work on multi project connected with security and productivity (on the same machine or server)
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 names no files or tests; it describes JSDoc {@link ...} handling and a Windows local-drive path example. Start by reviewing the existing link behavior and the referenced issue #16498, then determine how local paths should be recognized. Done means Ctrl+click opens the referenced external file or project path.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, typescript
- Domain
- developer-experience, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100