FlowFuse / FlowFuse/dev-env

Incorrect instructions in readme regarding updating sub project deps

Open
#26 0 comments 0 reactions 0 assignees View on GitHub
needs-triage
Dominant language
JavaScript
Stars
5
Forks
2
Avg merge
14h 27m
Merged PRs (30d)
1

Description

### 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](https://github.com/flowforge/flowforge-dev-env/assets/44235289/0db1e6e9-8dc8-484c-bc24-36dd54be718a)

#### After running `npm i` in a sub package dir
![image](https://github.com/flowforge/flowforge-dev-env/assets/44235289/18db607b-fc44-4fe9-9b95-e7d563ad8912)

#### 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

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.