Code reference detail
reqlan-imports.ts
packages/language/src/reqlan-imports.ts
| Idea | Status | Tags | Summary | Katz |
|---|---|---|---|---|
| implicit_file_extension | The import statements should not require an extension, i. e. it should assume ". rq " unless otherwise specified. An extensionless path resolves to the ". rq " file first, then to a literal extensionless file or folder. A path that already carries any extension is resolved exactly as written. Folder targets: [import_folder_targets]. | 0.195 | ||
| import_does_not_exist_error | Imports show an underline error when the target file or folder does not exist. Imports also show an underline error when a named imported idea does not exist in the target file. An existing folder is not an error: [import_folder_targets]. CI: ["../../../core_analysis/check.rq".check_unresolved_imports]. [general_errors] | 0.151 | ||
| import_folder_targets | done | An import path may refer to a folder. A folder is a valid import target when that path exists as a directory. Namespace import of a folder binds the alias to that folder, the same as a file. Extensionless paths still prefer a `.rq` file: [implicit_file_extension]. Related: ["../../../language/imports.rq".import_paths], [import_does_not_exist_error], ["../syntax/features-syntax.rq".file_references]. | 0.164 | |
| remote_imports | Reqlan files should support importing requirements from remote urls. Remote import syntax should follow import " https://company.com/reqs/style.rq" as styleguide. The extension should resolve, cache, and validate remote imports. Barrel imports should be recommended for token efficiency when many symbols are needed from one remote file. | 0.040 | ||
| aliased_from_import_ctrl_click | done | A from-import alias that contains the imported idea name as a suffix or substring must offer one Ctrl + click destination for the whole written alias. Example: `from "@/_charter/plant-ontology.rq" import simulation as ontology-simulation` then `[ontology-simulation]`. The document-link underline must cover `ontology-simulation`, not only `simulation`. Ctrl + click on any character of that alias must open the imported idea in the import-root target file. Do not resolve the import path a second time against the current file directory. Do not offer a second interactive link on the original idea-name suffix. Related: [reference_document_links], [reference_underline_syntax_align], [non_web_reference_navigation], ["../../../language/imports.rq".import_from], ["../../../language/imports.rq".configuration_import_root_alias]. | 0.086 | |
| complementary_information_rendering | The extension should render computed information inline in the editor as complementary text. Complementary rendering should include resolved references and optionally indirect references behind a toggle. Complementary rendering should not mutate source files unless the user explicitly applies a change. | 0.040 | ||
| file_suffix | Reqlan requirement documents use the. rq file suffix. | 0.052 | ||
| reference_file | References may target arbitrary files, not only. rq files. File reference syntax uses a bracketed quoted path. A relative path resolves from the document directory. When that path climbs with `..` and the file is not there, the same path is tried from each ancestor directory up to the workspace folder. The document-directory file wins when it exists. Line or line-range references append `L#n` or `L#n-m` after the path inside the brackets. Test-name references append `:` and the test title after the path ( for example `./app.test.ts:lists items` ). The first `:` after the path starts the title; later `:` characters stay in the title ( `e2e: …` ). `://` and a Windows drive `C:` / `C:/` are part of the path, not a test suffix. Symbol references append a dot-separated symbol path after the quoted file path. Quoted body text is not a file reference: ["../reference_types.rq".reference_edgecase]. | 0.266 | ||
| import_statement | done | Imports describe references. Some [keyword] s are reserved for imports. Forms: ["./language/imports.rq".import_from], ["./language/imports.rq".import_namespace], ["./language/imports.rq".import_qualified]. Grammar: [reqlan_grammar] `Import`; resolve: [import_resolver]. | 0.063 | |
| keyword | done | As a language, reqlan has keywords that are reserved in some contexts. Import statement keywords: ["./language/imports.rq".import_keywords] ( `import`, `from`, `as` ). Grammar: [reqlan_grammar] — those tokens are keywords only at statement start. Idea names should not use reserved keywords ( [idea_name] ). | 0.057 |
Reference labels
"../../../../packages/language/src/reqlan-imports.ts", "../../packages/language/src/reqlan-imports.ts", ../../../../packages/language/src/reqlan-imports.ts, ../../packages/language/src/reqlan-imports.ts, ../packages/language/src/reqlan-imports.ts