Code reference detail
comment-reference-languages.ts
packages/extension/src/extension/comment-reference-languages.ts
| Idea | Status | Tags | Summary | Katz |
|---|---|---|---|---|
| comment_reference_language_blocklist | done | Comment rq editor features ( goto, diagnostics, ignore actions, navigate-back origin tracking ) apply to every language except a small blocklist. The blocklist is `reqlan` plus non-source editor buffers ( log, search-result, SCM input, git commit / rebase, github-issues ). The rust language client uses a file-scheme document selector and skips sync for blocklisted languages. TextMate resting underline injects into a wide `injectTo` scope list ( best-effort; goto still works without a matching grammar scope ). Related: [references_in_functional_code_comments], [comment_reference_resting_underline], ["../../../language/syntax.rq".comment_reference]. | 0.178 | |
| comment_reference_navigate_back | done | A go-to-definition JUMP from a comment `rq:[…]` host must push the pre-jump caret onto the same navigate-back stack as `.rq` jumps. The stack tracks every non-blocklisted language ( ["../../../../packages/extension/src/extension/comment-reference-languages.ts"] ) as well as `.rq`. Only landings in `.rq` / `reqlan` are recorded, so other language servers do not fill the stack. Alt + Left ( `reqlan.navigateBack` ) restores that caret when `reqlan.canNavigateBack` is set, in any focused editor. Related: [references_in_functional_code_comments], [comment_reference_language_blocklist], ["../syntax/features-syntax-highlighting.rq".editor_reference_activation]. | 0.114 | |
| references_in_functional_code_comments | done | Comments in functional code should be able to reference reqlan ideas using the an `rq:` prefixed to an idea: `rq:[idea]` as demonstrated in python, but actually applicable to any language's comment context: Editor hosts are every language except [comment_reference_language_blocklist]. With the rust language server, a resolved `rq:[…]` site is Ctrl + click navigable via go-to-definition. File document links stay out of the editor ( ["../syntax/features-syntax-highlighting.rq".editor_reference_activation] ). Comment `rq:[…]` sites use TextMate `meta.link.reqlan markup.underline` so the resting editor shows they are link-shaped ( [comment_reference_resting_underline] ). After that goto, Alt + Left restores the comment-host caret ( [comment_reference_navigate_back] ). Missing ideas keep the error underline and have no definition target. Relates to ["../../mutation/refactor_support.rq".comment_reference_refactor_support], [comment_reference_import_root_alias], ["../support/language-server-rust.rq".language_server_rust], ["../syntax/features-syntax-highlighting.rq".editor_reference_activation]. | 0.300 | |
| comment_reference | done | Reqlan references may appear in line comments of arbitrary source files. Comment reference syntax is `rq:[idea]` or `rq:["path".idea]` ( quoted path, optional extra qualification ). Qualified paths use the same path forms as imports, including import-root aliases such as `@/` — ["imports.rq".configuration_import_root_alias], ["../extension/language/comment-references/functional-code-comment-references.rq".comment_reference_import_root_alias]. Discovery skips quoted strings, including Rust raw strings ( `r#"…"#`, `r##"…"##`, `br#"…"#` ), so `rq:[…]` text in a string is not a live comment. Editor language coverage is a blocklist, not an allowlist: ["../extension/language/comment-references/functional-code-comment-references.rq".comment_reference_language_blocklist]. Indexed as `comment_link` by ["../indexer/indexer.rq".index_code_files]. Unresolved targets: [comment_reference_resolution_error]. Indexer listing: ["../core_analysis/core.rq".test_references]. Refactors: ["../extension/mutation/refactor_support.rq".comment_reference_refactor_support]. | 0.365 | |
| file_suffix | Reqlan requirement documents use the. rq file suffix. | 0.052 |
Reference labels
"../../../../packages/extension/src/extension/comment-reference-languages.ts", "../../packages/extension/src/extension/comment-reference-languages.ts", ../../../../packages/extension/src/extension/comment-reference-languages.ts, ../../packages/extension/src/extension/comment-reference-languages.ts