Make sure that machete file for worktrees is sought for in the top-level git dir

RELEASE_NOTES.md

@@ -1,5 +1,9 @@
 # Release notes
 
+## New in git-machete 3.6.1
+
+- fixed: support for worktrees (reported by @kgadek)
+
 ## New in git-machete 3.6.0
 
 - added: `t` alias for `traverse` command

docs/source/cli_help/discover.rst

@@ -9,7 +9,7 @@ discover
     git machete discover [-C|--checked-out-since=<date>] [-l|--list-commits] [-r|--roots=<branch1>,<branch2>,...] [-y|--yes]
 
 Discovers and displays tree of branch dependencies using a heuristic based on reflogs and asks whether to overwrite the existing definition :ref:`file` with the new discovered tree.
-If confirmed with a ``y[es]`` or ``e[dit]`` reply, backs up the current definition file (if it exists) as ``$GIT_DIR/machete~`` and saves the new tree under the usual ``$GIT_DIR/machete`` path.
+If confirmed with a ``y[es]`` or ``e[dit]`` reply, backs up the current definition file (if it exists) as ``machete~`` and saves the new tree in the usual ``machete`` file.
 If the reply was ``e[dit]``, additionally an editor is opened (as in :ref:`git machete edit<edit>`) after saving the new definition file.
 
 **Options:**

docs/source/cli_help/file.rst

@@ -8,5 +8,10 @@ file
 
     git machete file
 
