mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-06 19:01:54 +00:00
kevinveenbirkenbachandClaude Opus 4.7
d3afe0bc81
Hard-coded self-path references rot the moment the file moves: a header
comment ``# utils/foo/bar.py`` at the top of a module, a docstring
mentioning ``utils/foo/bar.py``, or a docs entry linking
``utils/foo/bar.py`` from inside ``utils/foo/bar.py`` itself all silently
desync from reality after the next ``git mv``.
The new lint walks every project file, computes its POSIX-style relative
path from PROJECT_ROOT, and reports any line whose text contains that
path as a substring. Files at the repo root (no ``/`` in their relative
path) and setuptools-generated ``*.egg-info/`` artefacts are exempt.
Per-line opt-out via ``# nocheck: self-path-reference`` on the offending
line, registered in the suppression catalog.
Existing offenders cleaned up:
- 72 redundant ``# <self-path>`` header lines removed across roles,
cli, plugins, scripts, tests, and utils.
- 4 prometheus templates that told consumers to "update
<self-template-path>" rewritten to drop the redundant self-reference.
- 8 docstring/comment self-references in cli, plugins, tests, utils,
and the dashboard oidc.js.j2 header rewritten to describe the layout
without naming the file's own path.
- 17 legitimate usage examples (shell scripts, test data lists, one
template self-include doc-block) marked with ``nocheck:
self-path-reference``.
- ``container.sh`` heredoc usage strings switched to ``${0}`` so the
marker stays out of the user-visible help output.
- ``healthcheck/http.yml.j2`` doc-block rewritten to prose because
``{# ... #}`` Jinja comments cannot host an inner ``{# nocheck #}``
(the inner ``#}`` closes the outer comment).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
30 lines
991 B
Python
30 lines
991 B
Python
from __future__ import annotations
|
|
|
|
from utils.roles.entity_name import get_entity_name
|
|
|
|
|
|
def get_docker_paths(application_id: str, path_docker_compose_instances: str) -> dict:
|
|
"""
|
|
Build the compose dict based on path_docker_compose_instances and application_id.
|
|
Uses get_entity_name to extract the entity name from application_id.
|
|
"""
|
|
entity = get_entity_name(application_id)
|
|
base = f"{path_docker_compose_instances}{entity}/"
|
|
|
|
return {
|
|
"directories": {
|
|
"instance": base,
|
|
"env": f"{base}.env/",
|
|
"services": f"{base}services/",
|
|
"volumes": f"{base}volumes/",
|
|
"config": f"{base}config/",
|
|
},
|
|
"files": {
|
|
"env": f"{base}.env/env",
|
|
"compose": f"{base}compose.yml",
|
|
"compose_override": f"{base}compose.override.yml",
|
|
"compose_ca_override": f"{base}compose.ca.override.yml",
|
|
"dockerfile": f"{base}Dockerfile",
|
|
},
|
|
}
|