Docs: add deno install instructions#1079
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds a Deno subsection to Package Managers in installation docs, noting possible ChangesDeno Installation Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/installation.md`:
- Around line 29-30: Rewrite the sentence to improve grammar and clarify the
logic: change "change `@latest` tag with" to "replace the `@latest` tag with", add
"the" before "@latest tag", and make the flow explicit by stating that if Deno
has trouble resolving `@latest` you should instead specify a concrete version (for
example replace the `@latest` tag with a version specifier like @^1.3.1). Ensure
the resulting sentence reads smoothly and unambiguously explains when and how to
use a pinned version.
- Around line 32-36: Replace the overly permissive Deno install commands that
use --allow-all with the minimal required permissions; update the bash snippets
that install npm:`@fission-ai/openspec` (both the `@latest` and @^1.3.1 variants) to
use --allow-read --allow-write --allow-env --allow-net instead of --allow-all so
the installation lines reflect only the actual permissions OpenSpec needs.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 484f8d20-e2f2-4530-838a-c3e8dd8e98be
📒 Files selected for processing (1)
docs/installation.md
alfred-openspec
left a comment
There was a problem hiding this comment.
Thanks for adding this. I smoke-tested the Deno path with Deno 2.7.14 in an isolated temp cache. The npm:@fission-ai/openspec@latest and @^1.3.1 specifiers parse and basic OpenSpec commands can run under Deno's Node/npm compatibility, but we should not document --allow-all.
Please switch this to a narrower set, and include --allow-sys=cpus,homedir as well. Without --allow-sys=cpus, even openspec --version fails via fast-glob/os.cpus(), and without homedir, openspec init --tools none fails through config path resolution. A safer default command would be:
deno install --global \
--allow-read --allow-write --allow-env --allow-sys=cpus,homedir --allow-net=edge.openspec.dev \
npm:@fission-ai/openspec@latestI'd also add a short note that subcommands which launch external tools, like config edit, feedback, or workspace open, may need a scoped --allow-run=<program> if users rely on them.
|
Thanks for the feedback @alfred-openspec . I considered settings scope one by one, but deno runs the apps sandboxed as default, and since node and bun etc. does not this anyways, and the possibility of future new permissions made me consider adding I've updated due your feedback, and updated my pull request. |
This PR introduces deno install instructions for OpenSpec.
I've tried already and I've been using without issues.
I've also added a small notice for @latest tag parsing.
Thanks!
Summary by CodeRabbit