0 Fork 0

mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2026-11-12 05:36:40 +00:00

Files

T

kevinveenbirkenbachandClaude Fable 5 40e553069d refactor(structure): nest prefix-grouped sibling files into subfolders

Move files that share a delimiter-bounded name prefix within a folder (threshold 2) into a subfolder named after the prefix, dropping the prefix from the filename. Covers plugins/filter (docker, generate, has, merge, get/all), env handler subpackages, utils/roles/entity, utils/tests/swarm/write, role SQL/scripts/templates, keycloak/mailu task-includes, shared tasks/utils/load, and CI scripts. Update every import, query_file/script/include_tasks/src/lookup target, compose bind mount, and python -m path to the new locations.

Extend the prefix-grouped-files lint to threshold 2 with dir-level .nocheck and file-head nocheck opt-outs, and skip groups whose shortest member's stem equals the shared prefix. Keep flat only where a loader forbids nesting: WordPress mu-plugins and the docs/requirements namespace. Ansible filter discovery is recursive, so nested filters stay Jinja-resolvable.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>

2026-07-14 20:00:03 +02:00

handlers

refactor(structure): nest prefix-grouped sibling files into subfolders

2026-07-14 20:00:03 +02:00

__init__.py

refactor(env): move env/default.env to repo-root default.env and drop env/

2026-05-21 16:22:33 +02:00

builder.py

feat(tooling): operator alias, shortcut, skill, cheat and onboard system

2026-07-10 18:43:35 +02:00

loader.py

…

parser.py

refactor(env): move env/default.env to repo-root default.env and drop env/

2026-05-21 16:22:33 +02:00

README.md

refactor(env): move env/default.env to repo-root default.env and drop env/

2026-05-21 16:22:33 +02:00

runtime.py

…

writer.py

refactor(env): move env/default.env to repo-root default.env and drop env/

2026-05-21 16:22:33 +02:00

README.md

utils/env 📐

This directory hosts the Python implementation behind make dotenv. For the general rules that govern READMEs in code directories see documentation.md. For the per-variable defaults that this code consumes see default.env.

Purpose 🎯

The package converts the committed default.env plus a small runtime context into the gitignored .env at the repo root. Every module here belongs to one of four roles: parse, resolve, orchestrate, write.

Structure 🗂️

File	Role
`parser.py`	Read default.env into `(values, comments)` tuples.
`runtime.py`	Resolve host-context lookups (disk, RAM, hostname, GHA/Act flags, `/proc/version`, helper-script invocation).
`builder.py`	Thin orchestrator that defines `EnvBuilder`, `BuildContext`, and `build_env()`. Walks the handler registry.
`writer.py`	Serialise an `EnvBuilder` into a docker-compose-compatible `.env` on disk.
`handlers/`	One module per dynamically-computed variable. See handlers README.

The CLI entry point lives at __main__.py under cli/meta/env/. Shell consumers source load.sh under scripts/meta/env/.

File Naming 🏷️

Module names MUST stay lowercase snake_case.
Pure passthrough or simple parser/writer helpers MUST live directly under utils/env/.
Per-variable computation MUST live under handlers/ (see handlers README for the naming convention used there).
Test files live in tests/unit/utils/env/ and mirror the module name with a test_ prefix.

Import Rules 🔗

parser.py, runtime.py, and writer.py MUST NOT import from builder.py or handlers/.
builder.py MUST NOT import individual handler modules; it MUST go through the ORDERED_HANDLERS list exposed by handlers/__init__.py.
Handler modules MUST NOT import each other (see handlers README).