search

citkane / typedoc-plugin-versions

Semantic versioning with select dropdown for Typedoc documentation sets
https://citkane.github.io/typedoc-plugin-versions/
MIT License
4 stars 6 forks source link

Promote `fs-extra` to a dependency #3

Closed toebeann closed 2 years ago

toebeann commented 2 years ago

Changes made in this pull request

NB: Attempted to test locally via npm link but your build script requires linux and I'm running on a Windows box so no go on that front. Manually ran the steps of your build script by hand but still couldn't get it to work for local testing via npm link, so you'll want to run tests yourself.

Implications

Minimal. fs-extra will automatically be installed as a local dev dependency for dependents when installing via npm i -D typedoc-plugin-versions, and this dependency will not trickle down to consumers of their own package.

Of course, if dependents neglect to install with -D/--save-dev, the dependency will trickle down to their own dependents, but that is on them.

toebeann commented 2 years ago

Ah, I targeted dev as I assumed this was appropriate, but I see now that dev is many commits behind main. You'll want to merge from main into dev first, or retarget this to PR to main.

citkane commented 2 years ago

Ah, I targeted dev as I assumed this was appropriate, but I see now that dev is many commits behind main. You'll want to merge from main into dev first, or retarget this to PR to main.

My bad (housekeeping)... You were right to merge to dev. I updated the CI to restrict pull requests targeting 'main', and also added linting and prettier checks. Thanks for helping.