Xcode project linting
This project is still pretty young, and has rough edges. However, it kinda works! So, please do give it a shot.
XCLint is available as both a commandline tool and a library.
Tool:
brew tap mattmassicotte/XCLint https://github.com/mattmassicotte/XCLint.git
brew install xclint
Package:
dependencies: [
.package(url: "https://github.com/mattmassicotte/XCLint", branch: "main")
],
targets: [
.testTarget(name: "MyTarget", dependencies: ["XCLinting"]),
]Just run the xclint binary in your project directory. Check out its -h flag for more usage.
# cd my/project
# xclint
This will run a default set of rules. But, you can customize its behavior with a .xclint.yml file. The basic structure borrows a lot from SwiftLint.
# Some rules may not be appropriate for all projects. You must opt-in those.
opt_in_rules:
- embedded_build_setting # checks for build settings in the project file
- groups_sorted # checks that all group contents are alphabetically sorted
- implicit_dependencies # checks for any schemes that have "Find Implicit Dependencies" enabled
- targets_use_xcconfig # checks for any targets without a XCConfig file set
- projects_use_xcconfig # checks for any projects without a XCConfig file set
- shared_scheme_skips_tests # checks for any shared schemes that have disabled tests
- shared_schemes # checks that all targets have a shared scheme present
# Other rules make sense for all projects by default. You must opt-out of those.
disabled_rules:
- build_files_ordered # checks that the ordering of techincally-unordered collections Xcode writes out is preserved
- validate_build_settings # checks that build settings have valid values
- relative_paths # checks for any absolute file referencesI was kind of hoping that some else had built something like this. And they have! However, none of the things I found are maintained any more.
I'd love to hear from you! Get in touch via mastodon, an issue, or a pull request.
I prefer collaboration, and would love to find ways to work together if you have a similar project.
I prefer indentation with tabs for improved accessibility. But, I'd rather you use the system you want and make a PR than hesitate because of whitespace.
By participating in this project you agree to abide by the Contributor Code of Conduct.