PreCommit hook with 'include' seems to always fire, not only for staged files

[sommmen]

Hello,

I'm trying to create a precommit hook to validate the renovate.json file. It should only fire if the renovate.json file is modified (because the validator is not super fast).

{
  "$schema": "https://alirezanet.github.io/Husky.Net/schema.json",
  "tasks": [
    {
      "group": "pre-commit",
      "name": "validate-renovate-config",
      "branch": "main|master",
      "include": [
        "renovate.json"
      ],
      "filteringRule": "staged",
      "command": "bash",
      "args": [
        "npx --yes --package renovate -- renovate-config-validator"
      ],
      "windows": {
        "command": "powershell",
        "args": [
          "-Command",
          "npx --yes --package renovate -- renovate-config-validator"
        ]
      }
    },
    {
      "group": "commit-msg",
      "name": "commit-message-linter",
      "branch": "main|master",
      "command": "dotnet",
      "args": [
        "husky",
        "exec",
        ".husky/csx/commit-lint.csx",
        "--args",
        "${args}"
      ]
    }
  ]
}

#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

## husky task runner examples -------------------
## Note : for local installation use 'dotnet' prefix. e.g. 'dotnet husky'

## run all tasks
#husky run

### run all tasks with group: 'group-name'
#husky run --group group-name

## run task with name: 'task-name'
#husky run --name task-name

## pass hook arguments to task
#husky run --args "$1" "$2"

## or put your custom commands -------------------
#echo 'Husky.Net is awesome!'

dotnet husky run --group "pre-commit"

I think my hook file is not right and may be missing arguments?
Right now the precommit hook always fires.

[sommmen]

@alirezanet Could you have a quick look?

[sommmen]

Before I check it, FYI—it might be easier to let you know there's an integration test in this repo you can use to test your configuration in an isolated environment (leveraging Docker and Testcontainers). So, I recommend giving it a try if you have Docker set up. You might be able to simulate the scenario yourself through tests.

Checking out thisor this should give you an idea of how it works.

Took a little crack at this, the closes test was;
FilteringRuleStaged_WithoutAnyMatchedFile_ShouldSkip,

I changed the arrange to have the run --group, ofcourse that did not seem to matter.

Checked the repo for platform specific (windows) properties - the code looks okay.

The testcontainers run on linux and it looks good so it must be windows or pathing or something.
Anways it seems like whatever i input as 'include' it just always executes the precommit hook.

Let me know what you want to do but in order to debug this i'd need to run this under windows.
We'd need to have some debug/verbose logging (and a flag to on/off), to make sure we know that the include gets passed correctly to the matcher for example etc.
Otherwise we'd need to change the test container setup to be cross platform and to be able to run the test on linux/windows containers. I checked images online and i think you'd need to use the server core one.

Lmk your thoughts.

[alirezanet]

Hi @sommmen,
I found the problem,
The task loader was changing the filteringRule from staged to variable when you use the windows configurations. I'll release a new version soon with this fix.

[sommmen]

Hi @sommmen, I found the problem, The task loader was changing the filteringRule from staged to variable when you use the windows configurations. I'll release a new version soon with this fix.

Cool - i knew it had to be the windows config. Curious to see the code changes.
Thanks for figuring this out!

[alirezanet]

this is the fix:
3241cbb

[sommmen]

this is the fix: 3241cbb

Haha ofcourse, cause it overrides the properties.
Well found, thanks for the help!

[sommmen]

this is the fix: 3241cbb

was this published to nuget?

[alirezanet]

not yet. I need to make sure it is not a breaking change. (we have some tests failing)

[alirezanet]

As a workaround for now, I think if you add the filteringRule to your Windows section, it should work as expected

      "windows": {
        "command": "powershell",
        "filteringRule": "staged",
        "args": [
          "-Command",
          "npx --yes --package renovate -- renovate-config-validator"
        ]
      }