Compare commits
11 Commits
fca4c8defc
...
main
| Author | SHA1 | Date | |
|---|---|---|---|
| e36228c308 | |||
|
c016a45b82
|
|||
| 860e8a668f | |||
|
5e9a55dcc6
|
|||
|
7daa2175e8
|
|||
|
67a6af2ddb
|
|||
| 25ea1fec63 | |||
|
dc66700f1e
|
|||
| 1eb082fc52 | |||
|
c2f52b8049
|
|||
|
6ebef8e058
|
@@ -2,9 +2,12 @@
|
|||||||
# Place at: ~/.filedust.conf
|
# Place at: ~/.filedust.conf
|
||||||
#
|
#
|
||||||
# Use this file to customize cleanup behavior.
|
# 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]
|
[exclude]
|
||||||
# Add directories or patterns you want filedust to ignore.
|
# Add directories or patterns you want filedust to ignore.
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ jobs:
|
|||||||
run: pip install pre-commit
|
run: pip install pre-commit
|
||||||
|
|
||||||
- name: Run pre-commit hooks
|
- name: Run pre-commit hooks
|
||||||
uses: pre-commit/action@v3.0.1
|
run: pre-commit run --all-files --color always
|
||||||
|
|
||||||
- name: Install pip-audit
|
- name: Install pip-audit
|
||||||
run: pip install pip-audit
|
run: pip install pip-audit
|
||||||
79
README.md
79
README.md
@@ -1,8 +1,6 @@
|
|||||||
[](LICENCE)
|
[](https://git.sysmd.uk/guardutils/filedust/src/branch/main/LICENCE)
|
||||||
[](https://github.com/guardutils/filedust/)
|
[](https://git.sysmd.uk/guardutils/filedust/releases)
|
||||||
[](https://github.com/guardutils/filedust/releases)
|
[](https://git.sysmd.uk/guardutils/filedust/src/branch/main/.pre-commit-config.yaml)
|
||||||
[](https://pypi.org/project/filedust/#history)
|
|
||||||
[](https://pypi.org/project/filedust/)
|
|
||||||
|
|
||||||
# filedust
|
# filedust
|
||||||
|
|
||||||
@@ -42,6 +40,63 @@ Shows how much disk space can be freed.
|
|||||||
|
|
||||||
## Installation
|
## 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
|
### From PyPI
|
||||||
```
|
```
|
||||||
pip install filedust
|
pip install filedust
|
||||||
@@ -49,7 +104,7 @@ pip install filedust
|
|||||||
|
|
||||||
### From this repository
|
### From this repository
|
||||||
```
|
```
|
||||||
git clone https://github.com/guardutils/filedust.git
|
git clone https://git.sysmd.uk/guardutils/filedust.git
|
||||||
cd filedust/
|
cd filedust/
|
||||||
poetry install
|
poetry install
|
||||||
```
|
```
|
||||||
@@ -57,7 +112,7 @@ poetry install
|
|||||||
### Custom config
|
### Custom config
|
||||||
You can download the example and add your custom rule
|
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
|
### TAB completion
|
||||||
@@ -69,3 +124,13 @@ And then
|
|||||||
```
|
```
|
||||||
source ~/.bashrc
|
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.
|
||||||
|
|||||||
@@ -1,12 +1,12 @@
|
|||||||
[tool.poetry]
|
[tool.poetry]
|
||||||
name = "filedust"
|
name = "filedust"
|
||||||
version = "0.3.1"
|
version = "0.4.0"
|
||||||
description = "Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)."
|
description = "Opinionated junk cleaner for dev machines (caches, build artifacts, editor backups)."
|
||||||
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
authors = ["Marco D'Aleo <marco@marcodaleo.com>"]
|
||||||
license = "GPL-3.0-or-later"
|
license = "GPL-3.0-or-later"
|
||||||
readme = "README.md"
|
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" }]
|
packages = [{ include = "filedust", from = "src" }]
|
||||||
|
|
||||||
[tool.poetry.dependencies]
|
[tool.poetry.dependencies]
|
||||||
|
|||||||
@@ -20,6 +20,7 @@ def load_user_rules() -> UserRules:
|
|||||||
|
|
||||||
if cfg_path.exists():
|
if cfg_path.exists():
|
||||||
parser = configparser.ConfigParser(allow_no_value=True)
|
parser = configparser.ConfigParser(allow_no_value=True)
|
||||||
|
parser.optionxform = str
|
||||||
parser.read(cfg_path)
|
parser.read(cfg_path)
|
||||||
|
|
||||||
if parser.has_section("include"):
|
if parser.has_section("include"):
|
||||||
@@ -32,8 +33,46 @@ def load_user_rules() -> UserRules:
|
|||||||
|
|
||||||
|
|
||||||
def matches_any(patterns: list[str], relpath: Path) -> bool:
|
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
|
@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):
|
for dirpath, dirnames, filenames in os.walk(root, followlinks=False):
|
||||||
dirpath_p = Path(dirpath)
|
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
|
# USER EXCLUDE → skip entire subtree
|
||||||
if matches_any(rules.exclude, rel_dir):
|
if matches_any(rules.exclude, rel_dir):
|
||||||
|
|||||||
Reference in New Issue
Block a user