Incorrect instructions in readme regarding updating sub project deps

Open
#26 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript, nodejs
Domain
tooling

Research direction

Start by reviewing the README dependency instructions and the package directories, especially packages/flowforge. Reproduce the npm install behavior on Windows, macOS, and Linux if available, then determine whether the README or dev-env installation flow should change; done means the documented process matches actual dependency and symlink behavior.

Written by the indexing model from the issue text.

Description

needs-triage
Current Behavior

The readme states

Changing a repos dependencies
Do not run npm install in one of the repository directories under packages.

If you do, you'll need to delete the node_modules directory that gets created.

If you need to modify a repository's dependencies:

Edit its package.json to add the dependencies in the normal way
Run npm install in the root of this repository.

Since NPM workspaces are no longer used, this is incorrect.

Running npm install does not install sub package dependencies. It is now necessary to run npm install inside (for example) packages/flowforge

This however replaces the sym links with actual NPM package installs - which can catch you off guard if you are making changes across multiple repositories

Before running npm i in a sub package dir

image

After running npm i in a sub package dir

image

NOTE:

This might be a windows only thing? Will need a MAC and LINUX try-out before committing to a solution.

Expected Behavior

Either the docs should be update to reflect new practices or npm install in dev-env should have a post script to do npm install across all sub packages & then run npm run link

Steps To Reproduce

No response

Environment
  • FlowForge version: NA
  • Node.js version: v16.18.1
  • npm version: 9.8.1
  • Platform/OS: Windows 11
  • Browser: NA
Dominant language
JavaScript
Stars
5
Forks
2
Avg merge
14h 27m
Merged PRs (30d)
1

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from FlowFuse/dev-env

All issues in FlowFuse/dev-env

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.