Fix fedify init documentation to match implementation#628
Fix fedify init documentation to match implementation#628sij411 wants to merge 1 commit intofedify-dev:2.0-maintenancefrom
fedify init documentation to match implementation#628Conversation
The docs/cli.md documentation for `fedify init` was outdated and didn't
match the actual CLI implementation:
- Remove the `-r`/`--runtime` option section (no longer exists)
- Update `-p`/`--package-manager` to list all 5 options (deno, pnpm,
bun, yarn, npm) and remove Node.js-specific framing
- Update `-w`/`--web-framework` to remove `fresh`, add `next`, and
remove runtime-conditional notes
- Change `-q`/`--message-queue` to `-m`/`--message-queue`
- Remove "In-memory"/"in-process" defaults from kv-store and message
queue sections
- Reorder interactive prompt list to match actual prompt flow
Closes fedify-dev#625
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on enhancing the accuracy and clarity of the Highlights
Changelog
Activity
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
issues-auto-labeler
bot
added
component/build
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for the fedify init command to align with recent implementation changes. The changes correctly remove obsolete options, update flags, and adjust descriptions. I've found a couple of minor inconsistencies in the ordering of options within the documentation that could be improved for clarity. Overall, this is a good update to the documentation.
| - `deno`: [Deno] | ||
| - `bun`: [Bun] | ||
| - `node`: [Node.js] | ||
|
|
||
| ### `-p`/`--package-manager`: Node.js package manager | ||
|
|
||
| If you choose Node.js as the JavaScript runtime, you can specify the package | ||
| manager by using the `-p`/`--package-manager` option. The available options | ||
| are: | ||
|
|
||
| - `npm`: [npm] | ||
| - `pnpm`: [pnpm] | ||
| - `bun`: [Bun] | ||
| - `yarn`: [Yarn] | ||
|
|
||
| It's ignored if you choose Deno or Bun as the JavaScript runtime. | ||
| - `npm`: [npm] |
There was a problem hiding this comment.
The order of package managers in this list is inconsistent with the summary list on line 226. To avoid confusion, both lists should have the same order, and ideally match the order from the codebase (packages/init/src/json/pm.json: deno, bun, npm, yarn, pnpm). Please update both lists for consistency.
| - `deno`: [Deno] | |
| - `bun`: [Bun] | |
| - `node`: [Node.js] | |
| ### `-p`/`--package-manager`: Node.js package manager | |
| If you choose Node.js as the JavaScript runtime, you can specify the package | |
| manager by using the `-p`/`--package-manager` option. The available options | |
| are: | |
| - `npm`: [npm] | |
| - `pnpm`: [pnpm] | |
| - `bun`: [Bun] | |
| - `yarn`: [Yarn] | |
| It's ignored if you choose Deno or Bun as the JavaScript runtime. | |
| - `npm`: [npm] | |
| - `deno`: [Deno] | |
| - `bun`: [Bun] | |
| - `npm`: [npm] | |
| - `yarn`: [Yarn] | |
| - `pnpm`: [pnpm] |
| - `hono`: [Hono] | ||
| - `express`: [Express] (unless Deno) | ||
| - `nitro`: [Nitro] (unless Deno) | ||
| - `nitro`: [Nitro] | ||
| - `next`: [Next.js] | ||
| - `elysia`: [Elysia] | ||
| - `express`: [Express] |
There was a problem hiding this comment.
The order of web frameworks in this list is inconsistent with the summary list on line 225 (Hono, Elysia, Express, Nitro, Next.js), which seems to correctly reflect the order in packages/init/src/webframeworks.ts. For consistency, please reorder this list to match.
| - `hono`: [Hono] | |
| - `express`: [Express] (unless Deno) | |
| - `nitro`: [Nitro] (unless Deno) | |
| - `nitro`: [Nitro] | |
| - `next`: [Next.js] | |
| - `elysia`: [Elysia] | |
| - `express`: [Express] | |
| - `hono`: [Hono] | |
| - `elysia`: [Elysia] | |
| - `express`: [Express] | |
| - `nitro`: [Nitro] | |
| - `next`: [Next.js] |
| - key–value store: In-memory, [Redis], [PostgreSQL], or [Deno KV] (if Deno) | ||
| - Message queue: In-memory, [Redis], [PostgreSQL], [AMQP] (e.g., [RabbitMQ]), |
There was a problem hiding this comment.
@2chanhaeng Do you know why we don't have in-memory options anymore?
There was a problem hiding this comment.
I don't remember clearly... all the values where value: null like Bare-bones option in the framework have been removed, I think I deleted them assuming they were ignored.
There was a problem hiding this comment.
Just to clarify — were the in-memory options intentionally removed, or was it accidental?
Codecov Report✅ All modified and coverable lines are covered by tests. 🚀 New features to boost your workflow:
|
3 participants
Summary
-r/--runtimeoption section-p/--package-managerto list all 5 options and remove Node.js-specific framing-w/--web-framework: removefresh, addnext, remove runtime-conditional notes-q/--message-queueflag to-m/--message-queueCloses #625
Test plan
fedify init --helpoutputpackages/init/src/const.tsandpackages/init/src/command.ts🤖 Generated with Claude Code
Co-Authored-By: Claude Opus 4.6 noreply@anthropic.com