mirror of
https://github.com/kuhyx/testsAndMisc.git
synced 2026-11-14 11:50:52 +01:00
Krzysztof kuhy Rudnicki
4f2b0ccdf7
Two levels of pure taxonomy carrying no information, and a 2-directory
cap leaves no room for them. Categories now sit directly under
linux_configuration/: features, fixes, utils, misc, fresh-install,
installers, diagnostics, gaming, boot_recovery, periodic_background, lib,
meta, tests. A script's own lib/ and tests/ are exempt from the cap, so
those stay put.
Depth violations 248 -> 139; roughly 40 of the remainder are inside
digital_wellbeing and hosts, deferred until the guard-lib repoint.
The moves are the easy half. What breaks is every path that counted
levels, and three classes of it had to be found by resolving paths rather
than reading diffs:
- 52 relative `source` lines for lib/common.sh and lib/android.sh. The
correct prefix differs per file: 40 were ../../ and 12 were ../../../,
so a blanket replace would have fixed one set and broken the other.
- REPO_ROOT in 7 fixes/lib/tests harnesses and setup_syncyomi_guard.sh,
each walking up four levels from a directory now two levels shallower.
This caused a real regression -- the fixes suite went red with
"log_warn: command not found" -- caught by running it and comparing
against the pre-move baseline worktree.
- conftest.py's sys.path entries, which took the pytest gate down with
14 collection errors, and the `# shellcheck source=` directives, which
took shellcheck down with SC1091.
16 symlinks in $HOME broke, including the entire i3blocks bar. All
repointed, and cpu_monitor/memory/disk/time/volume were run to confirm
they emit real output rather than merely resolving.
Verified: 1798 tests pass at 100% coverage, 8 of 9 lib/tests suites pass
(the ninth needs the coverage jail, identically at baseline), pre-commit
is clean, and the two untracked secret configs are still ignored after
their gitignore paths changed.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PJrqKERAo5QUeEHWS5Asgp
154 lines
7.3 KiB
Markdown
154 lines
7.3 KiB
Markdown
# testsAndMisc
|
|
|
|
Mixed-language monorepo: Python packages, Bash automation, and several apps.
|
|
|
|
## Repository Layout
|
|
|
|
| Path | Description |
|
|
| ---------------------- | --------------------------------------------------------------------------------------------------------- |
|
|
| `python_pkg/` | Python packages — every `.py` in the repo belongs here or in an allowlisted dir |
|
|
| `meta/` | Repo-wide tooling: `pyproject.toml`, `requirements.txt`, `run.sh`, `lint_python.sh`, `.fvmrc`, `scripts/` |
|
|
| `linux_configuration/` | Arch setup, i3 config, system maintenance, and the tracked git hooks |
|
|
| `bottles/` | Small standalone project |
|
|
| `docs/` | Reference docs; `docs/superpowers/` holds AI workflow artifacts |
|
|
| `third_party/` | Vendored upstream skills/agents |
|
|
|
|
Root `pyproject.toml`, `requirements.txt`, `run.sh`, `lint_python.sh` and
|
|
`.fvmrc` are **symlinks into `meta/`** — edit the files in `meta/`, not the
|
|
symlinks.
|
|
|
|
`linux_configuration/` has no `scripts/` or `single_use/` level: those two were
|
|
pure taxonomy carrying no information, and the directory-depth cap does not
|
|
leave room for them. Categories sit directly under it — `features/`, `fixes/`,
|
|
`utils/`, `misc/`, `fresh-install/`, `installers/`, `diagnostics/`, `gaming/`,
|
|
`boot_recovery/`, `periodic_background/`, `lib/`, `meta/`, `tests/`. A script's
|
|
own `lib/` and `tests/` subdirectories are exempt from the cap, so those stay
|
|
where they are.
|
|
|
|
Extracted to their own repos: [`steam-backlog-enforcer`](https://github.com/kuhyx/steam-backlog-enforcer),
|
|
[`screen-locker`](https://github.com/kuhyx/screen-locker),
|
|
[`diet-guard`](https://github.com/kuhyx/diet-guard),
|
|
[`wake-alarm`](https://github.com/kuhyx/wake-alarm),
|
|
[`dufs-cloud`](https://github.com/kuhyx/dufs-cloud),
|
|
[`build-your-x`](https://github.com/kuhyx/build-your-x) (lives at `~/build_your_x`),
|
|
[`reverse-survivors`](https://github.com/kuhyx/reverse-survivors),
|
|
[`kcd2-dice-solver`](https://github.com/kuhyx/kcd2-dice-solver) (lives at `~/kcd2-dice-solver`),
|
|
[`focus-owner`](https://github.com/kuhyx/focus-owner),
|
|
[`mtk-root`](https://github.com/kuhyx/mtk-root),
|
|
[`system-maintenance`](https://github.com/kuhyx/system-maintenance) (lives at
|
|
`~/system-maintenance`),
|
|
[`android-guardian`](https://github.com/kuhyx/android-guardian) (lives at
|
|
`~/android-guardian`),
|
|
[`phone-focus-mode`](https://github.com/kuhyx/phone-focus-mode) (with
|
|
`python_pkg/focus_policy`).
|
|
Archived work: [`testsAndMisc-archive`](https://github.com/kuhyx/testsAndMisc-archive).
|
|
|
|
## Adding a Flutter app
|
|
|
|
There is currently no Flutter app here — `billsplit/` was archived, and with it
|
|
the only committed binaries. Adding one means repeating **both** halves or the
|
|
icons fail silently:
|
|
|
|
1. Add the icon globs to `.binary-allowlist`.
|
|
2. Add matching `!` overrides at the end of `.gitignore` — an ignored file
|
|
fails silently on `git add` rather than erroring.
|
|
|
|
Icons come from the shared generator in `python_pkg/app_icons/`. Dart style
|
|
needs its own CI workflow; there is no local hook for it. Keep app dirs free of
|
|
Python: the `check-python-location` hook requires every `.py` to sit under
|
|
`python_pkg/` (or `linux_configuration/`, `meta/scripts/`), so an app's coverage
|
|
gate lives in `python_pkg/`.
|
|
|
|
## Git Workflow
|
|
|
|
Work directly on `main`; commit and push straight there.
|
|
|
|
`core.hooksPath` points at the tracked `linux_configuration/.githooks/`, so
|
|
hooks travel with the repo. `.git/hooks/` is unused — **never run
|
|
`pre-commit install`**.
|
|
|
|
- **pre-commit**: shfmt + shellcheck + jscpd (fails above 2% duplication),
|
|
then `pre-commit run --hook-stage pre-commit`.
|
|
- **pre-push**: `pre-commit run --hook-stage pre-push` — `prettier` and
|
|
`ci-mirror`. `ci-mirror` runs a clean-venv install, `pre-commit run` over all
|
|
files, and pytest for changed packages.
|
|
|
|
Bootstrap a clone or new machine:
|
|
|
|
```bash
|
|
./meta/scripts/install_hooks.sh # wire hooks + install missing tools
|
|
./meta/scripts/install_hooks.sh --check # verify only; exit 1 if incomplete
|
|
```
|
|
|
|
Both hooks fail closed: every external binary is verified each run and
|
|
auto-installed via pacman where possible. A missing tool aborts the commit —
|
|
it never means "skip the check". Extend `REQUIRED_TOOLS` in
|
|
`linux_configuration/.githooks/lib/common.sh` when adding a `language: system`
|
|
hook. `common.sh` also warns when local shellcheck/prettier/shfmt/zsh drift
|
|
from the versions pinned in `.github/workflows/pre-commit.yml`.
|
|
|
|
## Development Workflow
|
|
|
|
- Do NOT run tests unless instructed, or before committing.
|
|
- If tests fail on the same issue twice in a row, STOP and ask.
|
|
- Confirm a change works by **running the program** and inspecting output —
|
|
not by running tests. Then ask the user to confirm the behaviour.
|
|
- Fix coverage gaps; do not ignore them.
|
|
|
|
### AI evidence (enforced)
|
|
|
|
Every commit touching code needs an evidence artifact:
|
|
|
|
1. Copy `docs/superpowers/evidence/template.json` →
|
|
`docs/superpowers/evidence/<task-slug>-<date>.json`.
|
|
2. Fill in intent, scope, changes, verification, risks, rollback.
|
|
3. Stage it with the code.
|
|
|
|
`validate_evidence.py` rejects empty `verification[]` and the phrases
|
|
"should work", "probably fine", "seems right".
|
|
|
|
**Staging ≥4 code files additionally requires a fresh
|
|
`docs/superpowers/contracts/*.json`** in the same commit.
|
|
|
|
Deletions in `docs/superpowers/sessions/*` abort the commit (append-only).
|
|
|
|
## Code Conventions
|
|
|
|
Anything already enforced by a hook is omitted here — run
|
|
`pre-commit run --all-files` and read `.pre-commit-config.yaml` for the
|
|
complete list. What follows is what a linter cannot check.
|
|
|
|
### Python
|
|
|
|
- `from __future__ import annotations` for forward references.
|
|
- Prefix private functions/modules with `_` (`_smart_plug.py`,
|
|
`_process_game_event`).
|
|
- Mock external calls in tests; never hit real APIs or the filesystem.
|
|
- For branch coverage: prefer an explicit `while True` with
|
|
`try`/`except StopIteration` over `for` when iterator exhaustion needs
|
|
covering, and mock threads/subprocesses to keep tests fast.
|
|
|
|
Full linting/coverage configuration lives in `meta/pyproject.toml`
|
|
(ruff `select = ["ALL"]`, mypy, pylint `enable = "all"`, coverage
|
|
`fail_under = 100` with branch coverage). Note the mypy **hook** disables a
|
|
number of error codes, so it is weaker than the `strict = true` in the config.
|
|
|
|
### Shell
|
|
|
|
- `set -euo pipefail` in every script.
|
|
- Prefer `/proc`, `/sys` and bash builtins over `$(...)` in hot paths — see
|
|
the `efficient-polling-scripts` skill. The `no-polling-antipatterns` hook
|
|
only inspects functions named `*_loop`, `*_daemon` or `poll*`, so a fork
|
|
storm elsewhere passes clean.
|
|
- Use `jq`/`yq` for JSON/YAML, not `grep`/`awk`.
|
|
|
|
## Key Files
|
|
|
|
- `meta/pyproject.toml` — all Python tool configs
|
|
- `.pre-commit-config.yaml` — hook definitions
|
|
- `linux_configuration/.githooks/` — the tracked git hooks
|
|
- `meta/requirements.txt` — runtime + dev dependencies
|
|
- `docs/superpowers/evidence/template.json` — evidence template
|
|
- `.github/workflows/` — `pre-commit`, `python-tests`, `shell-tests`, and one
|
|
CI workflow per app
|