Add a `validate` .swiftlint.yml command
Nobody has claimed this yet.
- Dominant language
- Swift
- Stars
- 19.7k
- Forks
- 2.3k
- Avg merge
- 1d 1h
- Merged PRs (30d)
- 11
Description
New Issue Checklist
- I've Updated SwiftLint to the latest version.
- I've searched for existing GitHub issues.
Feature or Enhancement Proposal
I cannot determine a way to validate if the .swiftlint.yml file is correct. The existing commands do output an error if the parsing fails, but then they fallback to the default configuration.
It would be great to have a command that only parses the yaml file for correctness to help protect this flow from breaking but technically still running the lint checks.
Renovate, for example, has renovate-config-validator, which allows you to fail a pull request if the config change being made breaks anything.
Alternative option:
Provide a flag that means it will not revert to defaults in the event of a parsing error and exit the CLI with a non-zero exit code.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by examining how existing SwiftLint commands parse .swiftlint.yml and handle configuration errors. Compare the proposed validate-only command with the alternative flag, then verify that malformed YAML produces a non-zero exit without falling back to the default configuration.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- swift
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100