Skip to content

build: remove unused legacy docusaurus v1 dev dependency - #945

Open
Phantom-TA wants to merge 1 commit into
keploy:mainfrom
Phantom-TA:fix/remove-legacy-docusaurus-v1-dep
Open

Phantom-TA wants to merge 1 commit into
keploy:mainfrom
Phantom-TA:fix/remove-legacy-docusaurus-v1-dep

Conversation

@Phantom-TA

@Phantom-TA Phantom-TA commented Oct 29, 2026 •

Copy link
Copy Markdown

What has changed?

Removes the unused legacy docusaurus v1 dev dependency ("docusaurus": "^1.14.7") from package.json and regenerates yarn.lock. It looks like a leftover from the Docusaurus v2 migration: the site builds with @docusaurus/core 3.9.2 and nothing imports the v1 package.

The v1 package pulled in imagemin-gifsicle, so a plain npm install on Apple Silicon failed while compiling gifsicle (autoreconf not available). With it removed, npm ls gifsicle imagemin is empty and the lockfile drops about 4,000 lines of entries that nothing needs. Kept packages did not change version; the only lockfile additions are merged yarn.lock entries.

I also added a short note to the README. The repo ships a yarn.lock, so Docusaurus runs yarn --version to suggest upgrade commands, and npm run serve / npm run clear fail on machines without Yarn. I reproduced this locally. It comes from Docusaurus rather than from this repo, so the note says to install Yarn or set NO_UPDATE_NOTIFIER=1.

This PR Resolves keploy/keploy#4820

Type of change

  • Bug fix (non-breaking change which fixes an issue).
  • New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).
  • Documentation update (if none of the other choices apply).

How Has This Been Tested?

Tested on Windows 11, Node v24.3.0, with the dependency removed:

  • yarn install (Yarn 1.22.22) regenerated yarn.lock; patch-package applied cleanly.
  • npm run build succeeds: client and server compile and all 209 documents are processed.
  • npm ls gifsicle imagemin shows an empty tree.
  • npm run clear without Yarn installed reproduces the yarn --version failure described in the README note.
  • npx prettier@2.8.8 --check is clean on the changed files.

I did not test on Apple Silicon myself; the npm install fix was confirmed there by contributors in keploy/keploy#4820. I did not run npm run serve, and I have not added screenshots.

Checklist:

  • My code follows the style guidelines of this project.
  • I have performed a self-review of my own code.

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you and congratulations 🎉 for opening your very first pull request in keploy

package.json still listed the Docusaurus v1 package ("docusaurus": "^1.14.7"),
left over from the Docusaurus v2 migration. The site builds with
@docusaurus/core 3.9.2 and nothing imports the v1 package.

It pulled in imagemin-gifsicle, so a plain `npm install` on Apple Silicon
failed while compiling gifsicle (autoreconf not available). With the
dependency gone the lockfile drops about 4,000 lines, `npm ls gifsicle
imagemin` is empty, and `npm run build` still succeeds.

Also note in the README that the yarn.lock makes Docusaurus call
`yarn --version`, so `npm run serve` and `npm run clear` fail on machines
without Yarn unless Yarn is installed or NO_UPDATE_NOTIFIER=1 is set.

Refs keploy/keploy#4820

Signed-off-by: Tushar <tushar08032005@gmail.com>
@Phantom-TA
Phantom-TA force-pushed the fix/remove-legacy-docusaurus-v1-dep branch from 4618983 to 17694f4 Compare October 29, 2026 07:21

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[docs]: local setup & script failures with npm vs frozen yarn.lock on Apple Silicon (ARM64)

1 participant