refactor(docs): extract site workspace by kjanat · Pull Request #70 · kjanat/dreamcli

kjanat · 2026-07-19T23:21:41Z

Summary

add a private @kjanat/dreamcli-docs workspace with its own scripts, dependencies, and TypeScript config
keep thin root docs:* aliases while removing all docs-only dependencies and the VitePress override from the root manifest
switch docs fixtures to the workspace dependency instead of the root-only #dreamcli import map
replace the remaining global Bun link in examples/pwsh-demo with a relative file dependency so clean Cloudflare installs do not require a pre-linked package
upgrade importmapify to 1.6.0 and replace the executable generator with an auto-discovered config using package mappings and TypeScript-only expansion

Why

The docs toolchain was owned by the published root package, and introducing a package boundary exposed two hidden root assumptions: Vite types in the root TypeScript config and #dreamcli/* imports inherited from the root manifest. Cloudflare installs also failed because one workspace still referenced @kjanat/dreamcli through a global named Bun link that does not exist in a clean build environment.

The docs package now owns its complete toolchain and resolves the library through an explicit relative dependency. Root aliases preserve existing CI and development commands, and the unchanged Cloudflare build command continues to work through workspace resolution.

Closes #39

Generate Deno imports from package metadata so Bun, npm, and JSR do not maintain separate dependency versions. Track the definition schema and satisfy Deno's public documentation checks without weakening types.

coderabbitai · 2026-07-19T23:21:53Z

Important

Review skipped

Auto reviews are limited based on label configuration.

🏷️ Required labels (at least one) (1)

cr:review

🚫 Excluded labels (none allowed) (2)

wip
cr:skip

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Pro

Run ID: 03c3acee-f636-4b19-8026-afaac7229a0e

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

🔍 Trigger review

📝 Walkthrough

Walkthrough

This pull request extracts the documentation site into a workspace package, introduces a complete DreamCLI JSON schema, and centralises import-map resolution. It adds exit-code clearing and exports additional flag-schema types, updates Node.js and package-manager configuration, refreshes CI actions, and adjusts editor and formatter settings. Documentation fixtures and example lint directives are updated to match the new module and tooling configuration.

Estimated code review effort: 4 (Complex) | ~45 minutes

Possibly related issues

KAJ-264 — Extracts the documentation site into a dedicated workspace package and updates the associated root scripts and tooling.

Possibly related PRs

kjanat/dreamcli#9 — Related schema definition, schema export, and import-map changes.
kjanat/dreamcli#12 — Related prompt and flag-schema type exports.
kjanat/dreamcli#37 — Related exit-code state management changes.

Suggested labels: kind: docs

Poem

A schema unfurls across the CLI sea,
Docs find a workspace, tidy as can be.
Import maps chart where modules roam,
Exit codes find a clear way home.
Node and CI sail onward—hoist the flag! 🏴‍☠️

🚥 Pre-merge checks | ✅ 4 | ❌ 7

❌ Failed checks (1 warning, 6 inconclusive)

Check name	Status	Explanation	Resolution
Linked Issues check	⚠️ Warning	For `#39`, the docs package uses `file:..` for `@kjanat/dreamcli`, but the issue requires a `workspace:*` dependency.	Change `docs/package.json` to depend on `@kjanat/dreamcli` via `workspace:*`, then re-run the docs workspace checks.
Release Metadata Sync	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Runtime Support Sync	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
No Generated Docs Artifacts	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Changelog Update	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Semver Version Bump Validation	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.
Agents.Md Documentation Updated	❓ Inconclusive	Repository clone failed, so this custom check could not run with code access.	Retry the review run. If this persists, inspect pre-merge custom-check logs for infrastructure or agent runtime failures.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	Concise, related, and under 50 characters; it uses a valid conventional-commit style refactor prefix.
Description check	✅ Passed	It directly describes the docs workspace extraction, dependency moves, and import map changes in the PR.
Out of Scope Changes check	✅ Passed	No clearly unrelated code changes stand out; the edits all support the docs workspace and tooling extraction.
Docstring Coverage	✅ Passed	Docstring coverage is 75.00% which is sufficient. The required threshold is 30.00%.

_{Comment @coderabbitai help to get the list of available commands.}

