add PREFER_APPEND_FILE_SYNC env

[chouchouji]

resolve #115

[toplenboren]

Thanks for the PR. Can you please add some tests, so that no one would be to break your code :-)

[chouchouji]

Thanks for the PR. Can you please add some tests, so that no one would be to break your code :-)

Thanks for your review. I had added test cases.

[JounQin]

But what if the user run simple-git-hooks multi times?

[chouchouji]

But what if the user run simple-git-hooks multi times?

This is a rare scenario, and we should specify in the document what consequences it will bring.

[JounQin]

It is a very common practice to use "prepare": "simple-git-hooks" lifecyle script to ensure hooks are always latest.

Oh, I miss understood, a temporary env variable to init simple-git-hooks seems fine enough, not a persist option.

[chouchouji]

It is a very common practice to use "prepare": "simple-git-hooks" lifecyle script to ensure hooks are always latest.

Oh, I miss understood, a temporary env variable to init simple-git-hooks seems fine enough, not a persist option.

We can provide a detailed explanation of the purpose of this environment variable to prevent unnecessary problems for users

[changeset-bot]

⚠️ No Changeset found

Latest commit: 08ec628

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[JounQin]

@chouchouji Hi, tests are failing on CI after merging #120, can you rebase?

And for the env name, I think SIMPLE_GIT_HOOKS_PREFER_APPEND would be better, WDYT?

[toplenboren]

But what if the user run simple-git-hooks multi times?

This is a rare scenario, and we should specify in the document what consequences it will bring.

Actually, I still do not get the usecase for this option.. Why would I need to use append file sync, and not simply set the hooks myself if I want that level of customization?

Can you please share your usecase @chouchouji

[JounQin]

I forgot to mention that if the user use "prepare": "simple-git-hooks" pattern, even a temporary environment won't work as expected.

1. with the environment, append every time
2. without the environment, override every time

So never works as expected.

[chouchouji]

But what if the user run simple-git-hooks multi times?

This is a rare scenario, and we should specify in the document what consequences it will bring.

Actually, I still do not get the usecase for this option.. Why would I need to use append file sync, and not simply set the hooks myself if I want that level of customization?

Can you please share your usecase @chouchouji

I add some commands in commit-msg and my config like "commit-msg": "pnpm exec vr commit-lint -p $1". It will override my commands. So I think we can resolve this problem by env or other thing.

[chouchouji]

I forgot to mention that if the user use "prepare": "simple-git-hooks" pattern, even a temporary environment won't work as expected.

1. with the environment, append every time
2. without the environment, override every time

So never works as expected.

Please check the comment below. I show my usecase. Maybe we can find other methods to resolve my problem.

[chouchouji]

I forgot to mention that if the user use "prepare": "simple-git-hooks" pattern, even a temporary environment won't work as expected.

1. with the environment, append every time
2. without the environment, override every time

So never works as expected.

Yes. My behavior is use cli. So I think env is good for me. But some users maybe use this tool unlike me.

[toplenboren]

From what I understood it sounds like you can either:

• add your custom commands from commit-msg hook to simple-git-hooks config
• remove commit-msg hook from simple-git-hooks config and just set everything yourself

I understand that it cannot be done this way if you work in a team on some project because:

• You do not want to commit your personal commands to project's git
• You do not want to remove simple-git-hooks config for all teammates

To handle this case we can add something like simple-git-hooks.custom.json that you won't commit to git and that can override the "commit-msg" hook if explitly set to null

Like

simple-git-hooks.custom.json

const config = {
  "commit-msg": null // will overwrite settings in config if set to null
}

That way you will be able to have both config and your commands inside of simple-git-hooks or you will be able to simply remove commit-msg from simple-git-hooks configuration and handle commit-msg hook yourself

All these without the need to commit the code elsewhere

I've implemented something similar in another project, open-condo-software/condo#5893 open source engineers want to override translations that we have set

@chouchouji wyt?

[chouchouji]

据我了解，您可以：

• 将自定义命令从commit-msg钩子添加到simple-git-hooks配置中
• 从配置中删除一切commit-msg钩子simple-git-hooks并自行设置

我理解，如果你在某个项目中以团队形式工作的话就能够这样做，因为：

• 你不想将你的个人命令提交到项目的 git
• 您不想删除simple-git-hooks所有珍珠的配置

为了处理这种情况，我们可以添加一些类似的东西，simple-git-hooks.custom.json比如你不会提交给 git，并且可以覆盖“commit-msg”钩子（如果明确设置为 null）

喜欢

简单-git-hooks.custom.json

const config = {
  "commit-msg": null // will overwrite settings in config if set to null
}

这样，您将能够在 simple-git-hooks 中同时拥有配置和命令，或者您可以简单地从 simple-git-hooks 配置中删除 commit-msg，并自己处理 commit-msg 钩子

所有这些都消耗在其他地方提交代码

我在另一个项目中实现了类似的东西，open-condo-software/condo#5893开源工程师想要覆盖我们设置的翻译

@chouchouji为啥？

Thanks for your reply and suggestion. I think it is a good idea.

[toplenboren]

Hey, @chouchouji what is your plan with this PR? Is there anything I can do to help? :-)

[chouchouji]

Hey, @chouchouji what is your plan with this PR? Is there anything I can do to help? :-)

I think we can close it. Thanks for your help.