repomatic.lint_repo.tool_config module

Checks of the tool configurations repomatic init writes into pyproject.toml.

A section init seeds once and never revisits misses the knobs its template gains later. A section synced on every run can keep a bare entry beside the anchored form that replaced it.

repomatic.lint_repo.tool_config.missing_template_entries(template, local, prefix='')

Yield the dotted paths a seeded tool section does not carry.

Absence is the only thing reported. A scalar the repository tuned is its own answer, a key it added is none of the template’s business, and a comment it rewrote is invisible here: all three are what BOOTSTRAP hands over on the first write. What that contract cannot express is a knob the template gained afterwards, which reaches nobody because init never revisits the section.

A list is compared by membership, not by equality. An ignore list or a select list grows one entry at a time and its order carries no meaning, so equality would report every local addition as drift.

Parameters:

• template (Mapping[str, Any]) – The bundled template, parsed.

• local (Mapping[str, Any]) – The repository’s own section, parsed.

• prefix (str) – Dotted path of the table being walked, for recursion.

Return type:

Iterator[tuple[str, str | None]]

Returns:

(path, None) per missing key, (path, member) per missing list member, named by template_member_name().

repomatic.lint_repo.tool_config.template_member_name(member)

Name one member of a template list the way a lint-repo line reads it.

A scalar is its own name. A table has no text of its own, so its name is the inline table that writes it, like { fruit = "apple", ripe = true }. That is the text a maintainer copies into the section, or quotes as the key of a declined entry.

Parameters:

member (object) – One item of a list held by a bundled template.

Return type:

str

Returns:

The member as text, or as inline TOML when it is a table.

repomatic.lint_repo.tool_config.check_bootstrap_config_drift(ctx)

Report bundled knobs a seeded tool section never received.

init writes the template of a BOOTSTRAP component once and hands the section over, so the repository owns every value from then on. That is deliberate, and this check does not argue with it. The gap it closes is narrower: a template that gains a knob after the seeding has no route into the repository and nothing that mentions the difference, so the section silently stops being the configuration repomatic ships.

Advisory, and deliberately so. A repository may have dropped a template rule on purpose, and only its maintainer can tell that from a section left behind.

The maintainer records that answer in declined. A declined entry is reported as skipped, with its reason: the decision stays in the report and the warning stops. The record is checked like the section it speaks for. An entry that declines nothing is reported, since the next gap at its path would otherwise arrive already declined.

A section keeping its keys in the component’s legacy_table is measured there, and the finding names that sub-table. An entry is declined at its path below the tool either way, without the sub-table.

Return type:

Iterator[CheckResult]

Returns:

One result per declined entry and one per adopted BOOTSTRAP section, then one per recorded entry that declines nothing.

repomatic.lint_repo.tool_config.anchored_exclude_core(pattern)

Return the bare host pattern an anchored exclude entry supersedes.

^https://(www\.)?x\.com(/.*)?$ answers x\.com. Anything else answers None: an entry not anchored on both ends replaced no bare form, and one carrying a path between the host and the closing anchor (^https://www\.npmjs\.com/package/.*$) has no bare form that was ever bundled on its own.

Parameters:

pattern (str) – One [tool.lychee] exclude entry.

Return type:

str | None

Returns:

The unanchored host pattern, or None when there is none.

repomatic.lint_repo.tool_config.check_superseded_local_excludes(ctx)

Report a local exclude entry the bundled template has since anchored.

An ongoing sync rebuilds a section from its template and grafts local-only content back on, and for an array the graft is a union by value: an item the template does not carry is appended after the ones it does. That is what keeps a repository’s own entries alive across a sync, and it has no inverse. When the template replaces an entry instead of adding one, the old form becomes local-only by the next sync, so it is grafted back beside its own replacement and nothing ever retires it.

Anchoring a bare host pattern is exactly that replacement, and the stale copy is not inert: lychee reads these entries as substring matches, so a bare x\.com kept beside ^https://(www\.)?x\.com(/.*)?$ goes on excluding every domain ending in x.com, cloudlinux.com among them, which is what the anchored form was written to stop doing.

The fix depends on what sits beside the stale entry. Where the anchored form is present, dropping the bare one is the whole fix. A section no sync reaches holds the bare form alone: lychee is an awesome-only component, so another repository keeps a copy nothing rebuilds unless [tool.repomatic] include opts it in. Dropping the entry there would stop excluding the host itself, so the result names the anchored form to write in its place.

Advisory. Only the maintainer can separate a bare entry the template superseded from one the repository narrowed on purpose.

Note

The test is deliberately narrow: it recognises the anchored/bare pair by string equality against the head and tail above, so it catches a template that anchored a host pattern and nothing else. A local entry broadened in some other way is not reported. Widening it means inverting a regex to compare match sets, which is not worth a dependency for one signature that already reached every repository the bundled lychee.toml deploys to.

Return type:

Iterator[CheckResult]

Returns:

One result per synced tool config holding exclude patterns.