Symlink the configuration file to the root of the project

[teamwolfyta]

Is your feature request related to a problem? Please describe.

• treefmt-vscode won't function because it can't find either of these files: treefmt.toml .treefmt.toml.

Describe the solution you'd like

• You could you perhaps do what git-hooks does and symlink the generated config to the root of the project. How will be up for debate.

Describe alternatives you've considered

• Manually symlinking the file in my devShell but obviously this will get repetitive.

[teamwolfyta]

After researching a bit, i discovered git-hooks uses git to first figure out the root of the project, check for an existing .pre-commit-config.yaml, if there is one it and it's not a symlink it will error out else it will create or update the symlink from what i presume is the config file created in the nix store to the config file in the root of your project.

• Get's the root of the project here using git.
• Update's the existing symlink config file here.
• Check's if there's an existing config file here.
• And finally symlinks the file here.

There's some extra code but not sure what that's for, the code below that last hyperlink is specific to pre-commit.

I'm not sure this project would appreciate doing a similar implementation as it then requires a git repository to be initiated to use treefmt-nix.

[teamwolfyta]

For anyone else who's searching for a solution, This is what I've temporarily done to my devShell:

    shellHook = ''
      FLAKE_ROOT=$(${getExe gitMinimal} rev-parse --show-toplevel)
      SYMLINK_SOURCE_PATH="${treefmt.build.configFile}"
      SYMLINK_TARGET_PATH="$FLAKE_ROOT/.treefmt.toml"

      if [[ -e "$SYMLINK_TARGET_PATH" && ! -L "$SYMLINK_TARGET_PATH" ]]; then
        echo "treefmt-nix: Error: Target exists but is not a symlink."
        exit 1
      fi

      if [[ -L "$SYMLINK_TARGET_PATH" ]]; then
        if [[ "$(readlink "$SYMLINK_TARGET_PATH")" != "$SYMLINK_SOURCE_PATH" ]]; then
          echo "treefmt-nix: Removing existing symlink"
          unlink "$SYMLINK_TARGET_PATH"
        else
          exit 0
        fi
      fi

      nix-store --add-root "$SYMLINK_TARGET_PATH" --indirect --realise "$SYMLINK_SOURCE_PATH"
      echo "treefmt-nix: Created symlink successfully"
    '';

I use flake-parts with the treefmt-nix flakeModule. treefmt in this code is just config.treefmt.