File detail
functional-code-comment-references.rq
reqlan rq/extension/language/comment-references/functional-code-comment-references.rq
| Idea | Status | Tags | Summary | Katz |
|---|---|---|---|---|
| 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_resting_underline | done | In non- `.rq` source comments, every `rq:[…]` token must show a resting underline so it is clear the site is link-shaped. Use TextMate scope `meta.link.reqlan markup.underline` via the comment injection grammar. Do not rely on file document links for that cue — those stay stripped ( ["../syntax/features-syntax-highlighting.rq".editor_reference_activation] ). Navigation remains Ctrl + click go-to-definition for resolved sites ( [references_in_functional_code_comments] ). Related: [references_in_functional_code_comments], ["../syntax/features-syntax.rq".comment_support]. | 0.146 | |
| 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 | |
| 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_resolution_error_state | done | [comment_reference_resolution_error] The language server must share one resolution result for clickable links and the error underline. Resolve comment references once against the loaded idea index, then reuse that result for both consumers. When you create an idea that matches a comment reference, the language server must clear the underline and the missing-idea message. Resolution and the index should be performed once and shared between consumers. | 0.053 | |
| comment_reference_import_root_alias | done | Qualified comment references use the same path forms as imports, including import-root aliases such as `@/`. `rq:["@/path/relative/to/import/root.rq".idea]` resolves against the alias's import-root directory ( workspace folder by default ), not the source file directory. `@reqs` without a following `/` is not an alias. Configured aliases and roots follow ["../../../language/imports.rq".configuration_import_root_alias] and ["../../host/configuration.rq".configuration_import_roots]. The language server applies this when resolving comment references in `.rq` files. The extension applies the same core resolver for `rq:[…]` links in non- `.rq` source. Related: ["../../../language/syntax.rq".comment_reference], [references_in_functional_code_comments], ["../../../language/imports.rq".import_paths]. | 0.235 |
Related clusters
community
status
tag
Local graph
Initialising graph…