husky install fails when project is a submodule

Version

0.5.4

Details

when running dotnet husky install from the root of my project directory, or as part of automated installation, I get an error message

.git can't be found (see https://alirezanet.github.io/Husky.Net/guide/getting-started)
Git hooks installation failed

Steps to reproduce

1. create a new git repository

mkdir new_repo
cd new_repo
git init

1. add existing project with husky as a sub-module

git submodule add [e-mail]:alirezanet/Husky.Net.git

1. build the submodule to trigger husky installation

cd Husky.Net
dotnet build

you will get the following error

MSBuild version 17.5.0+6f08c67f3 for .NET
  Determining projects to restore...
  .git can't be found (see https://alirezanet.github.io/Husky.Net/guide/getting-started)
  Git hooks installation failed
D:\source\repos\new_repo\Husky.Net\src\Husky\Husky.csproj(61,5): error MSB3073: The command "dotnet husky install" exit
ed with code 1.

Build FAILED.

D:\source\repos\new_repo\Husky.Net\src\Husky\Husky.csproj(61,5): error MSB3073: The command "dotnet husky install" exit
ed with code 1.
    0 Warning(s)
    1 Error(s)

Time Elapsed 00:00:03.52

[alirezanet]

Option 3: Same as Option 2 but we also install the hooks in the super project .git (I don’t personally see any valid uses for this you only want your submodule hooks to run when doing things on the submodule itself and Option 2 handles that.

I agree, I think user can install husky for super project (if needed) later … so Option 2 makes more sense.

i also added a IgnoreWhenSubmodule option to install … Maybe make the option name a little bit simpler like IgnoreSubmodule … (in the description we can add more details)

Thank you for the effort and I know it is harder than we thought … especially testing different scenarios takes time.

[Tychus]

This turns out to be a lot more complicated than i anticipated. Our use case is pretty simple, but to handle god knows how many possible setups out there…

Example tree

.
├── .git
├── .gitmodules
├── .husky
│   ├── _
│   │   ├── .gitignore
│   │   └── husky.sh
│   └── task-runner.json
├── Submodule
│   ├── .git (this is a file pointing at `../.git/modules/Submodule` which is your usual .git folder)
│   ├── .husky
│   │   ├── _
│   │   │   ├── .gitignore
│   │   │   └── husky.sh
│   │   └── task-runner.json
│   ├── Submodule.sln
│   └── src
└── TestHuskySubmodules
    ├── TestHuskySubmodules
    └── TestHuskySubmodules.sln

Option 1: If we’re dealing with a submodule we just exit without doing anything. Options 2: If we’re in a submodule we install the hooks from the submodule in the submodule’s .git folder (which is pointed at by the .git file (submodules have there .git dir in the super project .git folder under the modules subfolder) Option 3: Same as Option 2 but we also install the hooks in the super project .git (I don’t personally see any valid uses for this you only want your submodule hooks to run when doing things on the submodule itself and Option 2 handles that.

Let me know what you think. Should Option 3 be handled ?

PS: i also added a IgnoreWhenSubmodule option to install when set we go with Option 1. This means i will also have to change the attach command so it adds that option when specified. any input on what the best way to do that is welcome