socket-security · 2026-07-19T23:22:12Z

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Package	Supply Chain Security	Quality	Maintenance
runner-run@0.19.1 ⏵ 0.20.0	⁺¹		⁺¹
importmapify@1.6.0
vite@8.1.4 ⏵ 8.1.5		⁺¹
tsdown@0.22.8 ⏵ 0.22.9	⁺¹	⁺¹	⁺¹
wrangler@4.111.0 ⏵ 4.112.0		⁺¹⁷

View full report

pkg-pr-new · 2026-07-19T23:22:39Z

Open in StackBlitz

bun add https://pkg.pr.new/@kjanat/dreamcli@70

npm i https://pkg.pr.new/@kjanat/dreamcli@70

commit: bcf0d50

cloudflare-workers-and-pages · 2026-07-19T23:23:32Z

Deploying with Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status	Name	Latest Commit	Preview URL	Updated (UTC)
✅ Deployment successful! View logs	dreamcli	`0d38e87`	Commit Preview URL	Jul 19 2026, 11:56 PM

Use config discovery, package mappings, and extension filtering so the Deno import map stays derived from package metadata without including non-TypeScript internals.

Declare Vitest through the shared catalog for docs typing and disable setup-node's implicit npm cache in the publish job.

kjanat and others added 4 commits July 17, 2026 18:15

refactor(docs): extract site workspace

e57ead8

[autofix.ci] apply automated fixes

fc202d4

fix(test): resolve workspace source paths

2511d0e

chore: unify package metadata across runtimes

2512297

Generate Deno imports from package metadata so Bun, npm, and JSR do not maintain separate dependency versions. Track the definition schema and satisfy Deno's public documentation checks without weakening types.

kjanat linked an issue Jul 19, 2026 that may be closed by this pull request

Extract docs site into its own workspace package (docs/package.json) #39

Closed

kjanat mentioned this pull request Jul 19, 2026

refactor(docs): extract site workspace #62

Closed

kjanat self-assigned this Jul 19, 2026

chore: adopt importmapify 1.6 features

bcf0d50

Use config discovery, package mappings, and extension filtering so the Deno import map stays derived from package metadata without including non-TypeScript internals.

kjanat added area: docs VitePress app, guides, reference pages, and docs UX area: build Build, CI, release automation, scripts, and packaging refactor labels Jul 19, 2026

kjanat marked this pull request as ready for review July 19, 2026 23:41

coderabbitai Bot added the kind: docs Docs, guides, examples, or reference content label Jul 19, 2026

This comment was marked as resolved.

Sign in to view

kjanat removed the cr:review Allow CodeRabbit review label Jul 19, 2026

fix(ci): isolate docs and publish dependencies

0d38e87

Declare Vitest through the shared catalog for docs typing and disable setup-node's implicit npm cache in the publish job.

kjanat merged commit bb7580a into master Jul 19, 2026
8 of 10 checks passed

kjanat deleted the 39-extract-docs-site branch July 19, 2026 23:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(docs): extract site workspace#70

refactor(docs): extract site workspace#70
kjanat merged 6 commits into
masterfrom
39-extract-docs-site

kjanat commented Jul 19, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading

Review skipped

Walkthrough

❌ Failed checks (1 warning, 6 inconclusive)

Uh oh!

socket-security Bot commented Jul 19, 2026 •

edited

Loading

Uh oh!

pkg-pr-new Bot commented Jul 19, 2026 •

edited

Loading

Uh oh!

cloudflare-workers-and-pages Bot commented Jul 19, 2026 •

edited

Loading

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

kjanat commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Why

Uh oh!

coderabbitai Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

❌ Failed checks (1 warning, 6 inconclusive)

Uh oh!

socket-security Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pkg-pr-new Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

cloudflare-workers-and-pages Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying with Cloudflare Workers

Uh oh!

This comment was marked as resolved.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

kjanat commented Jul 19, 2026 •

edited

Loading

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading

socket-security Bot commented Jul 19, 2026 •

edited

Loading

pkg-pr-new Bot commented Jul 19, 2026 •

edited

Loading

cloudflare-workers-and-pages Bot commented Jul 19, 2026 •

edited

Loading