Skip to content

Latest commit

 

History

History
185 lines (144 loc) · 7.9 KB

CONTRIBUTING.md

File metadata and controls

185 lines (144 loc) · 7.9 KB
Raw

Pull Requests

All changes, no matter how trivial, must be done via pull request. Commits should never be made directly on the main branch. Prefer rebasing over merging main into your PR branch to update it and resolve conflicts.

If you have commit access to SwiftLint and believe your change to be trivial and not worth waiting for review, you may open a pull request and merge immediately, but this should be the exception, not the norm.

Building And Running Locally

Using Xcode

  1. git clone https://github.com/realm/SwiftLint.git
  2. cd SwiftLint
  3. xed .
  4. Select the "swiftlint" scheme
  5. cmd-opt-r open the scheme options
  6. Set the "Arguments Passed On Launch" you want in the "Arguments" tab. See available arguments in the README.
  7. Set the "Working Directory" in the "Options" tab to the path where you would like to execute SwiftLint. A folder that contains swift source files.
  8. Hit "Run"
Arguments Options
image image

Then you can use the full power of Xcode/LLDB/Instruments to develop and debug your changes to SwiftLint.

Using the command line

  1. git clone https://github.com/realm/SwiftLint.git
  2. cd SwiftLint
  3. swift build [-c release]
  4. Use the produced swiftlint binary from the command line, either by running swift run [-c release] [swiftlint] [arguments] or by invoking the binary directly at .build/[release|debug]/swiftlint
  5. [Optional] Attach LLDB: lldb -- .build/[release|debug]/swiftlint [arguments]

Code Generation

If XCTest cases or functions are added/removed/renamed, or if rules are added/removed/renamed, you'll need to run make sourcery, which requires that Sourcery be installed on your machine. This will update source files to reflect these changes.

Tests

SwiftLint supports building via Xcode and Swift Package Manager on macOS, and with Swift Package Manager on Linux. When contributing code changes, please ensure that all three supported build methods continue to work and pass tests.

$ xcodebuild -scheme swiftlint test
$ swift test
$ make docker_test

Rules

New rules should be added in the Source/SwiftLintFramework/Rules directory.

Rules should conform to either the Rule or ASTRule protocols.

All new rules or changes to existing rules should be accompanied by unit tests.

Whenever possible, prefer adding tests via the triggeringExamples and nonTriggeringExamples properties of a rule's description rather than adding those test cases in the unit tests directly. This makes it easier to understand what rules do by reading their source, and simplifies adding more test cases over time. This way adding a unit test for your new Rule is just a matter of adding a test case in RulesTests.swift which simply calls verifyRule(YourNewRule.description).

For debugging purposes examples can be marked as focused. If there are any focused examples found, then only those will be run when running tests for that rule.

nonTriggeringExamples: [
    Example("let x: [Int]"),
    Example("let x: [Int: String]").focused()   // only this one will be run in tests
],
triggeringExamples: [
    Example("let x: ↓Array<String>"),
    Example("let x: ↓Dictionary<Int, String>")
]

ConfigurationProviderRule

If your rule supports user-configurable options via .swiftlint.yml, you can accomplish this by conforming to ConfigurationProviderRule. You must provide a configuration object via the configuration property:

  • The object provided must conform to RuleConfiguration.
  • There are several provided RuleConfigurations that cover the common patterns like configuring violation severity, violation severity levels, and evaluating names.
  • If none of the provided RuleConfigurations are applicable, you can create one specifically for your rule.

See ForceCastRule for a rule that allows severity configuration, FileLengthRule for a rule that has multiple severity levels, IdentifierNameRule for a rule that allows name evaluation configuration:

force_cast: warning

file_length:
  warning: 800
  error: 1200

identifier_name:
  min_length:
    warning: 3
    error: 2
  max_length: 20
  excluded: id

If your rule is configurable, but does not fit the pattern of ConfigurationProviderRule, you can conform directly to Rule:

  • init(configuration: AnyObject) throws will be passed the result of parsing the value from .swiftlint.yml associated with your rule's identifier as a key (if present).
  • configuration may be of any type supported by YAML (e.g. Int, String, Array, Dictionary, etc.).
  • This initializer must throw if it does not understand the configuration, or it cannot be fully initialized with the configuration and default values.
  • By convention, a failing initializer throws ConfigurationError.UnknownConfiguration.
  • If this initializer fails, your rule will be initialized with its default values by calling init().

Tracking changes

All changes should be made via pull requests on GitHub.

When issuing a pull request with user-facing changes, please add a summary of your changes to the CHANGELOG.md file.

We follow the same syntax as CocoaPods' CHANGELOG.md:

  1. One Markdown unnumbered list item describing the change.
  2. 2 trailing spaces on the last line describing the change (so that Markdown renders each change on its own line).
  3. A list of Markdown hyperlinks to the contributors to the change. One entry per line. Usually just one.
  4. A list of Markdown hyperlinks to the issues the change addresses. One entry per line. Usually just one. If there was no issue tracking this change, you may instead link to the change's pull request.
  5. All CHANGELOG.md content is hard-wrapped at 80 characters.

CI

SwiftLint uses Azure Pipelines for most of its CI jobs, primarily because they're the only CI provider to have a free tier with 10x concurrency on macOS.

Some CI jobs run in GitHub Actions (e.g. Docker).

Some CI jobs run on Buildkite using Mac Minis from MacStadium. These are jobs that benefit from being run on the latest Xcode & macOS versions on bare metal.

Buildkite Setup

To bring up a new Buildkite worker from MacStadium:

  1. Change account password
  2. Update macOS to the latest version
  3. Install Homebrew: https://brew.sh
  4. Install Buildkite agent and other tools via Homebrew: brew install buildkite/buildkite/buildkite-agent aria2 htop
  5. Install the xcodes CLI by downloading the zip and moving it to /usr/local/bin: https://github.com/RobotsAndPencils/xcodes/releases
  6. Install latest Xcode version: xcodes install --latest
  7. Add DANGER_GITHUB_API_TOKEN to /opt/homebrew/etc/buildkite-agent/hooks/environment
  8. Add echo "build --remote_cache=grpc://<creds>@swiftlint-ci.jpsim.com:9092" > ci.bazelrc to /opt/homebrew/etc/buildkite-agent/hooks/pre-command, replacing <creds> with the bazel-remote credentials
  9. Configure and launch buildkite agent: brew info buildkite-agent / https://buildkite.com/organizations/swiftlint/agents#setup-macos
  10. On the swiftlint-ci.jpsim.com machine only: docker run -d -u 1000:1000 -v /tmp/swiftlint-bazel-remote-cache:/data -v ~/Desktop/bazel-remote.htpasswd:/etc/bazel-remote/htpasswd -p 9090:8080 -p 9092:9092 buchgr/bazel-remote-cache --htpasswd_file=/etc/bazel-remote/htpasswd --max_size=5