Skip to content

chore: add .editorconfig formatting baseline (template-suite parity)#43

Merged
devantler merged 1 commit into
mainfrom
claude/template-editorconfig-parity
Jun 24, 2026
Merged

chore: add .editorconfig formatting baseline (template-suite parity)#43
devantler merged 1 commit into
mainfrom
claude/template-editorconfig-parity

Conversation

@devantler

Copy link
Copy Markdown
Contributor

🤖 Generated by the Daily AI Assistant

What

Adds a stack-agnostic .editorconfig to platform-template, and brings two sample manifests that lacked a final newline into conformance with it.

Why

Template-suite parity is the lone open theme of the go-template roadmap epic #104 (reconciled as a portfolio-level holistic concern). Both Go-stack siblings ship an .editorconfig; platform-template had none:

Template .editorconfig
go-template
dotnet-template
platform-template ❌ → ✅ (this PR)
gitops-tenant-template ❌ (held — KRO redesign in flux)

An .editorconfig gives everyone who clones the template a consistent formatting baseline (charset, EOL, final newline, trailing-whitespace, indent) regardless of editor — and via template-sync it propagates the baseline to every instance.

Design

platform-template is YAML / Markdown / JSON only (356 yaml + 33 md + 2 json; no Makefiles, shell, Go, or C#), so a 2-space space-indent default fits every file. The config mirrors the common base of the two siblings (charset=utf-8, end_of_line=lf, insert_final_newline, trim_trailing_whitespace) rather than introducing novel rules, keeping the suite consistent.

The repo already conformed almost completely — 0 trailing-whitespace files, 0 CRLF — so the only file changes needed were a final newline on two sample policy manifests (add-ns-quota, spread-pods-across-topology).

Validation

  • kubectl kustomize builds clean for k8s/clusters/local, k8s/clusters/prod, and the cluster-policies base (an .editorconfig is editor-hint metadata; it cannot affect kustomize output).
  • Re-scanned: 0 files missing a final newline, 0 trailing-whitespace, 0 CRLF after the change.

Additive and backward-compatible per the template's conservative-changes convention; template-owned (not in .templatesyncignore) so instances inherit it.

Adds a stack-agnostic .editorconfig mirroring the common base of the go-template and dotnet-template siblings, closing a template-suite parity gap (go-template #104 theme 3). platform-template is YAML/Markdown/JSON only, so a 2-space space-indent default fits every file. Also brings the two sample manifests that lacked a final newline into conformance with the new insert_final_newline rule.
@devantler devantler marked this pull request as ready for review June 24, 2026 17:24
@devantler devantler requested a review from a team as a code owner June 24, 2026 17:24
@devantler devantler merged commit 933e92d into main Jun 24, 2026
11 checks passed
@devantler devantler deleted the claude/template-editorconfig-parity branch June 24, 2026 17:24
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