reqlanOverviewIdeasFilesCode filesClustersAttributesGraphPrint

Printable report

spec

Generated 2026-10-13T21:17:45.000Z

933 ideas

Ideas933
References8578
Files92
Clusters213

Status rollup

Not present
475
done
399
draft
7
in-progress
19
incomplete
29
partial
1
pending
2
todo
1

windows_esm_entry

reqlan rq/cli/cli_package.rq

Node's ESM loader on Windows requires `file://` URLs for absolute dynamic `import()`.
A native path such as `C:\...\out\main.js` is read as protocol `c:` and crashes every command, including `init`.
`bin/cli.js` converts the compiled entry with `fsPathToEsmSpecifier` ( `pathToFileURL` ).
The MCP stdio entry mcp.js uses the same `pathToFileURL` conversion.

implementation
cli.js, esm-path.ts, mcp.js
status
done
tests
windows-esm-entry.test.ts:does not treat a Windows drive letter as a URL scheme, windows-esm-entry.test.ts:CLI bin loads the compiled entry via an ESM file URL helper, windows-esm-entry.test.ts:MCP bin converts the compiled entry with pathToFileURL

html_export_graph_page

reqlan rq/core_analysis/html_export.rq

Html export should provide an interactive graph page with search, filters, and links back into idea and cluster pages.
The graph should support scoped views for workspace, file, cluster, and idea contexts.
The workspace graph page must include every idea in the export scope — blocks, oneliners, and ideasets — and must not apply the interactive Ideas Summary GRAPH_MAX_NODES budget.
Ideasets are visible by default with a Hide ideasets / Show ideasets toggle, matching the external-file visibility control
( explicit AST ideasets only — distinct from hosting-file treatment ).
Hosting `.rq` files ( implicit ideasets ) use a Files `<select>` — hidden / compound / linked —
with option tooltips, per file_treatment_toggle
( parity with Ideas Summary ). Compound mode draws hittable / draggable bounding boxes with clickable titles;
linked mode adds synthetic ideaset nodes that navigate via `hostFilePageUrl` / `pageUrl`.
Wildcard fan-out edges ( `wildcard_reference` ) are visible by default with a " Wildcard refs " chip
( same label / default as Ideas Summary ); turning it off client-filters those edges and draws them dotted when on —
see wildcard_refs_toggle and
webview_export_graph_parity.
Status and tag filters are multi-select and distinguish graph_status_tag_filters.
Per-idea, per-file, and per-cluster neighbourhood graphs may still use a capped budget for focused pages.
html_export_graph_links
html_export_graph_layout
html_export_graph_animation
html_export_graph_background_load
html_export_graph_subject
html_export_graph_labels
html_export_graph_label_modes
html_export_graph_label_auto
html_export_graph_interaction
html_export_graph_metadata

implementation
snapshot.rs, mod.rs, app.js, api.rs
tests
html_export.rs:html_export_writes_ts_page_template_set_and_embeds_assets, html_export.rs:workspace_graph_includes_every_idea_when_max_graph_nodes_is_below_count, html_export.rs:html_export_workspace_graph_includes_wildcard_refs_chip_and_edges, export.rs:html_export_honours_graph_page_url_base_and_header_link

html_export_print_body_whitespace

reqlan rq/core_analysis/html_export.rq

The printable report must show the idea body text that the parser stores.
Each per-idea printable sheet must show the stored idea body text.
The parser removes the base indent.
The base indent is the indent of the first body line.
Extra indent on a later line is part of the body text.
A later line with 4 more spaces than the first body line is stored with those 4 spaces.
Print HTML must keep those leading spaces.
Print HTML must not collapse those spaces.
The body text must still wrap inside the card width.
Cross-refs html_export_printable_pages, html_export_print_idea_cards.

implementation
mod.rs, styles.css
status
done
tests
html_export.rs:print_pages_keep_relative_body_indent

html_export_print_in_page_anchors

reqlan rq/core_analysis/html_export.rq

On the printable report page, each idea card has a stable html `id` derived from the idea identity.
Cross-idea links rendered on that page ( title links and inline idea refs in summaries / attributes ) must resolve to same-page `#` fragment urls targeting those ids, not separate idea detail pages.
When browsed with the sticky site topbar, fragment navigation must leave the target card fully visible below the header ( scroll padding / scroll-margin ), not clipped behind it.
Aligns with stable in-page anchors in html_export_internal_links.
Cross-refs html_export_printable_pages, html_export_print_idea_cards.

