Skip to content

chore: drop redundant @config annotations#17

Merged
erikfrerejean merged 1 commit into
6from
chore/drop-redundant-config-annotations
Jun 22, 2026
Merged

chore: drop redundant @config annotations#17
erikfrerejean merged 1 commit into
6from
chore/drop-redundant-config-annotations

Conversation

@erikfrerejean

Copy link
Copy Markdown
Member

What

Removes all /** @config */ docblock annotations from Menu and MenuItem (14 in total).

Why

The dev QA chain now uses cambis/silverstan, which natively recognises SilverStripe configuration properties as always read and written. The sole purpose of /** @config */ was to stop static analysis flagging these private static config statics as unused/write-only — silverstan does this automatically, so the annotations are now pure noise.

The properties already carry native scalar/array types (string, array, bool), so the @config docblocks contributed nothing to type coverage; removing them leaves property_type: 100 intact.

Verification

  • make analyse (silverstan, level max, 100% type coverage) → No errors

Note (out of scope)

make rector-dry reports a finding from AddSeeTestAnnotationRector (wants @see ...Test class annotations). This is pre-existing on 6 — it reproduces on a clean checkout without these changes — and is unrelated to the @config cleanup. Left for a separate PR.

Silverstan natively recognises SilverStripe config properties as always
read and written, so the /** @config */ docblocks no longer suppress any
analysis. The properties already carry native scalar/array types, so type
coverage is unaffected. Verified with `make analyse` (silverstan level
max): no errors.
@erikfrerejean erikfrerejean merged commit 9ab9da2 into 6 Jun 22, 2026
3 of 4 checks passed
@erikfrerejean erikfrerejean deleted the chore/drop-redundant-config-annotations branch June 22, 2026 13:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant