spec - comment_reference_resolution_error

Katz0.151

Summary

If a comment reference cannot be resolved, show it as an error diagnostic.
Do not create a document link to a missing file ( that underline then raises a generic cannot-find-file editor error ).
Related: comment_reference, comment_reference_ignore, comment_reference, references_in_functional_code_comments.

Jump to outbound references

Jump to inbound references

Navigation

Source file

reqlan rq/language/syntax.rq

community 1

community cluster

syntax.rq

file cluster

reqlan rq/language

folder cluster

status: done

status cluster

tag: Not present

tag cluster

Printable page

Static print-friendly idea sheet.

Attributes

Key	Value
implementation	reqlan-comment-diagnostics.ts, register-comment-reference-links.ts
status	done
tests	comment-reference-resolution.test.ts, comment-reference-resolution.test.ts:reports an error when a comment reference file does not exist, comment-reference-resolution.test.ts:does not create a document link for a missing comment reference file, comment-reference-resolution.test.ts:creates a document link when the comment reference file and idea exist, comment-reference-resolution.test.ts:reports an error when the comment reference idea is missing from the file, rq-ignore-error, comment-reference-resolution.test.ts:reports a missing comment reference file in a loaded document, comment-reference-resolution.test.ts:reports a missing comment reference idea in a loaded file, comment-reference-resolution.test.ts:accepts a resolved comment reference in a loaded document

Browse all attributes

Ancestor context

No ancestor chain recorded.

Outbound references

Kind	Idea	Path	Snippet
references	comment_reference	reqlan rq/language/syntax.rq	comment_reference
references	comment_reference_ignore	reqlan rq/language/syntax.rq	comment_reference_ignore
references	comment_reference	reqlan rq/reference_types.rq	comment_reference
references	references_in_functional_code_comments	reqlan rq/extension/language/comment-references/functional-code-comment-references.rq	["../extension/language/comment-references/functional-code-comment-references.rq".references_in_functional_code_comments
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/register-comment-reference-links.ts"	packages/extension/src/extension/register-comment-reference-links.ts	register-comment-reference-links.ts
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts"	packages/language/test/comment-reference-resolution.test.ts	comment-reference-resolution.test.ts
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:reports an error when a comment reference file does not exist"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:reports an error when a comment reference file does
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:does not create a document link for a missing comment reference file"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:does not create a document link for a missing commen
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:creates a document link when the comment reference file and idea exist"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:creates a document link when the comment reference f
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:reports an error when the comment reference idea is missing from the file"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:reports an error when the comment reference idea is
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:suppresses comment reference errors on the line after //rq-ignore-error"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:suppresses comment reference errors on the line afte
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:reports a missing comment reference file in a loaded document"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:reports a missing comment reference file in a loaded
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:reports a missing comment reference idea in a loaded file"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:reports a missing comment reference idea in a loaded
file_reference	"../../packages/language/test/comment-reference-resolution.test.ts:accepts a resolved comment reference in a loaded document"	packages/language/test/comment-reference-resolution.test.ts	["../../packages/language/test/comment-reference-resolution.test.ts:accepts a resolved comment reference in a loaded doc
comment_link	comment_reference_resolution_error	reqlan rq/language/packages/extension/src/extension/register-comment-reference-links.ts	* rq:comment_reference_resolution_error
comment_link	comment_reference_resolution_error	reqlan rq/language/packages/language/src/reqlan-comment-diagnostics.ts	* rq:comment_reference_resolution_error
comment_link	comment_reference_resolution_error	reqlan rq/language/packages/language/src/reqlan-comment-resolver.ts	* rq:comment_reference_resolution_error
comment_link	comment_reference_resolution_error	reqlan rq/language/packages/language/src/reqlan-validator.ts	* rq:comment_reference_resolution_error
comment_link	comment_reference_resolution_error	reqlan rq/language/packages/language/test/comment-reference-resolution.test.ts	// rq:comment_reference_resolution_error

Inbound references

Kind	Idea	Path	Snippet
references	test_references	reqlan rq/core_analysis/core.rq	comment_reference_resolution_error
references	comment_reference_resolution_error_state	reqlan rq/extension/language/comment-references/functional-code-comment-references.rq	comment_reference_resolution_error
references	file_reference_errors	reqlan rq/extension/language/support/language-server-errors.rq	comment_reference_resolution_error
references	comment_reference	reqlan rq/language/syntax.rq	comment_reference_resolution_error
references	comment_reference	reqlan rq/reference_types.rq	comment_reference_resolution_error

Unresolved references

Kind	Idea	Path	Snippet
None

Local graph

Initialising graph…