implementation
mod.rs, html_utils.rs, styles.css
status
done
tests
html_export.rs:html_export_writes_ts_page_template_set_and_embeds_assets

format_page

reqlan rq/extension/host/features-commands.rq

- set the whitespace etc appropriate for the page.

ideating
true
todo
true

barrel_page

reqlan rq/extension/host/features-commands.rq

When a `.rq` page grows large, barrel it into a container: create one sibling file per top-level idea, import those files into the current page, and replace the page body with a single container idea whose name the user chooses ( default: the sanitized file basename ).
Same-file sibling refs are rewritten to qualified imports in the child files. Existing page imports are copied into each child. Top-level ideasets are preserved in the container file.
Behaviour lives in analytical_package and is exposed via cli / commands ( `reqlan barrel` ).
Extension: file-level source code action **Barrel page into container … ** and command palette **Barrel Page** ( `reqlan.barrelPage` ) prompt for the container name, confirm, then create child files and rewrite the active page via WorkspaceEdit.
Related: file_based_code_actions decompose

implementation
barrel-page.ts, barrel.ts, main.ts, reqlan-code-action-provider.ts, code_actions.rs, register-barrel-page-command.ts, barrel-page-apply.ts, package.json
status
done
tests
barrel-page.test.ts:creates one child file per idea and a container defaulting to file basename, barrel-page.test.ts:writes child files and replaces the source with a container, code-actions.test.ts:offers barrel page source action when the file has top-level ideas, code-actions.test.ts:omits barrel page when only quickfix is requested or there are no ideas, code_actions.rs:offers_barrel_page_source_action_when_the_file_has_top_level_ideas, code_actions.rs:omits_barrel_page_when_only_quickfix_is_requested_or_there_are_no_ideas, barrel-page-apply.test.ts:maps child file names next to the source path, barrel-page-apply.test.ts:detects overwrite conflicts and source-self collision

installation_event

reqlan rq/extension/host/onboarding/page-thanks-for-installing.rq

On installation of the extension a webview should be opened showing:
- A welcome message
- Resolved links to site, github, docs etc. ( not template placeholders )
- A syntax-highlighted example `.rq` with real URLs ( clickable ) from thanks-for-installing.template.rq after placeholder substitution
- A control to open that example as an untitled `.rq` editor beside the webview
- Short tips for the activity bar and `@reqlan` chat
- A thanks to sponsors
Place in overall install sequencing: welcome_webview_install / extension_installation.
Implemented as a Svelte webview under onboarding bundled to onboarding and opened once on first activation by open-thanks-for-installing.ts via onboarding-panel.ts.
Resource links and template values are resolved at runtime from phonebook through phonebook.ts and posted to the webview; the example block imports thanks-for-installing.template.rq via Vite `?raw` and substitutes `{{…}}` placeholders before display.
Highlighting uses the onboarding tokenizer in rq-highlight.ts.
The source template still uses placeholders such as { { SITE_URL } }; those matching braces are body prose per nested_curly_braces and must parse without errors.
Activation state is stored in extension global state key `onboarding` with `onboardingMessageShown` and `lastVersion` per onboarding-state.ts.
VS Code persists `globalState` in the extension global storage directory ( `globalStorage/reqlan.reqlan-extension/state.vscdb` under the editor user data folder ).

status
done
tests
parsing.test.ts:parse thanks-for-installing template, onboarding-rq-highlight.test.ts

onboarding_state

reqlan rq/extension/host/onboarding/page-thanks-for-installing.rq

Onboarding persistence uses VS Code `ExtensionContext.globalState` under key `onboarding` in onboarding-state.ts.
Fields: `onboardingMessageShown`, `lastVersion`.

installation_event_trigger

reqlan rq/extension/host/onboarding/page-thanks-for-installing.rq

The installation event should be checked and triggered at extension activation.
Verified: main.ts schedules `openThanksForInstallingIfNeeded` after the activity-bar paint gate or 400 ms ( not in the same tick as sidebar claim ), and onboarding_check documents the gating behaviour.

status
done

text_prefix_skip

reqlan rq/extension/index-host/index.rq

Before any index content read, inspect at most the first 8 KiB.
Skip the file when that prefix has a NUL, a UTF-16 BOM ( `FF FE` or `FE FF` ), or invalid UTF-8.
A trailing incomplete UTF-8 code unit is not a skip: the rest of the file may finish the character.
Skip when the file is larger than 1 MiB.
A rejected prefix is not followed by a read of the remainder.
`.rq` files and allowlisted code files use the same check.
This is in addition to binary_ignore extension globs.

