Danny Mösch
a809480d4a
* Add instructions for rule registration * Add setup steps for coding agent using Bazel * Make callable workflow so that its environment also applies to subsequent steps
1.5 KiB
You are working on SwiftLint, a linter for Swift code that enforces coding style and conventions. It helps maintain a clean and consistent codebase by identifying and reporting issues in Swift files. It can even automatically fix some of these issues.
Linting rules are defined in Source/SwiftLintBuiltInRules/Rules. If someone mentions a rule by its identifier that is in "snake_case" (e.g., rule_name), you can usually find the rule's implementation file named "UpperCamelCaseRule.swift" (e.g., <RuleName>Rule.swift) in one of the sub-folders depending on the rule's kind. Specific configurations for rules are located in the RuleConfigurations folder, which contains files named as <RuleName>Configuration.swift (e.g., IdentifierNameConfiguration.swift).
User-facing changes must be documented in the CHANGELOG.md file, which is organized by version. New entries always go into the "Main" section. They give credit to the person who has made the change and they reference the issue which has been fixed by the change.
All changes on configuration options must be reflected in Tests/IntegrationTests/default_rule_configurations.yml. This can be achieved by running make --always-make bazel_register. Running this command is also necessary when new rules got added or removed to (un-)register them from/in the list of built-in rules and tests verifying all examples in rule descriptions.
All changes need to pass make bazel_test as well as running SwiftLint on itself. The command bazel run //:swiftlint run in the root directory of the project does that.