-Outputs the absolute path of the machete definition file. Currently fixed to ``<git-directory>/machete``.
-Note: this won't always be just ``<repo-root>/.git/machete`` since e.g. submodules and worktrees have their git directories in different location.
+Outputs the absolute path of machete definition file.
+The file is always called ``machete`` and is located in the git directory of the project.
+
+Three cases are possible:
+    * if ``git machete`` is executed from a regular working directory (not a worktree or submodule), this simply resolves to ``machete`` in .git folder,
+    * if ``git machete`` is executed from a **worktree**, this resolves to ``machete`` in the .git folder of the **top-level project** (not the worktree's .git folder!),
+    * if ``git machete`` is executed from a **submodule**, this resolves to ``machete`` in the .git folder of the **submodule** itself (not the top-level project's .git folder!).

docs/source/completion.rst

@@ -101,7 +101,7 @@ Fish:
         Please look at the section about [installation via Homebrew](https://github.com/VirtusLab/git-machete#using-homebrew-macos).
         ``brew install git-machete`` automatically installs fish completion files for ``git machete``.
     * Linux
-        #. Place the completion script in ``/path/to/fish/completions/`` (typically ``~/.config/fish/completions/git-machete.fish``).
+        Place the completion script in ``/path/to/fish/completions/`` (typically ``~/.config/fish/completions/git-machete.fish``).
 
         .. code-block:: shell
 

git_machete/client.py

@@ -851,7 +851,7 @@ def traverse(
         if not any_action_suggested and initial_branch not in self.__roots:
             print(fmt("Tip: `traverse` by default starts from the current branch, "
                       "use flags (`--starts-from=`, `--whole` or `-w`, `-W`) to change this behavior.\n"
-                      "Further info under `git machete traverse --help`."), file=sys.stdout)
+                      "Further info under `git machete traverse --help`."))
         if opt_return_to == "here" or (
                 opt_return_to == "nearest-remaining" and nearest_remaining_branch == initial_branch):
             print(f"Returned to the initial branch {bold(initial_branch)}")

git_machete/docs.py

@@ -168,7 +168,7 @@
         <b>Usage: git machete discover [-C|--checked-out-since=<date>] [-l|--list-commits] [-r|--roots=<branch1>,<branch2>,...] [-y|--yes]</b>
 
         Discovers and displays tree of branch dependencies using a heuristic based on reflogs and asks whether to overwrite the existing definition file with the new discovered tree.
-        If confirmed with a `y[es]` or `e[dit]` reply, backs up the current definition file (if it exists) as `$GIT_DIR/machete~` and saves the new tree under the usual `$GIT_DIR/machete` path.
+        If confirmed with a `y[es]` or `e[dit]` reply, backs up the current definition file (if it exists) as `machete~` and saves the new tree in the usual `machete` file.
         If the reply was `e[dit]`, additionally an editor is opened (as in `git machete edit`) after saving the new definition file.
 
         Options:
@@ -208,8 +208,13 @@
     "file": """
         <b>Usage: git machete file</b>
 
-        Outputs the absolute path of the machete definition file. Currently fixed to `<git-directory>/machete`.
-        Note: this won't always be just `<repo-root>/.git/machete` since e.g. submodules and worktrees have their git directories in different location.
+        Outputs the absolute path of machete definition file.
+        The file is always called `machete` and is located in the git directory of the project.
+
+        Three cases are possible:
+        * if `git machete` is executed from a regular working directory (not a worktree or submodule), this simply resolves to `machete` in .git folder,
+        * if `git machete` is executed from a <b>worktree</b>, this resolves to `machete` in the .git folder of the <b>top-level project</b> (not the worktree's .git folder!),
+        * if `git machete` is executed from a <b>submodule</b>, this resolves to `machete` in the .git folder of the <b>submodule</b> itself (not the top-level project's .git folder!).
     """,
     "fork-point": """
         <b>Usage:

git_machete/git_operations.py

@@ -1,3 +1,4 @@
+from pathlib import Path
 from typing import Callable, Dict, Generator, Iterator, List, Match, Optional, Set, Tuple
 
 import os
@@ -254,7 +255,14 @@ def get_root_dir(self) -> str:
     def __get_git_dir(self) -> str:
         if not self._git_dir:
             try:
-                self._git_dir = self._popen_git("rev-parse", "--git-dir").strip()
+                git_dir: str = self._popen_git("rev-parse", "--git-dir").strip()
+                git_dir_parts = Path(git_dir).parts
+                if len(git_dir_parts) >= 3 and git_dir_parts[-3] == '.git' and git_dir_parts[-2] == 'worktrees':
+                    self._git_dir = os.path.join(*git_dir_parts[:-2])
+                    debug('__get_git_dir', f'git dir pointing to {git_dir} - we are in a worktree; '
+                                           f'using {self._git_dir} as the effective git dir instead')
+                else:
+                    self._git_dir = git_dir
             except MacheteException:
                 raise MacheteException("Not a git repository")
         return self._git_dir

git_machete/tests/functional/test_machete.py

@@ -456,14 +456,15 @@ def setup_discover_standard_tree(self) -> None:
         )
 
     @mock.patch('git_machete.utils.run_cmd', mock_run_cmd)  # to hide git outputs in tests
-    def test_branch_reappers_in_definition(self) -> None:
+    def test_branch_reappears_in_definition(self) -> None:
         body: str = \
             """master
             \tdevelop
             \t\n
             develop
             """
-        expected_error_msg: str = fmt('.git/machete, line 5: branch `develop` re-appears in the tree definition. Edit the definition file manually with `git machete edit`')
+        expected_error_msg: str = fmt('.git/machete, line 5: branch `develop` re-appears in the tree definition. '
+                                      'Edit the definition file manually with `git machete edit`')
 
         self.repo_sandbox.new_branch("root")
         self.rewrite_definition_file(body)

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = pep8,mypy-py{36,37,38,39},py{36,37,38,39},coverage,docs
+envlist = pep8,mypy-py{36,37,38,39,310},py{36,37,38,39,310},coverage,docs
 minversion = 2.3.2
 skipsdist = True
 
@@ -32,7 +32,7 @@ exclude = ./.*,build,dist,*egg,venv
 import-order-style = pep8
 
 [testenv:coverage]
-description = "Checking the test coverage of the code."
+description = "Check the test coverage of the code"
 deps = coverage
 commands =
   coverage erase
@@ -51,9 +51,9 @@ commands =
 
 [testenv:mypy]
 whitelist_externals = tox
-commands = tox -e "mypy-py{36,37,38,39}"
+commands = tox -e "mypy-py{36,37,38,39,310}"
 
-[testenv:mypy-py{36,37,38,39}]
+[testenv:mypy-py{36,37,38,39,310}]
 deps = mypy
 commands =
   mypy --config-file mypy.ini git_machete