implementation
text.rs, sync.rs
status
done
tests
text.rs:nul_rejects, text.rs:utf16_bom_rejects, text.rs:invalid_utf8_rejects, text.rs:trailing_incomplete_utf8_is_not_a_reject, scan.rs:prefix_skip_does_not_index_non_text

idea_content_tooltip

reqlan rq/extension/language/syntax/features-syntax.rq

A hover on an idea name or on a reference shows that idea's content.
The tooltip is markdown. It uses a heading, body lines, attributes, lists, and code fences.
A reference in another file shows that file's idea content.
The setting `reqlan.ideaContentTooltip.enabled` controls this hover.
The default is on.
When the setting is off, the hover shows the idea name and the one-line summary.
Related: syntax_hovering language_server_rust

implementation
hover_content.rs, analysis.rs, session.rs, server.rs, idea-content-tooltip.ts, main.ts, package.json
status
done
tests
hover_content.rs:hover_shows_styled_idea_content_by_default, hover_content.rs:hover_omits_idea_content_when_the_setting_is_off, hover_content.rs:hover_shows_idea_content_from_another_file, idea-content-tooltip.test.ts:package.json enables idea content tooltips by default, idea-content-tooltip.test.ts:a missing value stays on

at_sign_in_idea_text_block

reqlan rq/extension/language/syntax/features-syntax.rq

the @ symbol should only indicate an attribute if at the start of a line.
it should be escapeable with a backslash ( although any character would work as the @ would no longer be at the start of the line )
so @ this_is_not_an_attribute

tests
parsing.test.ts, parsing.test.ts
this_is_an_attribute
true

panel_content_styling

reqlan rq/extension/local-context/activitybar.rq

Pane bodies must not grow unbounded. Nested lists use NestedSection.svelte ( collapse + scroll ) under CollapsiblePane.svelte.
Shell resize / fill / scroll behaviour: activity_bar_styling.
Details: workspace_content_styling, context_content_styling.
WorkspacePane.svelte ScopePane.svelte ReferenceListsPane.svelte

status
done
tests
group-file-issues.test.ts, NestedSection.svelte, WorkspacePane.svelte, ScopePane.svelte, ReferenceListsPane.svelte

ide_page_reports

reqlan rq/extension/workspace-summary/ideas_summary/webview.rq

Ideas Summary provides dedicated report pages inside the IDE ( graph page and status table at minimum ).
Report pages may render computed information that is not present as literal text in source files.

overview_page

reqlan rq/extension/workspace-summary/ideas_summary/webview.rq

First tab: a workspace overview for the active base — product-facing copy ( not index / debug jargon ).
- At a glance: idea count, reference count, issues, bases, and a friendly readiness status.
- Coverage: collapsible overview_coverage_scores ( lazy, non-blocking ).
- Search: live cross-surface search over ideas, ideasets, attributes, and references for the active base;
results group by surface with sample hits and actions to open the matching tab with the query applied ( overview_search ).
- Export: buttons that open export_webview with HTML, Markdown, JSON, CSV, or PDF pre-selected ( or the form without a format override ).
- Links: project site, support / email, GitHub.
- Recent index / analyse activity preview ( idea names when available ) with a link to timeline_page
for idea git history — this preview is not a git surface.

implementation
OverviewPanel.svelte, ideas-summary-panel.ts
todo
deep links into HTML export pages when an export exists

timeline_page

reqlan rq/extension/workspace-summary/ideas_summary/webview.rq

Timeline tab shows the evolution of ideas for the active base — not raw file-index noise.
Sources:
- Git idea lifecycle from indexed `git_created_at` / `git_modified_at` ( created + last edited as separate events when they differ )
- Session idea reindex activity ( one event per idea persisted, with name / status / summary when available )
Missing git dates are filled by the silent background indexer
( git_dates / git_dates_background_indexing ) —
opening Timeline must not run git log on the UI path.
Reindex must preserve existing git dates across upsert.
Entries are reverse-chronological, filterable by source ( git / reindexed ), and clickable to open the idea.
Each event surfaces idea-centric info: name, short summary, status, kind / tags, and path.
Full live multi-commit git log browsing remains out of scope; this surfaces indexed idea history first.

implementation
TimelinePanel.svelte, ideas-summary-panel.ts, sqlite-store.ts, git_dates.rs, register-git-dates-background.ts, git-dates-background.ts
status
done
tags
timeline, ideas, git
tests
idea-timeline.test.ts, idea-timeline.test.ts:listIdeaIdsMissingGitDates can filter or prefer a file, git-dates-background.test.ts, git-dates-background.test.ts:processes active-file priority ids before the global backlog

