Merge pull request 'Add globstar filtering' (#6) from add_globstar into main

Reviewed-on: #6

.filedust.conf.example

@@ -2,9 +2,12 @@
 # Place at: ~/.filedust.conf
 #
 # Use this file to customize cleanup behavior.
-# Only keys matter (no values). Paths are relative to $HOME.
 #
-# Patterns (globs) are allowed.
+# Patterns are matched against paths relative to $HOME
+# Supports:
+#   *   = one path segment
+#   **  = zero or more path segments (recursive)
+# Matching is case-sensitive
 
 [exclude]
 # Add directories or patterns you want filedust to ignore.

.gitea/workflows/lint-and-security.yml

@@ -20,7 +20,7 @@ jobs:
         run: pip install pre-commit
 
       - name: Run pre-commit hooks
-        uses: pre-commit/action@v3.0.1
+        run: pre-commit run --all-files --color always
 
       - name: Install pip-audit
         run: pip install pip-audit

README.md

@@ -1,8 +1,6 @@
-[![License](https://img.shields.io/github/license/guardutils/filedust?style=flat)](LICENCE)
+[![Licence](https://img.shields.io/badge/GPL--3.0-orange?label=Licence)](https://git.sysmd.uk/guardutils/filedust/src/branch/main/LICENCE)
-[![Language](https://img.shields.io/github/languages/top/guardutils/filedust.svg)](https://github.com/guardutils/filedust/)
+[![Gitea Release](https://img.shields.io/gitea/v/release/guardutils/filedust?gitea_url=https%3A%2F%2Fgit.sysmd.uk%2F&style=flat&color=orange&logo=gitea)](https://git.sysmd.uk/guardutils/filedust/releases)
-![GitHub Release](https://img.shields.io/github/v/release/guardutils/filedust?display_name=release&logo=github)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-blue?logo=pre-commit&style=flat)](https://git.sysmd.uk/guardutils/filedust/src/branch/main/.pre-commit-config.yaml)
-![PyPI - Version](https://img.shields.io/pypi/v/filedust?logo=pypi)
-[![PyPI downloads](https://img.shields.io/pypi/dm/filedust.svg)](https://pypi.org/project/filedust/)
 
 # filedust
 
@@ -42,6 +40,63 @@ Shows how much disk space can be freed.
 
 ## Installation
 
+### From GuardUtils package repo
+
+This is the preferred method of installation.
+
+### Debian/Ubuntu
+
+#### 1) Import the GPG key
+
+```bash
+sudo mkdir -p /usr/share/keyrings
+curl -fsSL https://repo.sysmd.uk/guardutils/guardutils.gpg | sudo gpg --dearmor -o /usr/share/keyrings/guardutils.gpg
+```
+
+The GPG fingerprint is `0032C71FA6A11EF9567D4434C5C06BD4603C28B1`.
+
+#### 2) Add the APT source
+
+```bash
+echo "deb [arch=amd64 signed-by=/usr/share/keyrings/guardutils.gpg] https://repo.sysmd.uk/guardutils/debian stable main" | sudo tee /etc/apt/sources.list.d/guardutils.list
+```
+
+#### 3) Update and install
+
+```
+sudo apt update
+sudo apt install filedust
+```
+
+### Fedora/RHEL
+
+#### 1) Import the GPG key
+
+```
+sudo rpm --import https://repo.sysmd.uk/guardutils/guardutils.gpg
+```
+
+#### 2) Add the repository configuration
+
+```
+sudo tee /etc/yum.repos.d/guardutils.repo > /dev/null << 'EOF'
+[guardutils]
+name=GuardUtils Repository
+baseurl=https://repo.sysmd.uk/guardutils/rpm/$basearch
+enabled=1
+gpgcheck=1
+repo_gpgcheck=1
+gpgkey=https://repo.sysmd.uk/guardutils/guardutils.gpg
+EOF
+```
+
+#### 4) Update and install
+
+```
+sudo dnf upgrade --refresh
+sudo dnf install filedust
+```
+
 ### From PyPI
 ```
 pip install filedust
@@ -49,7 +104,7 @@ pip install filedust
 
 ### From this repository
 ```
-git clone https://github.com/guardutils/filedust.git
+git clone https://git.sysmd.uk/guardutils/filedust.git
 cd filedust/
 poetry install
 ```
@@ -57,7 +112,7 @@ poetry install
 ### Custom config
 You can download the example and add your custom rule
 ```
-wget -O ~/.filedust.conf https://raw.githubusercontent.com/guardutils/filedust/main/.filedust.conf.example
+wget -O ~/.filedust.conf https://git.sysmd.uk/guardutils/filedust/raw/branch/main/.filedust.conf.example
 ```
 
 ### TAB completion
@@ -69,3 +124,13 @@ And then
 ```
 source ~/.bashrc
 ```
+
+## pre-commit
+This project uses [**pre-commit**](https://pre-commit.com/) to run automatic formatting and security checks before each commit (Black, Bandit, and various safety checks).
+
+To enable it:
+```
+poetry install
+poetry run pre-commit install
+```
+This ensures consistent formatting, catches common issues early, and keeps the codebase clean.

poetry.lock

@@ -555,4 +555,4 @@ test = ["covdefaults (>=2.3)", "coverage (>=7.2.7)", "coverage-enable-subprocess
 [metadata]
 lock-version = "2.0"
 python-versions = ">=3.10,<4.0"
-content-hash = "676393f654b241eb2ea6f983d589e83daff16e0b0ca2cb76228c0cd5ed447591"
+content-hash = "5ffc6940e33919ad5c8107dde30e6203d63a3bb64eaab81013cde2e773964657"

pyproject.toml

@@ -1,18 +1,18 @@
 [tool.poetry]
 name = "filedust"
-version = "0.3.0"
+version = "0.3.1"
 description = "Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)."
 authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
 license = "GPL-3.0-or-later"
 readme = "README.md"
-homepage = "https://github.com/guardutils/filedust"
+homepage = "https://git.sysmd.uk/guardutils/filedust"
-repository = "https://github.com/guardutils/filedust"
+repository = "https://git.sysmd.uk/guardutils/filedust"
 packages = [{ include = "filedust", from = "src" }]
 
 [tool.poetry.dependencies]
 python = ">=3.10,<4.0"
-rich = "^13.0.0"
+rich = ">=12"
-argcomplete = "^3.3.0"
+argcomplete = ">=2"
 
 [tool.poetry.scripts]
 filedust = "filedust.cli:main"

src/filedust/cli.py

@@ -168,7 +168,6 @@ def delete_all(findings: List[Finding]) -> int:
 
 
 def main(argv: list[str] | None = None) -> int:
-    print("Looking for junk ...")
     parser = build_parser()
     args = parser.parse_args(argv)
 
@@ -191,6 +190,8 @@ def main(argv: list[str] | None = None) -> int:
         console.print(f"[red]Error:[/] Path not found: {root}")
         return 1
 
+    print("Looking for junk ...")
+
     if root.resolve() == Path("/"):
         console.print(
             "[yellow]Running filedust on the entire filesystem (/). "

src/filedust/junk.py

@@ -20,6 +20,7 @@ def load_user_rules() -> UserRules:
 
     if cfg_path.exists():
         parser = configparser.ConfigParser(allow_no_value=True)
+        parser.optionxform = str
         parser.read(cfg_path)
 
         if parser.has_section("include"):
@@ -32,8 +33,46 @@ def load_user_rules() -> UserRules:
 
 
 def matches_any(patterns: list[str], relpath: Path) -> bool:
-    posix = relpath.as_posix()
+    """
-    return any(fnmatch(posix, p) for p in patterns)
+    True globstar matcher.
+
+    Rules:
+    - *  matches exactly one path segment
+    - ** matches zero or more segments
+    - Patterns are relative to $HOME
+    """
+
+    path_parts = relpath.parts
+
+    for pat in patterns:
+        pat = pat.strip("/")
+
+        pat_parts = tuple(pat.split("/"))
+
+        if _match_parts(pat_parts, path_parts):
+            return True
+
+    return False
+
+
+def _match_parts(pat: tuple[str, ...], path: tuple[str, ...]) -> bool:
+    """Recursive glob matcher with ** support."""
+    if not pat:
+        return not path
+
+    if pat[0] == "**":
+        # ** matches zero or more segments
+        return _match_parts(pat[1:], path) or (
+            bool(path) and _match_parts(pat, path[1:])
+        )
+
+    if not path:
+        return False
+
+    if fnmatch(path[0], pat[0]):
+        return _match_parts(pat[1:], path[1:])
+
+    return False
 
 
 @dataclass
@@ -148,11 +187,11 @@ def iter_junk(root: Path, rules: UserRules | None = None) -> Iterable[Finding]:
     for dirpath, dirnames, filenames in os.walk(root, followlinks=False):
         dirpath_p = Path(dirpath)
 
-        # Fast relative path computation
+        try:
-        if dirpath == root_str:
+            rel_dir = dirpath_p.resolve().relative_to(HOME)
-            rel_dir = Path(".")
+        except ValueError:
-        else:
+            # Should never happen due to earlier checks
-            rel_dir = Path(dirpath[len(root_str) :].lstrip("/"))
+            continue
 
         # USER EXCLUDE → skip entire subtree
         if matches_any(rules.exclude, rel_dir):