chore: add .editorconfig formatting baseline (template-suite parity)#43
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds a stack-agnostic
.editorconfigtoplatform-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-templateroadmap epic #104 (reconciled as a portfolio-level holistic concern). Both Go-stack siblings ship an.editorconfig;platform-templatehad none:.editorconfiggo-templatedotnet-templateplatform-templategitops-tenant-templateAn
.editorconfiggives 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-templateis 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 kustomizebuilds clean fork8s/clusters/local,k8s/clusters/prod, and thecluster-policiesbase (an.editorconfigis editor-hint metadata; it cannot affect kustomize output).Additive and backward-compatible per the template's conservative-changes convention; template-owned (not in
.templatesyncignore) so instances inherit it.