spec - configuration_import

Katz0.167

Summary

`importRoots` is an optional array of alias-to-directory mappings in `.reqlan/config.json`.
Each mapping has:
- `alias` ( required non-empty string ): prefix before `/` in aliased import paths.
- `root` ( optional non-empty string ): directory for that alias.
A relative `root` resolves against the base root ( the parent of `.reqlan` ), not against the `.reqlan` directory.
An absolute path or `file://` URI is used as that alias' import-root directory directly.
When `root` is omitted for a mapping, that alias uses the workspace folder that contains the `.rq` file.
When `importRoots` is omitted, empty, or has no valid entries, the default is one mapping with alias `importRootAlias` from defaults.json and no explicit root.
When several aliases could match a path, the longest alias wins.
Invalid or unreadable JSON, and a non-array `importRoots` value, fall back to defaults ( or no loaded config for discovery, then defaults at resolve time ).
Language path forms and `@/` shorthand: import_paths and configuration_import_root_alias.
Comment references in source files use the same mappings: comment_reference_import_root_alias.
Schema: configuration_schema_file. Applying file discovery: configuration_location.
Editor completion of aliased import paths: code_completion.

Jump to outbound references

Jump to inbound references

Navigation

Source file

reqlan rq/extension/host/configuration.rq

community 1

community cluster

configuration.rq

file cluster

reqlan rq/extension/host

folder cluster

status: Not present

status cluster

tag: Not present

tag cluster

Printable page

Static print-friendly idea sheet.

Attributes

Key	Value
implementation	reqlan-path-resolve.ts, file-path-rewrite.ts, reqlan-completion-provider.ts, reqlan-path-completion.ts, reqlan-comment-diagnostics.ts, comment-reference-path-context.ts, register-comment-reference-links.ts, config.schema.json, path.rs, path_resolve.rs, broken.rs, sync.rs, analysis.rs, session.rs
tests	config.test.ts:empty object uses default alias mapping, config.test.ts:importRoots alias only overrides the alias, config.test.ts:relative root resolves against the base root, config.test.ts:absolute filesystem root is used directly, config.test.ts:Windows drive-letter root is used as a file URI not scheme c:, config.test.ts:file URI root is used directly, config.test.ts:multiple importRoots map aliases to different roots, config.test.ts:longest alias wins when mappings overlap, config.test.ts:empty string alias entries are skipped, config.test.ts:empty string root is ignored on a mapping, config.test.ts:invalid importRoots entries are skipped, config.test.ts:unknown properties are ignored while known keys still apply, config.test.ts:invalid JSON falls back to undefined load, config.test.ts:non-object JSON falls back to undefined load, config.test.ts:non-array importRoots falls back to undefined load, config.test.ts:empty importRoots array uses default alias mapping, config.test.ts:resolveRqConfig falls back to defaults when applying JSON is invalid, config.test.ts:aliased path uses relative root from applying config, config.test.ts:aliased path uses workspace folder when root is omitted, path-resolve.test.ts:loads importRoots list from nearest base config, path-resolve.test.ts:resolves using config importRoots mapping, path-resolve.test.ts:rewrite leaves aliased paths unchanged, path-resolve.test.ts:toDirectoryUri does not parse a drive letter as a URI scheme, completion.test.ts:completes import-root alias paths, comment-reference-resolution.test.ts:creates a document link for an import-root aliased comment reference, path_resolve.rs:locate_uses_import_roots_from_applying_config, broken_references.rs:check_honours_import_roots_from_applying_config, parity.rs:import_root_config_file_refs_match_check, path.rs:resolves_default_alias_against_workspace_folder, path_resolve.rs:missing_import_roots_uses_default_alias, path_resolve.rs:relative_root_resolves_against_base

Key

Value

implementation

reqlan-path-resolve.ts, file-path-rewrite.ts, reqlan-completion-provider.ts, reqlan-path-completion.ts, reqlan-comment-diagnostics.ts, comment-reference-path-context.ts, register-comment-reference-links.ts, config.schema.json, path.rs, path_resolve.rs, broken.rs, sync.rs, analysis.rs, session.rs

tests

