frontsideair / yarnhook

Run `yarn install`, `npm install` or `pnpm install` on git hooks automatically
MIT License
217 stars 17 forks source link

Support appending additional arguments #30

Open dizlexik opened 5 years ago

dizlexik commented 5 years ago

Would it be possible to add the ability to accept additional arguments so I could do something like this:

"husky": {
  "hooks": {
    "post-checkout": "yarnhook --ignore-optional",
    "post-merge": "yarnhook --ignore-optional",
    "post-rewrite": "yarnhook --ignore-optional"
  }
}

I'd really like to prevent yarnhook from installing optional dependencies.

frontsideair commented 4 years ago

I think adding --ignore-optional (or comparable) to the default set of flags makes sense since they're optional and it'll make git operations faster.

I'm on the fence about adding arguments though, since—despite the name—yarnhook is package manager independent. I'm open to changing my mind but I'll make the --ignore-optional change regardless.

zkochan commented 3 years ago

I don't think this was a good idea. If someone wants to influence how the package manager is behaving itself, they can just create a config file for that package manager with settings. So if I want to skip optional dependencies, I would create a .npmrc with this content:

optional=false

Now because the CLI flags have the biggest priority, there is no way to include optional dependencies. I need optional dependencies to be installed. So now I have to always rerun pnpm install after switching branches. So yarnhook loses its benefits in my case.

qnp commented 2 years ago

@zkochan 100% agreed. In case of nuxt3, esbuild needs to be installed in the correct platform and is done using optionalDependencies so everytime yarnhook runs, the nuxt3 project cannot be built until a new yarn install is run.

frontsideair commented 2 years ago

I came back to this and I believe it was not the right call to exclude optional dependencies by default. While it's important that branch switches to be fast, it's more important that yarnhook doesn't change the end result. It should be a core principle that yarnhook doesn't install different dependencies than when you install them manually with default flags.

I reviewed the current default flags and this seems like the only offending one. If we categorize them:

So the first thing I'll do is to remove --no-optional, adding a way to configure it may come later. Not sure if it'll be needed as @zkochan demonstrated. I had a major refactor in a branch, I can probably add providing the option to that scope.

frontsideair commented 2 years ago

I cut a new release, it's a major one due to the reasons mentioned in the release page. I hope this solves existing problems and please let me know if it breaks anything.