Fix: Clear up workspace subdependencies (fixes #629)

[oliverfoster]

fixes #629

Allows workspaces to use giturl dependencies and peer dependencies by cleaning up erroneously installed duplicates of the workspace modules.

Fix

• Adds postinstall script to clean up workspace duplicate sub dependencies

Test

git clone https://github.com/adapt-security/adapt-authoring 629-workspacesubdependencies
cd 629-workspacesubdependencies
git checkout issue/629
git clone https://github.com/adapt-security/adapt-authoring-contentplugin local_adapt_modules/adapt-authoring-contentplugin
git clone https://github.com/adapt-security/adapt-authoring-core local_adapt_modules/adapt-authoring-core
npm install --force # to override peer dependency resolve errors

[chris-steele]

First pass was excellent @oliverfoster :

• started with clean clone of adapt-authoring
• placed adaptframework, api, content and contentplugin clones in workspace
• ran npm i --force

Post intall script removed erroneous sub deps in workspaces and also in root modules (coursetheme and mongodblogger)

Ran node ./bin/start.js - tool built and started with no issues 💯

[oliverfoster]

This will all hopefully be fixed by itself for the most part once the repos are registered on npm. This is as the subdependencies when defined with "name": "version" should resolve against workspace modules properly where they don't with "name": "giturl".

[chris-steele]

@oliverfoster is it possible to have this run after npm update? I just realised after running that command all the erroneous installs return.

[oliverfoster]

Probably. Although it may be that you just need to run npm install to do updates.

Here's the documentation for how scripts are named with pre and post.

https://docs.npmjs.com/cli/v10/using-npm/scripts

And the update command.

https://docs.npmjs.com/cli/v10/commands/npm-update

You could also run it manually with npm run postinstall

[chris-steele]

Great tips thank you 💯

[oliverfoster]

@chris-steele did you find a way to get it to work on npm update?

[chris-steele]

Yes @oliverfoster I can run npm run postinstall after npm update and it works as expected 👍

[oliverfoster]

Did you try adding the same script at postupdate?

[oliverfoster]

Is there any progress on this?

[chris-steele]

I did try postupdate, but I don't think it is available with npm

[oliverfoster]

It is not, correct.

https://github.com/npm/rfcs/discussions/226

[chris-steele]

Looks to have fizzled out and died a death