Feedback Wanted - help test the v3 Release Candidate!

[kehoecj]

We're preparing the v3.0.0 release and want real-world feedback before it goes stable. We want to try it out in your projects, break it, tell us what happened.

Install the RC

go install github.com/Boeing/config-file-validator/v3/cmd/cfv@v3.0.0-rc1

Or download a binary from the release page for macOS, Linux, or Windows.

What's new in v3

• New CLI: cfv check, cfv format, cfv format --fix
• Formatting capabilities with --fix for 9 formats (JSON, JSONC, YAML, TOML, HCL, XML, INI, Properties, ENV)
• Schema validation via SchemaStore auto-lookup
• Gitignore-aware file discovery (--gitignore)
• Known-filename detection (Pipfile, Cargo.lock, tsconfig.json, .clang-format, etc.)
• Sort keys (--sort-keys) for YAML, JSON, JSONC, TOML, Properties, INI

Formatting docs: https://github.com/Boeing/config-file-validator/blob/feat/3.0/website/docs/guides/formatting.md

Try it instead of your usual tools

Run cfv format --diff . on a repo you normally format with prettier, yamlfmt, taplo, or terraform fmt. Compare the output. If cfv produces something different or wrong — that's a potential bug we want to know about.

How to report

• Bug? Open a new issue with the v3-rc label. Include: the command, the file (or minimal reproduction), expected vs. actual. If you'd like to fix it yourself, PRs are welcome — just reference the issue.
• Feature request? Just as valuable. Open an issue describing what you wanted cfv to do that it doesn't.
• Worked fine? Comment here with what you tested and link your repo if it's public.
• Regression from v2? Flag it in the issue title — these are high priority.

[kehoecj]

Thank you to everyone that has contributed issue reports and PR's!

I created several stories to address feature parity with popular formatters. The goal is that projects could drop in the config-file-validator to their project with existing validators with 99.9% feature parity - we're pretty close but there are some gaps. If anyone is interested in working these, I've separated the gaps into discreet issues:

• YAML formatter incorrectly indents comments before sequence items #560
• JSONC formatter should not add trailing commas to files that don't have them #559
• TOML formatter incorrectly indents under table headers #558
• JSON/JSONC formatter should collapse short arrays to one line (printWidth=80) #557
• JSON formatter should not sort keys by default #556
• YAML formatter should normalize scalars to double-quote style by default #580
• JSON/JSONC formatter should strip trailing blank lines before closing braces #581
• YAML formatter should indent sequence items under mapping keys #582
• TOML formatter should insert blank lines between tables #583
• JSON/JSONC formatter should normalize tabs to spaces by default #584
• YAML formatter should add bracketSpacing to flow mappings #585
• TOML formatter should preserve aligned inline comments #586
• TOML formatter should normalize spacing inside inline tables #587
• JSON/JSONC formatter should preserve blank lines between properties #588
• JSONC formatter should add trailing commas to expanded objects and arrays #589

Additionally, to facilitate the transition from existing formatting tools, I'd like to add support for parsing the config files of some of the major formatting tools:

• Auto-detect .editorconfig for formatting defaults #562
• Auto-detect .prettierrc for JSON/JSONC/YAML formatting #563
• Auto-detect taplo.toml for TOML formatting #564
• Auto-detect .yamlfmt for YAML formatting #565