config.test.ts:empty object uses default alias mapping, config.test.ts:importRoots alias only overrides the alias, config.test.ts:relative root resolves against the base root, config.test.ts:absolute filesystem root is used directly, config.test.ts:Windows drive-letter root is used as a file URI not scheme c:, config.test.ts:file URI root is used directly, config.test.ts:multiple importRoots map aliases to different roots, config.test.ts:longest alias wins when mappings overlap, config.test.ts:empty string alias entries are skipped, config.test.ts:empty string root is ignored on a mapping, config.test.ts:invalid importRoots entries are skipped, config.test.ts:unknown properties are ignored while known keys still apply, config.test.ts:invalid JSON falls back to undefined load, config.test.ts:non-object JSON falls back to undefined load, config.test.ts:non-array importRoots falls back to undefined load, config.test.ts:empty importRoots array uses default alias mapping, config.test.ts:resolveRqConfig falls back to defaults when applying JSON is invalid, config.test.ts:aliased path uses relative root from applying config, config.test.ts:aliased path uses workspace folder when root is omitted, path-resolve.test.ts:loads importRoots list from nearest base config, path-resolve.test.ts:resolves using config importRoots mapping, path-resolve.test.ts:rewrite leaves aliased paths unchanged, path-resolve.test.ts:toDirectoryUri does not parse a drive letter as a URI scheme, completion.test.ts:completes import-root alias paths, comment-reference-resolution.test.ts:creates a document link for an import-root aliased comment reference, path_resolve.rs:locate_uses_import_roots_from_applying_config, broken_references.rs:check_honours_import_roots_from_applying_config, parity.rs:import_root_config_file_refs_match_check, path.rs:resolves_default_alias_against_workspace_folder, path_resolve.rs:missing_import_roots_uses_default_alias, path_resolve.rs:relative_root_resolves_against_base

Browse all attributes

Ancestor context

No ancestor chain recorded.

Outbound references

Inbound references

Kind	Idea	Path	Snippet
references	configuration_location	reqlan rq/extension/host/configuration.rq	configuration_import_roots
references	base_config_seed	reqlan rq/extension/host/installation.rq	configuration_import_roots
references	comment_reference_import_root_alias	reqlan rq/extension/language/comment-references/functional-code-comment-references.rq	configuration_import_roots
references	code_completion	reqlan rq/extension/language/syntax/features-syntax.rq	configuration_import_roots
references	configuration_import_root_alias	reqlan rq/language/imports.rq	configuration_import_roots

Unresolved references

Kind	Idea	Path	Snippet
None

Local graph

Initialising graph…

