Commit README.md file too

[fabianmieller]

Hello,

I'm updating the version in the file README.md under "npm-scripts version" and I want to add this file to the same commit.

Are there solutions for that?

Thanks
Fabian

[itaisteinherz]

And more in general, it would be very helpful if np supported supplying a custom script to run when creating a new version commit.

[sindresorhus]

@itaisteinherz Agreed.

This depends on #279.

[itaisteinherz]

This depends on #279.

Why? It seems to me like this could be implemented even without having globally and locally configurable flags (e.g. using a default script that is run if configured, or an argument supplied directly to the CLI).

[itaisteinherz]

I just noticed this tip in the readme, which means that np already supports what I described above. However, when I tried using the version npm hook to add extra behavior when creating a new version, the new changes weren't committed with the version bump. This meant that I had to create another commit for the changes, which isn't the desired behavior here.

@sindresorhus We should probably add tips for using np with semantic release and standard version.

[sindresorhus]

We should probably add tips for using np with semantic release and standard version.

👍

[sindresorhus]

Why? It seems to me like this could be implemented even without having globally and locally configurable flags (e.g. using a default script that is run if configured, or an argument supplied directly to the CLI).

Sure, we could maybe add a CLI flag, but I don't want to end up with an endless amount of CLI flags. It's more readable and easier for users to add hooks as config. We'll probably need multiple hooks.

[simonhaenisch]

but I don't want to end up with an endless amount of CLI flags

Why not? ls has like 40 and I as a user don't have any issues with that 🤓 I just ignore all the ones I don't need...

It's more readable and easier for users to add hooks as config. We'll probably need multiple hooks.

Totally agree with this and I also think cosmiconfig would be a good choice for this because people have different preferences for how to write configs and that's ok. It's great if I don't have to write a super-long cli command with escaped quotes inside strings, and instead I can just put all the flags into a config file of my choice... however I might also only need one or two flags and a command in an npm script is better suited for me, so why not have both a flag and a config? Then it could also be possible to pass a flag to overwrite just one setting while still respecting the rest of my config.

[itaisteinherz]

@simonhaenisch I'm pretty sure that what @sindresorhus meant is that we'll add support for configuration through config files using cosmiconfig, but will continue to support CLI arguments, just like AVA does.

[simonhaenisch]

This meant that I had to create another commit for the changes, which isn't the desired behavior here.

I think you could solve this by amending the version commit using the postversion hook, i. e.

{
  "scripts": {
    "version": "conventional-changelog", // or whatever updates the changelog
    "postversion": "git add CHANGELOG.md && git commit --amend --no-edit"
  }
}

Or you could try to add the modified file in the version hook (which is run before committing), i. e.

{
  "scripts": {
    "version": "conventional-changelog && git add CHANGELOG.md",
  }
}

(/cc @fabianmieller)

[itaisteinherz]

@simonhaenisch Thanks for the suggestions, but I already tried both and they didn't work. Sometimes the hooks never ran, and sometimes they ran after the version bump was committed. Sorry for the vague explanation, I'll try to look further into this in a few days.

[fabianmieller]

@simonhaenisch works thanks!