question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. ItΒ collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

feat: open @see link online documentation from VSCode

See original GitHub issue

🐞 bug report

Is this a regression?

Not to my knowledge.

Description

Intellisense @see links not opening online documentation but instead trying to open local nonexistent file. If I manually prefix any @see with β€œhttps://angular.io” in *.d.ts file link works.

e.g. not working: @see [Using change detection hooks](guide/lifecycle-hooks#using-change-detection-hooks) working: @see [Using change detection hooks](https://angular.io/guide/lifecycle-hooks#using-change-detection-hooks)

Bug Type

What does this bug affect

  • Angular Language Service VSCode extension
  • Angular Language Service server

Reproduction

Hover any class or property to get intellisense and if @see link is present it will behave like described.

Expected behavior

Online documentation should be opened in browser.

🌍 Your Environment

Angular Version:


Angular CLI: 13.0.4
Node: 12.22.7
Package Manager: npm 6.14.15
OS: win32 x64

Angular: 13.0.3
... animations, common, compiler, compiler-cli, core, forms
... platform-browser, platform-browser-dynamic, router

Package                         Version
---------------------------------------------------------
@angular-devkit/architect       0.1300.4
@angular-devkit/build-angular   13.0.4
@angular-devkit/core            13.0.4
@angular-devkit/schematics      13.0.4
@angular/cli                    13.0.4
@schematics/angular             13.0.4
rxjs                            7.4.0
typescript                      4.4.4

Extension Version:


v13.2.2

VSCode Version:


Version: 1.62.3 (system setup)
Commit: ccbaa2d27e38e5afa3e5c21c1c7bef4657064247
Date: 2021-11-17T08:11:14.551Z
Electron: 13.5.2
Chrome: 91.0.4472.164
Node.js: 14.16.0
V8: 9.1.269.39-electron.0
OS: Windows_NT x64 10.0.19044

Operating System:


Windows_NT x64 10.0.19044

Extension options:


"angular.enable-strict-mode-prompt": true,
"angular.log": "off",
"angular.suggest.includeAutomaticOptionalChainCompletions": true,
"angular.suggest.includeCompletionsWithSnippetText": true,
"angular.trace.server": "off",
"angular.view-engine": false,

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Reactions:4
  • Comments:8 (5 by maintainers)

github_iconTop GitHub Comments

1reaction
gkalpakcommented, Feb 9, 2022

As @atscott said, the @see annotations are mostly intended to be processed by the doc-generation pipeline and generate links. For example, most of the annotations have backticked code instead of links (for example, @see `AnimationBuilder`), which the doc-generation pipeline knows how to convert to links.

Maybe we could tweak the DTS files (which I assume is where intellisense retrieves information from to prefix relative links with https://angular.io/ or alternatively use absolute links in the code and remove the https://angular.io/ prefix when generating the docs.

This might be a feature that could be added to the Angular.io documentation utilities extension. (//cc @gkalpak)

The Angular.io documentation utilities extension is intended for docs authors, not for Angular app developers. So, it wouldn’t help much πŸ˜ƒ

0reactions
angular-automatic-lock-bot[bot]commented, Jul 14, 2022

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Documentation for Visual Studio Code
Find out how to set-up and get the most from Visual Studio Code. Optimized for building and debugging modern web and cloud applications....
Read more >
November 2022 (version 1.74) - Visual Studio Code
Learn what is new in the Visual Studio Code November 2022 Release (1.74)
Read more >
Code Navigation in Visual Studio Code
VS Code provides two powerful commands to navigate in and across files with easy-to-use key bindings. Hold Ctrl and press Tab to view...
Read more >
Ruby Solargraph - Visual Studio Marketplace
Extension for Visual Studio Code - A Ruby language server featuring code completion, intellisense, and inline documentation.
Read more >
VS Code API | Visual Studio Code Extension API
A document link is a range in a text document that links to an internal or external resource, like another text document or...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found