Support install not in .git root

[jods4]

Details

Currently, husky checks that it's being installed in the repository root, i.e. cwd contains a .git folder.

Some repository contain more than a .net solution, it's not uncommon to have other folders at root such as docs, infra, front-end, etc. In our setup, dotnet solution and .config local tools live in a Source folder, under root.

The issue with this is that:

1. Local dotnet tool can't run outside Source because they're local and do not exist outside of that folder.
2. Local tool Husky can't run inside Source because it requires .git in the same folder where it runs.

As 1. and 2. are mutually exclusive, there's no working configuration :(

Note

Husky -- the NPM project that inspired Husky.Net -- has a "How to" for this topic in its documentation:
https://typicode.github.io/husky/how-to.html#project-not-in-git-root-directory

Their solution is simply to change working directory appropriately in install script and hook.
The blocker is that whereas cd .. & husky works in NPM scripts, there's no way parameter to change the working directory in dotnet run, so husky init can't be run in a different cwd.

Suggested solution

Add a --cwd parameter to install command, so that the working directory can be changed before it runs:

dotnet husky install --cwd ../..

The reverse cd command should be inferred automatically (using Path.GetRelativePath) and introduced in hook script so that they run in the correct folder (otherwise dotnet husky & other local .net tool tasks will not be found).

[alirezanet]

Hi @jods4,
have you tried using the install's --dir option, you can move your .husky folder to the subdirectories if needed, just for the first time installing husky to the git repository you have to do it from the root folder. (if you don't want to add the .config folder in your root folder, you can install husky.net globally ). maybe I'm missing the point, in that case would be nice if you could provide a test project with your desired layers/folders ...

[jods4]

Thanks for the quick answer!

--dir doesn't help. I'm ok with having the folder at the root next to .git, or lower in Source. Both would be fine.

husky install does not even run because of this safety guard: https://github.com/alirezanet/Husky.Net/blob/master/src/Husky/Cli/InstallCommand.cs#L73-L79

[bdarlt]

I have a monorep with both an Angular app (/web) and a .Net solution (/api).

What mostly works is installing Husky.Net into the root folder (with the .git directory). You can use "cwd" in some way to pick the part of the monorep you want.

The prepare script of the Angular App (/web) installs/activates husky. I haven't figured out a way to "activate" Husky on the .NET side. Missing a monorep tool, I suppose.

{
  "tasks": [
    {
      "name": "dotnet-format",
      "cwd": "api",
      "group": "pre-commit",
      "command": "dotnet",
      "args": ["format", "--include", "${staged} --severity error"],
      "include": ["**/*.cs", "**/*.vb"]
    },
    {
      "name": "eslint",
      "group": "pre-commit",
      "pathMode": "absolute",
      "cwd": ".",
      "command": "npx",
      "args": ["lint-staged", "-r", "--cwd", "web"],
      "include": ["**/*.ts", "**/*.js"]
    },
    {
      "name": "prettier",
      "group": "pre-commit",
      "pathMode": "absolute",
      "cwd": ".",
      "command": "npx",
      "args": ["prettier", "--write", "${staged}"],
      "include": [
        "**/*.ts",
        "**/*.vue",
        "**/*.jsx",
        "**/*.js",
        "**/*.json",
        "**/*.yml",
        "**/*.css",
        "**/*.scss"
      ]
    },
    {
      "name": "Welcome",
      "output": "always",
      "command": "bash",
      "args": ["-c", "echo Nice work! 🥂"],
      "windows": {
        "command": "cmd",
        "args": ["/c", "echo Nice work! 🥂"]
      }
    }
  ]
}

[jods4]

What mostly works is installing Husky.Net into the root folder

Yes, this is the requirement that I would like to see lifted with this issue.

Depending on your repo structure, which may be outside your control, it's not always ok to add .net tools at the root of the repo.

[oleksii-yurchenko-bhge]

Having the same issue. We use monorepo, and have several .net solutions inside. So, whenever I try to add pre-commit hook it says that cannot find .git folder

[doggy8088]

@alirezanet You can get the right .git path by running this git command: git rev-parse --git-dir.

[alirezanet]

@alirezanet You can get the right .git path by running this git command: git rev-parse --git-dir.

Husky.Net/src/Husky/Services/Git.cs

Line 115 in f193c61

var result = await ExecBufferedAsync($"-C \"{path}\" rev-parse --git-dir");

Hi @doggy8088
This is exactly how we find the git folder currently, what am I missing?

also I'm using this to find the submodules:

Husky.Net/src/Husky/Services/Git.cs

Line 95 in f193c61

var result = await ExecBufferedAsync($"-C \"{path}\" rev-parse --show-superproject-working-tree");

I couldn't properly simulate the problem, I think it might be related to the different git setups on some machines, that's why there is no progress on this so far. if someone could simulate it in a test case (ideally using our integration tests) would be much simpler to fix the issue.

[doggy8088]

@alirezanet I can replicate this issue consistently. Here's the PowerShell script:

mkdir MyProject
cd MyProject\

dotnet new gitignore
dotnet new editorconfig