_file

reqlan rq/ingest/ingest.rq

- This file is used for preingestion of ideas into the graph
- It is for ideas that are being drafted, haven't been placed, haven't been linked or represent a significant superseding descructive change to the graph
- i. e. requiring careful integration to leave no trace of deprecated ideas, leave no duplication and leave no conflicts
- ingestion must pass validation via `pnpm run val` ( pnpm_val: check, test, build )
- ingestion requires reqiurement integration into the graph, followed by actual implementation if requested.

naked_strings_in_body

reqlan rq/language/syntax.rq

Quoted text in idea bodies, attribute values, and list items is plain prose, not a string literal.
Quote characters are preserved in the body text. For example, " Fit to view " in a bullet line is body text.
String literals are reserved for import paths, top-level quoted idea names, and quoted paths inside bracket references.
Quoted path-like body text is not a file_reference: reference_edgecase.

tests
parsing.test.ts:keeps naked quoted phrases in block body text, parsing.test.ts:keeps naked quoted phrases in attribute scalar values, parsing.test.ts:keeps single-quoted naked phrases in block body text, parsing.test.ts:keeps naked quoted phrases in one-liner body after the idea name, parsing.test.ts:keeps naked quoted phrases in list items, parsing.test.ts:keeps naked quotes alongside bracket references on one line, parsing.test.ts:does not treat naked quoted path-like prose as an import reference, parsing.test.ts:does not parse unbracketed quoted paths as file references, parsing.test.ts:parses reframe requirement snippets with naked quoted UI labels, parsing.test.ts:parses self-contained ideas with apostrophe contractions in body prose, naked-strings.test.ts, comment-in-string.test.ts:single-quoted URL in block body is naked prose, lexer.rs:unbracketed_quoted_path_in_body_is_not_string, parser.rs:unbracketed_quoted_path_is_not_a_file_reference

attribute_body

reqlan rq/ontology.rq

The first attribute in an idea, if not marked otherwise, is the main body attribute. It is unstructured text.
Syntax: block_idea; extract summary from that body: extract.rs, rust_extract.

implementation
reqlan.langium, extract.rs, rust_extract
status
done
tests
extract_parity.rs:block_idea_body_populates_summary_from_rich_text_parts, extract_parity.rs:block_idea_body_populates_summary_from_rich_text_parts, extract_parity.rs:one_liner_idea_body_populates_summary

assessment_page

reqlan rq/site/certs.rq

`/certs/assessment/` shows the sole assessment quiz when there is one.
When there is more than one assessment, it lists them.
`/certs/assessment/id/` is that assessment's quiz.
Unknown ids are not found.
Legacy `/assessment/` and `/tutorials/assessment/` redirect here and keep the query string.
The home quiz_sticker_tab links here. It does not run the quiz in the tab.

implementation
page.tsx, ["../../site/src/app/certs/assessment/id/page.tsx"], page.tsx, page.tsx, AssessmentPage.tsx, AssessmentListPage.tsx, assessment.ts, certs-paths.ts
status
done
tests
assessment.test.ts, certs-paths.test.ts

certificate_page

reqlan rq/site/certs.rq

`/certs/certificate/` shows a minted certificate.
Token query param `c` holds the packed claims, including assessment id `a`.
Query param `just=1` marks the just-completed view:
- show the certificate
- show a shareable link that omits `just`
- embed the sticker form per sticker_form_embed
Without `just`, the page is the shareable certificate only. Do not embed the form.
Invalid or missing tokens send the user back to assessment_page.
The completion line on a valid certificate names the certificate_page and links to that quiz.
Legacy `/tutorials/certificate/` redirects here and keeps the query string.

implementation
page.tsx, page.tsx, CertificatePage.tsx, certs-paths.ts, certificate-token.ts, assessment.ts
status
done
tests
certs-paths.test.ts, certificate-token.test.ts

faq_page

reqlan rq/site/site.rq

The site exposes `/faq/` as a statically generated page answering a short set of common questions.
Copy lives in faq.ts and stays minimal per copy. Support answers point at support_page and at phonebook surfaces ( GitHub stars, marketplace stars, issues / contribution, GitHub Sponsors, Discord ) rather than inventing URLs.
Required topics:
- how reqlan supports token efficiency
- whether reqlan is the de facto standard for efficient developer-centric context management and semantic mapping
- when to use reqlan
- how `.rq` files stay in sync with code per faq_drift
- how to support reqlan ( GitHub stars, GitHub Sponsors, VS Marketplace stars, Discord, contribution, bug reporting )
Sidebar nests FAQ question anchors as same-page children per sidebar_nav.
Landing nav graph includes FAQ as a page node.

