[PR #5440] [MERGED] docs(cli): add workspace dependency build requirements to README #5210

New issue

Closed

opened 2026-03-17 02:40:40 +03:00 by kerem · 0 comments

kerem commented

2026-03-17 02:40:40 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/hoppscotch/hoppscotch/pull/5440
Author: @iw4p
Created: 10/3/2025
Status: ✅ Merged
Merged: 11/26/2025
Merged by: @jamesgeorge007

Base: next ← Head: patch-1

📝 Commits (2)

ad54e50 docs: add workspace dependencies build steps to CLI README
440d779 docs(cli): clarify workspace dependency build requirements

📊 Changes

1 file changed (+18 additions, -5 deletions)

View changed files

📝 packages/hoppscotch-cli/README.md (+18 -5)

📄 Description

Add instructions to build @hoppscotch/data and @hoppscotch/js-sandbox packages before building the CLI to resolve dependency resolution issues.

The CLI depends on these workspace packages, which need to be built locally before the CLI can be compiled successfully.

What's changed

Updated "Developing" section in CLI README with workspace dependencies build steps
Updated "Set Up The Development Environment" section with the same build instructions
Added explanatory comments about postinstall hooks and when manual rebuilds are needed
Clarified that manual rebuilds are primarily needed when making changes to dependency packages
Fixed working directory context for CLI build command in "Set Up The Development Environment" section
Maintained proper step numbering after adding new build steps

Notes to reviewers

This is a documentation-only change that adds missing build instructions for workspace dependencies. I tried to use CLI on my machine, and the CLI build was failing because it depends on @hoppscotch/data and @hoppscotch/js-sandbox packages that need to be built locally before the CLI can be compiled.

The documentation now clarifies that:

These packages auto-build via postinstall hooks during pnpm install
Manual builds are primarily needed when making changes to these packages during development
The CLI build command must be run from the packages/hoppscotch-cli directory

The changes are minimal and focused - only adding the necessary build commands with clear comments explaining the order of operations and when rebuilds are needed.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/hoppscotch/hoppscotch/pull/5440 **Author:** [@iw4p](https://github.com/iw4p) **Created:** 10/3/2025 **Status:** ✅ Merged **Merged:** 11/26/2025 **Merged by:** [@jamesgeorge007](https://github.com/jamesgeorge007) **Base:** `next` ← **Head:** `patch-1` --- ### 📝 Commits (2) - [`ad54e50`](https://github.com/hoppscotch/hoppscotch/commit/ad54e50b0dc49c69fd66077bb51a097e114d11b8) docs: add workspace dependencies build steps to CLI README - [`440d779`](https://github.com/hoppscotch/hoppscotch/commit/440d779689f3612fe6984099b21f75a71bbef18f) docs(cli): clarify workspace dependency build requirements ### 📊 Changes **1 file changed** (+18 additions, -5 deletions) <details> <summary>View changed files</summary> 📝 `packages/hoppscotch-cli/README.md` (+18 -5) </details> ### 📄 Description Add instructions to build `@hoppscotch/data` and `@hoppscotch/js-sandbox` packages before building the CLI to resolve dependency resolution issues. The CLI depends on these workspace packages, which need to be built locally before the CLI can be compiled successfully. ### What's changed - [x] Updated "Developing" section in CLI README with workspace dependencies build steps - [x] Updated "Set Up The Development Environment" section with the same build instructions - [x] Added explanatory comments about postinstall hooks and when manual rebuilds are needed - [x] Clarified that manual rebuilds are primarily needed when making changes to dependency packages - [x] Fixed working directory context for CLI build command in "Set Up The Development Environment" section - [x] Maintained proper step numbering after adding new build steps ### Notes to reviewers This is a documentation-only change that adds missing build instructions for workspace dependencies. I tried to use CLI on my machine, and the CLI build was failing because it depends on `@hoppscotch/data` and `@hoppscotch/js-sandbox` packages that need to be built locally before the CLI can be compiled. The documentation now clarifies that: - These packages auto-build via postinstall hooks during `pnpm install` - Manual builds are primarily needed when making changes to these packages during development - The CLI build command must be run from the `packages/hoppscotch-cli` directory The changes are minimal and focused - only adding the necessary build commands with clear comments explaining the order of operations and when rebuilds are needed. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>