# Initialize Git repository
git init -b main
git add .
git commit -m "Initial commit"

# Create solution folder
mkdir DemoApp
cd DemoApp\

# Initialize solution and .gitignore
dotnet new sln

# Initialize main project and add to solution
mkdir src
cd src
dotnet new webapi -controllers -n DemoApp
cd ..
dotnet sln add src/DemoApp/DemoApp.csproj

git add .
git commit -m "Add DemoApp webapi app"

# Initialize xUnit test project and add to solution
mkdir tests
cd tests
dotnet new xunit -n DemoApp.Tests
cd DemoApp.Tests
dotnet add package Microsoft.NET.Test.Sdk
dotnet add package xunit
dotnet add package xunit.runner.visualstudio
dotnet add package coverlet.collector
cd ..
cd ..
dotnet sln add tests/DemoApp.Tests/DemoApp.Tests.csproj

git add .
git commit -m "Add DemoApp.Tests"

# Initialize .NET local tools and Husky tool
dotnet new tool-manifest
dotnet tool install Husky

git add .
git commit -m "Add Husky tool manifest"

# At this moment, run `dotnet husky install` will fail.
dotnet husky install

My husky versino:

$ dotnet husky --version
v0.8.0

I discovered a bug in the code. The issue is with the cwd, which incorrectly uses the hard-coded Environment.CurrentDirectory in the source.

Husky.Net/src/Husky/Cli/InstallCommand.cs

Line 50 in f193c61

var cwd = Environment.CurrentDirectory;

Husky.Net/src/Husky/Cli/InstallCommand.cs

Lines 73 to 79 in f193c61

	else if (!_fileSystem.Directory.Exists(Path.Combine(cwd, ".git"))) // Ensure that cwd is git top level
	{
	// Need to check if we're inside a git work tree or not (issue #43)
	// If we are we can skip installation and if we're not, we should return exception.
	if (!(await _git.GetGitDirectory(cwd)).Contains("worktrees"))
	throw new CommandException($".git can't be found (see {DOCS_URL})\n" + FailedMsg);
	}

[alirezanet]

Hi again @doggy8088, Thanks for sharing the script.

I discovered a bug in the code. The issue is with the cwd, which incorrectly uses the hard-coded Environment.CurrentDirectory in the source.

I tested it, and I remembered this was an intentional choice to avoid later path complications. Basically, the only requirement is to install Husky next to your .git folder. I said I couldn’t reproduce the problem because it’s easily solvable with an extra cd .. command.

What I still don’t understand is: in what scenario is it not possible to move to the parent folder? And why do we think this feature is necessary? I also checked the npm Husky package, and people handle this situation almost the same way.

Could you clarify the reason behind this and the problems it causes?

EDIT:
(I remember we went through this before for submodules in #69, please also take a look here and let me know what do you think)

[doggy8088]

If you run my script, you will know. I can't run .NET Local Tool from parent folder. That's an issue! Not just as simply as cd ... Hope you can understand.

[alirezanet]

Hi @doggy8088,
I understand what feature is being requested, I’m just looking for a valid reason or scenario for why it’s needed.
This is exactly your script, with an added cd .. that fixes the issue. (I'm a bit concern about mono-repo compatibility, that's why it is important to understand the problem first)

mkdir MyProject
cd MyProject\

dotnet new gitignore
dotnet new editorconfig

# Initialize Git repository
git init -b main
git add .
git commit -m "Initial commit"

# Create solution folder
mkdir DemoApp
cd DemoApp\

# Initialize solution and .gitignore
dotnet new sln

# Initialize main project and add to solution
mkdir src
cd src
dotnet new webapi -controllers -n DemoApp
cd ..
dotnet sln add src/DemoApp/DemoApp.csproj

git add .
git commit -m "Add DemoApp webapi app"

# Initialize xUnit test project and add to solution
mkdir tests
cd tests
dotnet new xunit -n DemoApp.Tests
cd DemoApp.Tests
dotnet add package Microsoft.NET.Test.Sdk
dotnet add package xunit
dotnet add package xunit.runner.visualstudio
dotnet add package coverlet.collector
cd ..
cd ..
dotnet sln add tests/DemoApp.Tests/DemoApp.Tests.csproj

git add .
git commit -m "Add DemoApp.Tests"


# FIX: INSTALL HUSKY IN THE PARENT FOLDER <--- 
cd ..

# Initialize .NET local tools and Husky tool
dotnet new tool-manifest
dotnet tool install Husky

git add .
git commit -m "Add Husky tool manifest"

# At this moment, run `dotnet husky install` will fail.
dotnet husky install

[doggy8088]

I understand. You initialize .NET local tools at the root of the repository. That makes sense.

I hadn't considered that. As you mentioned, it's a monorepo project. I want the .NET-related tools, including the Husky tool, to be installed only under the DemoApp folder.

In Git 2.25, the Sparse Checkout feature is commonly used in many monorepo projects. This means I might never see any folders other than the DemoApp folder for .NET backend developers.

Do you believe it's a valid reason or scenario?