implementation
page.tsx, FaqPage.tsx, faq.module.css, faq.ts, nav.ts, Sidebar.tsx, NavGraph.tsx
status
done
tests
faq.test.ts

quickstart_page

reqlan rq/site/site.rq

The site exposes `/quickstart/` as the install / get-started page.
Primary path: editor install chooser.
Also explains headless cli_package ( `@reqlan/cli` ) and mcp_package ( `@reqlan/mcp` ) on the same `.reqlan` index.
Package npm hrefs come from npm_packages, not hardcoded URLs.
CLI and MCP install commands offer npm, pnpm, yarn, and bun per install_cli_menu.
They share one stored preference per package_manager_preference.
After install steps, it links onward to Tutorials, Showcases, and FAQ so visitors can continue without returning to the home nav.
Related link copy lives in quickstart.ts per copy.
Sidebar nests Extension / CLI / MCP as same-page children per sidebar_nav.

implementation
page.tsx, QuickstartPage.tsx, QuickstartClient.tsx, QuickstartClient.module.css, quickstart.ts, nav.ts
status
done
tests
install-actions.test.ts

one_worked_example_per_page

reqlan rq/site/site.rq

Consistent identifiers across every block on a page.
The reader should trace one name from requirement to source to test to
search result without re-orienting.

story_codebase_showcase

reqlan rq/site/site.rq

Flagship. A story that ships with the code.
Write the feature as one idea. Bind source with @ implementation.
Bind proof with @ tests. Point back with rq: comments.
Click on that name returns the bound files — not a ticket outside the repo.
Domain: product delivery.
One worked name across every block per one_worked_example_per_page.
Payoff is click output per every_showcase_ends_in_a_payoff
and click.
Uses code_comment_references and testing.
Demonstrates sub_file_binding and bidirectional_comment_links.

domain
product-delivery
implementation
story-codebase.ts, index.ts
mechanism
implementation_attribute, tests_attribute, comment_links, click
status
done
tags
story, traceability, delivery
tests
showcases.test.ts:story-codebase binds a story to source and tests, showcases.test.ts:gives each showcase its own file with rq comment references, validate-showcase-rq.mts
tier
flagship

support_page

reqlan rq/site/support-page.rq

Rank actions by ease and likelihood to nudge. Star on GitHub is first.
Default view is a graph. Toggle Graph / Tiles / Table as icon buttons on the right of the header, with hover tooltips.
Graph: cola layout, settled on first paint to the visible window; copy has no graph coordinates; each node moves with its label; nodes are draggable; a drop keeps the new position; a drag does not start the action; all nodes offset slightly toward the cursor; nodes repel so some canvas edges stay open; action radius is impact × ease and stays latent to users; action nodes are solid and flat; each action links to a smaller passive original-group node in secondary colour ( advocacy, community, cite, contribute, sponsor ); group labels grow on group hover; labels do not overlap.
Hover on an action node shows a tooltip with the action blurb.
Star and sponsor tags are featured in the orange brand colour: the Star action, sponsor actions, and the Sponsor group.
Tiles: responsive flex layout.
Table: action and group only. Ease, impact, and score stay latent.
Action names use the aqua link colour in Graph, Tiles, and Table, including copy and share, except featured graph tags.
Each table row runs the same action as the graph and tiles: open a link, copy, or share.
Support via, in tile order:
- one click
- star on github
- share
- discord
- a minute
- cite
- issues
- post your certificate
- say something nice on the Visual Studio Marketplace
- say something nice on Open VSX
- FREE stickers: show the world you are a reqling, via phonebook sticker-form
- write
- reach out and send an email
- write a testimonial
- sponsor
- github sponsorship
- direct sponsorship
integrated with phonebook.
Copy lives in support.ts per copy.
The site exposes `/support/` as a statically generated page.
Sidebar nests Support section anchors as same-page children per sidebar_nav.
Landing nav graph includes Support as a page node per nav_graph.

implementation
page.tsx, SupportPage.tsx, SupportGraph.tsx, SupportTable.tsx, support.module.css, support.ts, support-action.ts, support-graph-cola.ts, nav.ts
status
done
tests
support.test.ts, support-graph-cola.test.ts