Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

roadmap: no --dry-run for the command that rewrites prerequisite edges across the vault

Closed
#309 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

A pull request for this has already been merged.

  • #414 by @Kuldeep2822k — merged

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
70/100
Issue type
Feature
Clarity
Clearly specified
Activity status
Active
Tech stack
nodejs, typescript
Domain
cli

Research direction

Start with the roadmap command's option parsing, which currently accepts only --from, --auto-chain and -y/--yes, and compare it with how adopt already implements --dry-run. The change is to add a flag that computes the per-note plan (IDs, target paths, resolved depends_on, notes to create) and prints it without writing anything. Done means roadmap --from <file> --dry-run exits 0, prints the full plan, and leaves the vault unchanged. Check the shared dry-run convention with #269 before settling the flag's name.

Written by the indexing model from the issue text.

Description

core enhancement priority: medium

Summary

adopt has --dry-run; roadmap does not — despite being the command that authors depends_on across many notes at once.

Repro

palee-test roadmap --from roadmap.yaml --dry-run --yes
[exit 2] error: unknown option '--dry-run'

roadmap --help offers exactly --from, --auto-chain, -y/--yes.

Expected

roadmap --from <file> --dry-run prints the full per-note plan — IDs, target paths, resolved depends_on, and which notes would be created — and writes nothing.

Workaround used during this audit

Copy the vault, import, checksum-diff, restore. That is not something a normal learner should have to invent, and an unscoped copy/restore attempt is exactly how one audit run ended up writing into a different vault (see the config-isolation finding).

Note

#269 already proposes --force/--dry-run for assess on an unmerged branch (fix/269-audit-sweep, d7fe96c). A shared dry-run convention across the write commands would settle both.

Environment
  • palee 0.6.0, local build from main at 02dacd0 (installed as palee-test; reproduce with palee)
  • Node v24.19.0, Windows 11 x64, Git Bash
  • Vault: MIT-licensed Microsoft/OSSU curriculum markdown, 21-187 notes per vault
  • Every command was run for real; exit codes captured by command substitution (never $? after a pipe)
Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
21h 20m
Merged PRs (30d)
176

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Kuldeep2822k/cli

All issues in Kuldeep2822k/cli

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.