Kind	Idea	Path	Snippet
file_reference	"../../../packages/analytical/src/core/defaults.json"	packages/analytical/src/core/defaults.json	defaults.json
references	import_paths	reqlan rq/language/imports.rq	import_paths
references	configuration_import_root_alias	reqlan rq/language/imports.rq	configuration_import_root_alias
references	comment_reference_import_root_alias	reqlan rq/extension/language/comment-references/functional-code-comment-references.rq	comment_reference_import_root_alias
references	configuration_schema_file	reqlan rq/extension/host/configuration.rq	configuration_schema_file
references	configuration_location	reqlan rq/extension/host/configuration.rq	configuration_location
references	code_completion	reqlan rq/extension/language/syntax/features-syntax.rq	code_completion
file_reference	"../../../packages/language/src/reqlan-path-resolve.ts"	packages/language/src/reqlan-path-resolve.ts	reqlan-path-resolve.ts
file_reference	"../../../packages/language/src/file-path-rewrite.ts"	packages/language/src/file-path-rewrite.ts	file-path-rewrite.ts
file_reference	"../../../packages/language/src/reqlan-completion-provider.ts"	packages/language/src/reqlan-completion-provider.ts	reqlan-completion-provider.ts
file_reference	"../../../packages/language/src/reqlan-path-completion.ts"	packages/language/src/reqlan-path-completion.ts	reqlan-path-completion.ts
file_reference	"../../../packages/language/src/reqlan-comment-diagnostics.ts"	packages/language/src/reqlan-comment-diagnostics.ts	reqlan-comment-diagnostics.ts
file_reference	"../../../packages/extension/src/extension/comment-reference-path-context.ts"	packages/extension/src/extension/comment-reference-path-context.ts	comment-reference-path-context.ts
file_reference	"../../../packages/extension/src/extension/register-comment-reference-links.ts"	packages/extension/src/extension/register-comment-reference-links.ts	register-comment-reference-links.ts
file_reference	"../../../packages/extension/schemas/config.schema.json"	packages/extension/schemas/config.schema.json	config.schema.json
file_reference	"../../../crates/reqlan-parse/src/path.rs"	crates/reqlan-parse/src/path.rs	path.rs
file_reference	"../../../crates/reqlan-index/src/path_resolve.rs"	crates/reqlan-index/src/path_resolve.rs	path_resolve.rs
file_reference	"../../../crates/reqlan-index/src/broken.rs"	crates/reqlan-index/src/broken.rs	broken.rs
file_reference	"../../../crates/reqlan-index/src/sync.rs"	crates/reqlan-index/src/sync.rs	sync.rs
file_reference	"../../../crates/reqlan-lsp/src/analysis.rs"	crates/reqlan-lsp/src/analysis.rs	analysis.rs
file_reference	"../../../crates/reqlan-lsp/src/session.rs"	crates/reqlan-lsp/src/session.rs	session.rs
file_reference	"../../../packages/language/test/config.test.ts:empty object uses default alias mapping"	packages/language/test/config.test.ts	config.test.ts:empty object uses default alias mapping
file_reference	"../../../packages/language/test/config.test.ts:importRoots alias only overrides the alias"	packages/language/test/config.test.ts	config.test.ts:importRoots alias only overrides the alias
file_reference	"../../../packages/language/test/config.test.ts:relative root resolves against the base root"	packages/language/test/config.test.ts	config.test.ts:relative root resolves against the base root
file_reference	"../../../packages/language/test/config.test.ts:absolute filesystem root is used directly"	packages/language/test/config.test.ts	config.test.ts:absolute filesystem root is used directly
file_reference	"../../../packages/language/test/config.test.ts:Windows drive-letter root is used as a file URI not scheme c:"	packages/language/test/config.test.ts	config.test.ts:Windows drive-letter root is used as a file URI not scheme c:
file_reference	"../../../packages/language/test/config.test.ts:file URI root is used directly"	packages/language/test/config.test.ts	config.test.ts:file URI root is used directly
file_reference	"../../../packages/language/test/config.test.ts:multiple importRoots map aliases to different roots"	packages/language/test/config.test.ts	config.test.ts:multiple importRoots map aliases to different roots
file_reference	"../../../packages/language/test/config.test.ts:longest alias wins when mappings overlap"	packages/language/test/config.test.ts	config.test.ts:longest alias wins when mappings overlap
file_reference	"../../../packages/language/test/config.test.ts:empty string alias entries are skipped"	packages/language/test/config.test.ts	config.test.ts:empty string alias entries are skipped
file_reference	"../../../packages/language/test/config.test.ts:empty string root is ignored on a mapping"	packages/language/test/config.test.ts	config.test.ts:empty string root is ignored on a mapping
file_reference	"../../../packages/language/test/config.test.ts:invalid importRoots entries are skipped"	packages/language/test/config.test.ts	config.test.ts:invalid importRoots entries are skipped
file_reference	"../../../packages/language/test/config.test.ts:unknown properties are ignored while known keys still apply"	packages/language/test/config.test.ts	config.test.ts:unknown properties are ignored while known keys still apply
file_reference	"../../../packages/language/test/config.test.ts:invalid JSON falls back to undefined load"	packages/language/test/config.test.ts	config.test.ts:invalid JSON falls back to undefined load
file_reference	"../../../packages/language/test/config.test.ts:non-object JSON falls back to undefined load"	packages/language/test/config.test.ts	config.test.ts:non-object JSON falls back to undefined load
file_reference	"../../../packages/language/test/config.test.ts:non-array importRoots falls back to undefined load"	packages/language/test/config.test.ts	config.test.ts:non-array importRoots falls back to undefined load
file_reference	"../../../packages/language/test/config.test.ts:empty importRoots array uses default alias mapping"	packages/language/test/config.test.ts	config.test.ts:empty importRoots array uses default alias mapping
file_reference	"../../../packages/language/test/config.test.ts:resolveRqConfig falls back to defaults when applying JSON is invalid"	packages/language/test/config.test.ts	config.test.ts:resolveRqConfig falls back to defaults when applying JSON is invalid
file_reference	"../../../packages/language/test/config.test.ts:aliased path uses relative root from applying config"	packages/language/test/config.test.ts	config.test.ts:aliased path uses relative root from applying config
file_reference	"../../../packages/language/test/config.test.ts:aliased path uses workspace folder when root is omitted"	packages/language/test/config.test.ts	config.test.ts:aliased path uses workspace folder when root is omitted
file_reference	"../../../packages/language/test/path-resolve.test.ts:loads importRoots list from nearest base config"	packages/language/test/path-resolve.test.ts	path-resolve.test.ts:loads importRoots list from nearest base config
file_reference	"../../../packages/language/test/path-resolve.test.ts:resolves using config importRoots mapping"	packages/language/test/path-resolve.test.ts	path-resolve.test.ts:resolves using config importRoots mapping
file_reference	"../../../packages/language/test/path-resolve.test.ts:rewrite leaves aliased paths unchanged"	packages/language/test/path-resolve.test.ts	path-resolve.test.ts:rewrite leaves aliased paths unchanged
file_reference	"../../../packages/language/test/path-resolve.test.ts:toDirectoryUri does not parse a drive letter as a URI scheme"	packages/language/test/path-resolve.test.ts	path-resolve.test.ts:toDirectoryUri does not parse a drive letter as a URI scheme
file_reference	"../../../packages/language/test/completion.test.ts:completes import-root alias paths"	packages/language/test/completion.test.ts	completion.test.ts:completes import-root alias paths
file_reference	"../../../packages/language/test/comment-reference-resolution.test.ts:creates a document link for an import-root aliased comment reference"	packages/language/test/comment-reference-resolution.test.ts	["../../../packages/language/test/comment-reference-resolution.test.ts:creates a document link for an import-root aliase
file_reference	"../../../crates/reqlan-index/src/path_resolve.rs:locate_uses_import_roots_from_applying_config"	crates/reqlan-index/src/path_resolve.rs	path_resolve.rs:locate_uses_import_roots_from_applying_config
file_reference	"../../../crates/reqlan-index/tests/broken_references.rs:check_honours_import_roots_from_applying_config"	crates/reqlan-index/tests/broken_references.rs	broken_references.rs:check_honours_import_roots_from_applying_config
file_reference	"../../../crates/reqlan-lsp/tests/parity.rs:import_root_config_file_refs_match_check"	crates/reqlan-lsp/tests/parity.rs	parity.rs:import_root_config_file_refs_match_check
file_reference	"../../../crates/reqlan-parse/src/path.rs:resolves_default_alias_against_workspace_folder"	crates/reqlan-parse/src/path.rs	path.rs:resolves_default_alias_against_workspace_folder
file_reference	"../../../crates/reqlan-index/src/path_resolve.rs:missing_import_roots_uses_default_alias"	crates/reqlan-index/src/path_resolve.rs	path_resolve.rs:missing_import_roots_uses_default_alias
file_reference	"../../../crates/reqlan-index/src/path_resolve.rs:relative_root_resolves_against_base"	crates/reqlan-index/src/path_resolve.rs	path_resolve.rs:relative_root_resolves_against_base
comment_link	configuration_import_roots	reqlan rq/extension/host/crates/reqlan-index/src/path_resolve.rs	//! rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/crates/reqlan-index/tests/broken_references.rs	// rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/crates/reqlan-lsp/tests/parity.rs	/// rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/crates/reqlan-parse/src/path.rs	//! rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/packages/language/src/file-path-rewrite.ts	* rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/packages/language/src/reqlan-completion-provider.ts	* rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/packages/language/src/reqlan-path-resolve.ts	* rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/packages/language/test/completion.test.ts	// rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/packages/language/test/config.test.ts	// rq:configuration_import_roots
comment_link	configuration_import_roots	reqlan rq/extension/host/packages/language/test/path-resolve.test.ts	// rq:configuration_import_roots