feat(utils): find project root

Author: AnsonH

lua/copy-python-path/init.lua

@@ -1,3 +1,4 @@
+local rooter_utils = require("copy-python-path.utils.rooter")
 local symbol_utils = require("copy-python-path.utils.symbol")
 
 local M = {}
@@ -6,20 +7,13 @@ function M.copy_dotted_path()
     -- TODO: Early return if not `*.py` file
 
     local current_file_path = vim.fs.normalize(vim.fn.expand("%:p"))
+    local root_dir_path = rooter_utils.find_root_dir_path(current_file_path)
 
-    -- TODO: Use a more robust method to get root path
-    local root_path = vim.fs.root(current_file_path, ".git")
-
-    if root_path == nil then
-        -- TODO: Obtain root path in another method
-        return
-    end
-
-    if not root_path:match("/$") then
-        root_path = root_path .. "/"
+    if not root_dir_path:match("/$") then
+        root_dir_path = root_dir_path .. "/"
     end
 
-    local relative_path = current_file_path:sub(#root_path + 1)
+    local relative_path = current_file_path:sub(#root_dir_path + 1)
     local current_file_dotted_path = relative_path:gsub("/", "."):gsub(".py$", "")
 
     -- TODO: Check if symbol at cursor is an import alias

lua/copy-python-path/utils/rooter.lua

@@ -0,0 +1,42 @@
+local M = {}
+
+local markers = {
+    -- Version control systems
+    ".git",
+    ".hg",
+    ".svn",
+
+    -- Python specific project markers
+    "pyproject.toml",
+    "setup.py",
+    "setup.cfg",
+    "requirements.txt",
+    "Pipfile",
+    "poetry.lock",
+
+    -- Configuration files often at project root
+    ".python-version",
+    "tox.ini",
+    "pytest.ini",
+    ".flake8",
+    ".isort.cfg",
+    "mypy.ini",
+}
+
+--- Find the absolute path of the Python project's root. Defaults to `path`'s current directory
+--- opened file if failed to locate the root.
+---@param path string The absolute path to search from
+---@return string root_dir_path Normalized absolute path of the project root directory.
+function M.find_root_dir_path(path)
+    local current_dir = vim.fs.dirname(path)
+
+    local marker_path = vim.fs.find(markers, {
+        path = path,
+        upward = true,
+        limit = 1,
+    })[1]
+
+    return marker_path and vim.fs.dirname(marker_path) or current_dir
+end
+
+return M