FlowFuse / FlowFuse/dev-env

Incorrect instructions in readme regarding updating sub project deps

Aperta
#26 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
needs-triage
Lingua principale
JavaScript
Stelle
5
Fork
2
Merge medio
14h 27m
PR unite (30g)
1

Descrizione

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

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Inizia esaminando le istruzioni sulle dipendenze nel README e le directory dei package, in particolare packages/flowforge. Riproduci il comportamento di npm install su Windows, macOS e Linux, se disponibili, quindi determina se sia necessario modificare il README o il flusso di installazione di dev-env; il lavoro è completato quando il processo documentato corrisponde al comportamento effettivo delle dipendenze e dei symlink.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
javascript, nodejs
Ambito
tooling
Tipo di issue
Documentazione
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
35/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.