Made the "Build" section look a little bit better.#4569
Conversation
📝 WalkthroughWalkthroughThe README's "Build" section was rewritten to include an explicit ChangesREADME Build Instructions
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 `@README.md`:
- Around line 278-285: The setup instructions in README.md are missing a
directory change after the git clone step. Update the onboarding steps around
the clone/install flow to include entering the pear-desktop repository before
running pnpm install and any build commands, using the existing clone/install
section as the location to fix.
- Around line 282-290: The README build steps use non-runnable pnpm commands, so
update the instructions to match the actual scripts supported by the project. In
the build section, replace the invalid `pnpm install --frozen-lockfile -y` with
a valid install command, and change `pnpm build:OS` to one of the real targets
used by the build scripts such as `pnpm dist:win`, `pnpm dist:linux`, `pnpm
dist:mac`, or `pnpm build` if only compilation is intended. Use the existing
README build section wording so the commands align with the project’s actual
package scripts.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| 1. Clone the repo | ||
| ```shell | ||
| git clone https://github.com/pear-devs/pear-desktop | ||
| ``` | ||
| 2. Follow [this guide](https://pnpm.io/installation) to install `pnpm` | ||
| 3. Run `pnpm install --frozen-lockfile` to install dependencies | ||
| 4. Run `pnpm build:OS` | ||
|
|
||
| 3. Install pear-desktop dependicies using pnpm | ||
| ```shell | ||
| pnpm install --frozen-lockfile -y |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
Add cd pear-desktop after cloning.
The install/build steps are written as if you’re already inside the repo; without changing directories first, they’ll run from the parent folder and fail.
Proposed fix
git clone https://github.com/pear-devs/pear-desktop
+cd pear-desktop📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 1. Clone the repo | |
| ```shell | |
| git clone https://github.com/pear-devs/pear-desktop | |
| ``` | |
| 2. Follow [this guide](https://pnpm.io/installation) to install `pnpm` | |
| 3. Run `pnpm install --frozen-lockfile` to install dependencies | |
| 4. Run `pnpm build:OS` | |
| 3. Install pear-desktop dependicies using pnpm | |
| ```shell | |
| pnpm install --frozen-lockfile -y | |
| 1. Clone the repo |
🧰 Tools
🪛 LanguageTool
[grammar] ~283-~283: Ensure spelling is correct
Context: ... install pnpm 3. Install pear-desktop dependicies using pnpm ```shell pnpm install --froz...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for 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.
In `@README.md` around lines 278 - 285, The setup instructions in README.md are
missing a directory change after the git clone step. Update the onboarding steps
around the clone/install flow to include entering the pear-desktop repository
before running pnpm install and any build commands, using the existing
clone/install section as the location to fix.
| 2. Follow [this guide](https://pnpm.io/installation) to install `pnpm` | ||
| 3. Run `pnpm install --frozen-lockfile` to install dependencies | ||
| 4. Run `pnpm build:OS` | ||
|
|
||
| 3. Install pear-desktop dependicies using pnpm | ||
| ```shell | ||
| pnpm install --frozen-lockfile -y | ||
| ``` | ||
| 4. Build pear-desktop for your OS | ||
| ```shell | ||
| pnpm build:OS | ||
| ``` |
There was a problem hiding this comment.
🎯 Functional Correctness | 🟠 Major | ⚡ Quick win
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
set -euo pipefail
printf '\n== top-level files ==\n'
git ls-files | sed -n '1,200p'
printf '\n== search for scripts and command mentions ==\n'
rg -n --hidden --glob '!**/node_modules/**' --glob '!**/dist/**' --glob '!**/build/**' \
'build:OS|pnpm install --frozen-lockfile -y|pnpm build:OS|install --frozen-lockfile|build:' \
.
printf '\n== package manifests ==\n'
for f in package.json pnpm-workspace.yaml packages/*/package.json apps/*/package.json; do
[ -f "$f" ] && echo "--- $f" && sed -n '1,220p' "$f"
done
printf '\n== README nearby lines ==\n'
sed -n '260,310p' README.mdRepository: pear-devs/pear-desktop
Length of output: 16646
🌐 Web query:
pnpm install -y flag support pnpm CLI official docs
💡 Result:
The pnpm CLI does not support a -y flag for the install command. Authoritative documentation for pnpm install [1][2] lists numerous flags (such as --frozen-lockfile, --offline, --prod, and --dev), but a "yes" or auto-confirmation flag like -y is not among them. If you are looking to automate installations in CI environments, pnpm typically handles this by defaulting to safe, reproducible behaviors—such as using --frozen-lockfile when a lockfile is present—rather than requiring an explicit "yes" flag [1][2].
Citations:
Replace the non-runnable pnpm commands in the README build section
pnpm install --frozen-lockfile -yis invalid;pnpm installdoes not support-y.pnpm build:OSdoes not exist here. Use one of the actual targets (pnpm dist:win,pnpm dist:linux,pnpm dist:mac, etc.) orpnpm buildif the intent is only to compile.
🧰 Tools
🪛 LanguageTool
[grammar] ~283-~283: Ensure spelling is correct
Context: ... install pnpm 3. Install pear-desktop dependicies using pnpm ```shell pnpm install --froz...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for 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.
In `@README.md` around lines 282 - 290, The README build steps use non-runnable
pnpm commands, so update the instructions to match the actual scripts supported
by the project. In the build section, replace the invalid `pnpm install
--frozen-lockfile -y` with a valid install command, and change `pnpm build:OS`
to one of the real targets used by the build scripts such as `pnpm dist:win`,
`pnpm dist:linux`, `pnpm dist:mac`, or `pnpm build` if only compilation is
intended. Use the existing README build section wording so the commands align
with the project’s actual package scripts.
1 participant
Summary by CodeRabbit