A tool to enforce Swift style and conventions, loosely based on the now archived GitHub Swift Style Guide. SwiftLint enforces the style guide rules that are generally accepted by the Swift community. These rules are well described in popular style guides like Kodeco's Swift Style Guide.
SwiftLint hooks into Clang and SourceKit to use the AST representation of your source files for more accurate results.
This project adheres to the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
brew install swiftlint
Simply add the following line to your Podfile:
pod 'SwiftLint'
This will download the SwiftLint binaries and dependencies in Pods/
during your next
pod install
execution and will allow you to invoke it via ${PODS_ROOT}/SwiftLint/swiftlint
in your Script Build Phases.
This is the recommended way to install a specific version of SwiftLint since it supports installing a pinned version rather than simply the latest (which is the case with Homebrew).
Note that this will add the SwiftLint binaries, its dependencies' binaries, and the Swift binary
library distribution to the Pods/
directory, so checking in this directory to SCM such as
git is discouraged.
$ mint install realm/SwiftLint
You can also install SwiftLint by downloading SwiftLint.pkg
from the
latest GitHub release and
running it.
You can also build and install from source by cloning this project and running
make install
(Xcode 15.0 or later).
Put this in your MODULE.bazel
:
bazel_dep(name = "swiftlint", version = "0.52.4", repo_name = "SwiftLint")
Or put this in your WORKSPACE
:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "build_bazel_rules_apple",
sha256 = "390841dd5f8a85fc25776684f4793d56e21b098dfd7243cd145b9831e6ef8be6",
url = "https://github.com/bazelbuild/rules_apple/releases/download/2.4.1/rules_apple.2.4.1.tar.gz",
)
load(
"@build_bazel_rules_apple//apple:repositories.bzl",
"apple_rules_dependencies",
)
apple_rules_dependencies()
load(
"@build_bazel_rules_swift//swift:repositories.bzl",
"swift_rules_dependencies",
)
swift_rules_dependencies()
load(
"@build_bazel_rules_swift//swift:extras.bzl",
"swift_rules_extra_dependencies",
)
swift_rules_extra_dependencies()
http_archive(
name = "SwiftLint",
sha256 = "c6ea58b9c72082cdc1ada4a2d48273ecc355896ed72204cedcc586b6ccb8aca6",
url = "https://github.com/realm/SwiftLint/releases/download/0.52.4/bazel.tar.gz",
)
load("@SwiftLint//bazel:repos.bzl", "swiftlint_repos")
swiftlint_repos()
load("@SwiftLint//bazel:deps.bzl", "swiftlint_deps")
swiftlint_deps()
Then you can run SwiftLint in the current directory with this command:
bazel run -c opt @SwiftLint//:swiftlint
To get a high-level overview of recommended ways to integrate SwiftLint into your project, we encourage you to watch this presentation or read the transcript:
Integrate SwiftLint into your Xcode project to get warnings and errors displayed in the issue navigator.
To do this select the project in the file navigator, then select the primary app target, and go to Build Phases. Click the + and select "New Run Script Phase". Insert the following as the script:
Xcode 15 made a significant change by setting the default value of the ENABLE_USER_SCRIPT_SANDBOXING
Build Setting from NO
to YES
.
As a result, SwiftLint encounters an error related to missing file permissions,
which typically manifests as follows: error: Sandbox: swiftlint(19427) deny(1) file-read-data.
To resolve this issue, it is necessary to manually set the ENABLE_USER_SCRIPT_SANDBOXING
setting to NO
for the specific target that SwiftLint is being configured for.
If you installed SwiftLint via Homebrew on Apple Silicon, you might experience this warning:
warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint
That is because Homebrew on Apple Silicon installs the binaries into the /opt/homebrew/bin
folder by default. To instruct Xcode where to find SwiftLint, you can either add
/opt/homebrew/bin
to the PATH
environment variable in your build phase
if [[ "$(uname -m)" == arm64 ]]; then
export PATH="/opt/homebrew/bin:$PATH"
fi
if which swiftlint > /dev/null; then
swiftlint
else
echo "warning: SwiftLint not installed, download from https://github.com/realm/SwiftLint"
fi
or you can create a symbolic link in /usr/local/bin
pointing to the actual binary:
ln -s /opt/homebrew/bin/swiftlint /usr/local/bin/swiftlint
You might want to move your SwiftLint phase directly before the 'Compile Sources' step to detect errors quickly before compiling. However, SwiftLint is designed to run on valid Swift code that cleanly completes the compiler's parsing stage. So running SwiftLint before 'Compile Sources' might yield some incorrect results.
If you wish to fix violations as well, your script could run
swiftlint --fix && swiftlint
instead of just swiftlint
. This will mean
that all correctable violations are fixed while ensuring warnings show up in
your project for remaining violations.
If you've installed SwiftLint via CocoaPods the script should look like this:
"${PODS_ROOT}/SwiftLint/swiftlint"
SwiftLint can be used as a build tool plug-in for both Xcode projects as well as Swift packages.
Due to limitations with Swift Package Manager Plug-ins this is only recommended for projects that have a SwiftLint configuration in their root directory as there is currently no way to pass any additional options to the SwiftLint executable.
You can integrate SwiftLint as an Xcode Build Tool Plug-in if you're working with a project in Xcode.
Add SwiftLint as a package dependency to your project without linking any of the products.
Select the target you want to add linting to and open the Build Phases
inspector.
Open Run Build Tool Plug-ins
and select the +
button.
Select SwiftLintPlugin
from the list and add it to the project.
For unattended use (e.g. on CI), you can disable the package validation dialog by
-skipPackagePluginValidation
to xcodebuild
ordefaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YES
for that user.Note: This implicitly trusts all Xcode package plugins and bypasses Xcode's package validation dialogs, which has security implications.
You can integrate SwiftLint as a Swift Package Manager Plug-in if you're working with
a Swift Package with a Package.swift
manifest.
Add SwiftLint as a package dependency to your Package.swift
file.
Add SwiftLint to a target using the plugins
parameter.
.target(
...
plugins: [.plugin(name: "SwiftLintPlugin", package: "SwiftLint")]
),
To integrate SwiftLint with vscode, install the
vscode-swiftlint
extension from the marketplace.
You can use the official swiftlint fastlane action to run SwiftLint as part of your fastlane process.
swiftlint(
mode: :lint, # SwiftLint mode: :lint (default) or :autocorrect
executable: "Pods/SwiftLint/swiftlint", # The SwiftLint binary path (optional). Important if you've installed it via CocoaPods
path: "/path/to/lint", # Specify path to lint (optional)
output_file: "swiftlint.result.json", # The path of the output file (optional)
reporter: "json", # The custom reporter to use (optional)
config_file: ".swiftlint-ci.yml", # The path of the configuration file (optional)
files: [ # List of files to process (optional)
"AppDelegate.swift",
"path/to/project/Model.swift"
],
ignore_exit_status: true, # Allow fastlane to continue even if SwiftLint returns a non-zero exit status (Default: false)
quiet: true, # Don't print status logs like 'Linting ' & 'Done linting' (Default: false)
strict: true # Fail on warnings? (Default: false)
)
swiftlint
is also available as a Docker image using Ubuntu
.
So just the first time you need to pull the docker image using the next command:
docker pull ghcr.io/realm/swiftlint:latest
Then following times, you just run swiftlint
inside of the docker like:
docker run -it -v `pwd`:`pwd` -w `pwd` ghcr.io/realm/swiftlint:latest
This will execute swiftlint
in the folder where you are right now (pwd
), showing an output like:
$ docker run -it -v `pwd`:`pwd` -w `pwd` ghcr.io/realm/swiftlint:latest
Linting Swift files in current working directory
Linting 'RuleDocumentation.swift' (1/490)
...
Linting 'YamlSwiftLintTests.swift' (490/490)
Done linting! Found 0 violations, 0 serious in 490 files.
Here you have more documentation about the usage of Docker Images.
$ swiftlint help
OVERVIEW: A tool to enforce Swift style and conventions.
USAGE: swiftlint <subcommand>
OPTIONS:
--version Show the version.
-h, --help Show help information.
SUBCOMMANDS:
analyze Run analysis rules
docs Open SwiftLint documentation website in the default web browser
generate-docs Generates markdown documentation for all rules
lint (default) Print lint warnings and errors
reporters Display the list of reporters and their identifiers
rules Display the list of rules and their identifiers
version Display the current version of SwiftLint
See 'swiftlint help <subcommand>' for detailed help.
Run swiftlint
in the directory containing the Swift files to lint. Directories
will be searched recursively.
To specify a list of files when using lint
or analyze
(like the list of files modified by Xcode specified by the
ExtraBuildPhase
Xcode
plugin, or modified files in the working tree based on git ls-files -m
), you
can do so by passing the option --use-script-input-files
and setting the
following instance variables: SCRIPT_INPUT_FILE_COUNT
and
SCRIPT_INPUT_FILE_0
, SCRIPT_INPUT_FILE_1
...SCRIPT_INPUT_FILE_{SCRIPT_INPUT_FILE_COUNT - 1}
.
These are same environment variables set for input files to custom Xcode script phases.
SwiftLint hooks into SourceKit so it continues working even as Swift evolves!
This also keeps SwiftLint lean, as it doesn't need to ship with a full Swift compiler, it just communicates with the official one you already have installed on your machine.
You should always run SwiftLint with the same toolchain you use to compile your code.
You may want to override SwiftLint's default Swift toolchain if you have multiple toolchains or Xcodes installed.
Here's the order in which SwiftLint determines which Swift toolchain to use:
$XCODE_DEFAULT_TOOLCHAIN_OVERRIDE
$TOOLCHAIN_DIR
or $TOOLCHAINS
xcrun -find swift
/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
~/Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
~/Applications/Xcode-beta.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
sourcekitd.framework
is expected to be found in the usr/lib/
subdirectory of
the value passed in the paths above.
You may also set the TOOLCHAINS
environment variable to the reverse-DNS
notation that identifies a Swift toolchain version:
$ TOOLCHAINS=com.apple.dt.toolchain.Swift_2_3 swiftlint --fix
On Linux, SourceKit is expected to be located in
/usr/lib/libsourcekitdInProc.so
or specified by the LINUX_SOURCEKIT_LIB_PATH
environment variable.
SwiftLint can be run as a pre-commit hook.
Once installed, add this to the
.pre-commit-config.yaml
in the root of your repository:
repos:
- repo: https://github.com/realm/SwiftLint
rev: 0.50.3
hooks:
- id: swiftlint
Adjust rev
to the SwiftLint version of your choice. pre-commit autoupdate
can be used to update to the current version.
SwiftLint can be configured using entry
to apply fixes and fail on errors:
- repo: https://github.com/realm/SwiftLint
rev: 0.50.3
hooks:
- id: swiftlint
entry: swiftlint --fix --strict
Over 200 rules are included in SwiftLint and the Swift community (that's you!) continues to contribute more over time. Pull requests are encouraged.
You can find an updated list of rules and more information about them here.
You can also check Source/SwiftLintBuiltInRules/Rules directory to see their implementation.
opt_in_rules
are disabled by default (i.e., you have to explicitly enable them
in your configuration file).
Guidelines on when to mark a rule as opt-in:
empty_count
)force_unwrapping
)Rules can be disabled with a comment inside a source file with the following format:
// swiftlint:disable <rule1> [<rule2> <rule3>...]
The rules will be disabled until the end of the file or until the linter sees a matching enable comment:
// swiftlint:enable <rule1> [<rule2> <rule3>...]
For example:
// swiftlint:disable colon
let noWarning :String = "" // No warning about colons immediately after variable names!
// swiftlint:enable colon
let hasWarning :String = "" // Warning generated about colons immediately after variable names
Including the all
keyword will disable all rules until the linter sees a matching enable comment:
// swiftlint:disable all
// swiftlint:enable all
For example:
// swiftlint:disable all
let noWarning :String = "" // No warning about colons immediately after variable names!
let i = "" // Also no warning about short identifier names
// swiftlint:enable all
let hasWarning :String = "" // Warning generated about colons immediately after variable names
let y = "" // Warning generated about short identifier names
It's also possible to modify a disable
or enable
command by appending
:previous
, :this
or :next
for only applying the command to the previous,
this (current) or next line respectively.
For example:
// swiftlint:disable:next force_cast
let noWarning = NSNumber() as! Int
let hasWarning = NSNumber() as! Int
let noWarning2 = NSNumber() as! Int // swiftlint:disable:this force_cast
let noWarning3 = NSNumber() as! Int
// swiftlint:disable:previous force_cast
Run swiftlint rules
to print a list of all available rules and their
identifiers.
Configure SwiftLint by adding a .swiftlint.yml
file from the directory you'll
run SwiftLint from. The following parameters can be configured:
Rule inclusion:
disabled_rules
: Disable rules from the default enabled set.opt_in_rules
: Enable rules that are not part of the default set. The
special all
identifier will enable all opt in linter rules, except the ones
listed in disabled_rules
.only_rules
: Only the rules specified in this list will be enabled.
Cannot be specified alongside disabled_rules
or opt_in_rules
.analyzer_rules
: This is an entirely separate list of rules that are only
run by the analyze
command. All analyzer rules are opt-in, so this is the
only configurable rule list, there are no equivalents for disabled_rules
only_rules
.# By default, SwiftLint uses a set of sensible default rules you can adjust:
disabled_rules: # rule identifiers turned on by default to exclude from running
- colon
- comma
- control_statement
opt_in_rules: # some rules are turned off by default, so you need to opt-in
- empty_count # find all the available rules by running: `swiftlint rules`
# Alternatively, specify all rules explicitly by uncommenting this option:
# only_rules: # delete `disabled_rules` & `opt_in_rules` if using this
# - empty_parameters
# - vertical_whitespace
analyzer_rules: # rules run by `swiftlint analyze`
- explicit_self
included: # case-sensitive paths to include during linting. `--path` is ignored if present
- Sources
excluded: # case-sensitive paths to ignore during linting. Takes precedence over `included`
- Carthage
- Pods
- Sources/ExcludedFolder
- Sources/ExcludedFile.swift
- Sources/*/ExcludedFile.swift # exclude files with a wildcard
# If true, SwiftLint will not fail if no lintable files are found.
allow_zero_lintable_files: false
# If true, SwiftLint will treat all warnings as errors.
strict: false
# configurable rules can be customized from this configuration file
# binary rules can set their severity level
force_cast: warning # implicitly
force_try:
severity: warning # explicitly
# rules that have both warning and error levels, can set just the warning level
# implicitly
line_length: 110
# they can set both implicitly with an array
type_body_length:
- 300 # warning
- 400 # error
# or they can set both explicitly
file_length:
warning: 500
error: 1200
# naming rules can set warnings/errors for min_length and max_length
# additionally they can set excluded names
type_name:
min_length: 4 # only warning
max_length: # warning and error
warning: 40
error: 50
excluded: iPhone # excluded via string
allowed_symbols: ["_"] # these are allowed in type names
identifier_name:
min_length: # only min_length
error: 4 # only error
excluded: # excluded via string array
- id
- URL
- GlobalAPIKey
reporter: "xcode" # reporter type (xcode, json, csv, checkstyle, codeclimate, junit, html, emoji, sonarqube, markdown, github-actions-logging, summary)
You can also use environment variables in your configuration file,
by using ${SOME_VARIABLE}
in a string.
In addition to the rules that the main SwiftLint project ships with, SwiftLint can also run two types of custom rules that you can define yourself in your own projects:
These rules are written the same way as the Swift-based rules that ship with SwiftLint so they're fast, accurate, can leverage SwiftSyntax, can be unit tested, and more.
Using these requires building SwiftLint with Bazel as described in this video or its associated code in github.com/jpsim/swiftlint-bazel-example.
You can define custom regex-based rules in your configuration file using the following syntax:
custom_rules:
pirates_beat_ninjas: # rule identifier
included:
- ".*\\.swift" # regex that defines paths to include during linting. optional.
excluded:
- ".*Test\\.swift" # regex that defines paths to exclude during linting. optional
name: "Pirates Beat Ninjas" # rule name. optional.
regex: "([nN]inja)" # matching pattern
capture_group: 0 # number of regex capture group to highlight the rule violation at. optional.
match_kinds: # SyntaxKinds to match. optional.
- comment
- identifier
message: "Pirates are better than ninjas." # violation message. optional.
severity: error # violation severity. optional.
no_hiding_in_strings:
regex: "([nN]inja)"
match_kinds: string
This is what the output would look like:
It is important to note that the regular expression pattern is used with the flags s
and m
enabled, that is .
matches newlines
and ^
/$
match the start and end of lines,
respectively. If you do not want to have .
match newlines, for example, the regex can be prepended by (?-s)
.
You can filter the matches by providing one or more match_kinds
, which will
reject matches that include syntax kinds that are not present in this list. Here
are all the possible syntax kinds:
argument
attribute.builtin
attribute.id
buildconfig.id
buildconfig.keyword
comment
comment.mark
comment.url
doccomment
doccomment.field
identifier
keyword
number
objectliteral
parameter
placeholder
string
string_interpolation_anchor
typeidentifier
All syntax kinds used in a snippet of Swift code can be extracted asking
SourceKitten. For example,
sourcekitten syntax --text "struct S {}"
delivers
source.lang.swift.syntaxtype.keyword
for the struct
keyword andsource.lang.swift.syntaxtype.identifier
for its name S
which match to keyword
and identifier
in the above list.
If using custom rules in combination with only_rules
, make sure to add
custom_rules
as an item under only_rules
.
Unlike Swift custom rules, you can use official SwiftLint builds (e.g. from Homebrew) to run regex custom rules.
SwiftLint can automatically correct certain violations. Files on disk are overwritten with a corrected version.
Please make sure to have backups of these files before running
swiftlint --fix
, otherwise important data may be lost.
Standard linting is disabled while correcting because of the high likelihood of violations (or their offsets) being incorrect after modifying a file while applying corrections.
The swiftlint analyze
command can lint Swift files using the
full type-checked AST. The compiler log path containing the clean swiftc
build
command invocation (incremental builds will fail) must be passed to analyze
via the --compiler-log-path
flag.
e.g. --compiler-log-path /path/to/xcodebuild.log
This can be obtained by
xcodebuild -workspace {WORKSPACE}.xcworkspace -scheme {SCHEME} > xcodebuild.log
swiftlint analyze --compiler-log-path xcodebuild.log
Analyzer rules tend to be considerably slower than lint rules.
SwiftLint offers a variety of ways to include multiple configuration files. Multiple configuration files get merged into one single configuration that is then applied just as a single configuration file would get applied.
There are quite a lot of use cases where using multiple configuration files could be helpful:
For instance, one could use a team-wide shared SwiftLint configuration while allowing overrides in each project via a child configuration file.
Team-Wide Configuration:
disabled_rules:
- force_cast
Project-Specific Configuration:
opt_in_rules:
- force_cast
You can specify a child_config
and / or a parent_config
reference within a configuration file.
These references should be local paths relative to the folder of the configuration file they are specified in.
This even works recursively, as long as there are no cycles and no ambiguities.
A child config is treated as a refinement and therefore has a higher priority, while a parent config is considered a base with lower priority in case of conflicts.
Here's an example, assuming you have the following file structure:
ProjectRoot
|_ .swiftlint.yml
|_ .swiftlint_refinement.yml
|_ Base
|_ .swiftlint_base.yml
To include both the refinement and the base file, your .swiftlint.yml
should look like this:
child_config: .swiftlint_refinement.yml
parent_config: Base/.swiftlint_base.yml
When merging parent and child configs, included
and excluded
configurations
are processed carefully to account for differences in the directory location
of the containing configuration files.
Just as you can provide local child_config
/ parent_config
references, instead of
referencing local paths, you can just put urls that lead to configuration files.
In order for SwiftLint to detect these remote references, they must start with http://
or https://
.
The referenced remote configuration files may even recursively reference other remote configuration files, but aren't allowed to include local references.
Using a remote reference, your .swiftlint.yml
could look like this:
parent_config: https://myteamserver.com/our-base-swiftlint-config.yml
Every time you run SwiftLint and have an Internet connection, SwiftLint tries to get a new version of every remote configuration that is referenced. If this request times out, a cached version is used if available. If there is no cached version available, SwiftLint fails – but no worries, a cached version should be there once SwiftLint has run successfully at least once.
If needed, the timeouts for the remote configuration fetching can be specified manually via the
configuration file(s) using the remote_timeout
/ remote_timeout_if_cached
specifiers.
These values default to 2 / 1 second(s).
Instead of just providing one configuration file when running SwiftLint via the command line, you can also pass a hierarchy, where the first configuration is treated as a parent, while the last one is treated as the highest-priority child.
A simple example including just two configuration files looks like this:
swiftlint --config .swiftlint.yml --config .swiftlint_child.yml
In addition to a main configuration (the .swiftlint.yml
file in the root folder),
you can put other configuration files named .swiftlint.yml
into the directory structure
that then get merged as a child config, but only with an effect for those files
that are within the same directory as the config or in a deeper directory where
there isn't another configuration file. In other words: Nested configurations don't work
recursively – there's a maximum number of one nested configuration per file
that may be applied in addition to the main configuration.
.swiftlint.yml
files are only considered as a nested configuration if they have not been
used to build the main configuration already (e. g. by having been referenced via something
like child_config: Folder/.swiftlint.yml
). Also, parent_config
/ child_config
specifications of nested configurations are getting ignored because there's no sense to that.
If one (or more) SwiftLint file(s) are explicitly specified via the --config
parameter,
that configuration will be treated as an override, no matter whether there exist
other .swiftlint.yml
files somewhere within the directory. So if you want to use
nested configurations, you can't use the --config
parameter.
SwiftLint is maintained and funded by Realm Inc. The names and logos for Realm are trademarks of Realm Inc.
We :heart: open source software! See our other open source projects, read our blog, or say hi on twitter (@realm).
Our thanks to MacStadium for providing a Mac Mini to run our performance tests.
link |
Stars: 17781 |
Last commit: 15 hours ago |
Hide all Reporter
s from SwiftLint's' public interface.
SimplyDanny
The options inlcuded
, name
and message
are from now on ignored in the
configuration for the private_unit_test
rule. The option regex
is still
supported but is deprecated. It's recommended to use the list
test_parent_classes
instead which accepts names of parent test classes.
SimplyDanny
Remove support for disable and enable commands in multiline comments.
Martin Redington
#4798
Show specific violation message for the attributes
rule when the option
always_on_line_above
or attributes_with_arguments_always_on_line_above
is involved.
chrisngabp
5103
Rewrite control_statement
rule using SwiftSyntax.
SimplyDanny
Add new non_overridable_class_declaration
rule that triggers on class
function and variable declarations in final classes that are not final
themselves or private.
SimplyDanny
The Homebrew formula for SwiftLint now also installs completion scripts for
Bash, Zsh and fish.
SimplyDanny
Add new private_swiftui_state_property
opt-in rule to encourage setting
SwiftUI @State
and @StateObject
properties to private.
mt00chikin
#3173
The implicit_return
rule now supports the kinds subscript
and
initializer
in the included
configuration list.
SimplyDanny
Add unneeded_override
rule to remove function overrides that only
call super.
keith
5139
Show a rule's active YAML configuration in output of
swiftlint rules <rule>
.
SimplyDanny
Add invokeTest()
to overridden_super_call
defaults.
DylanBettermannDD
Add --config-only
option to rules
command allowing to print only the YAML
configuration of a single or all rules.
SimplyDanny
Add --default-config
option to rules
command allowing to use default
values for configurations being printed for a single rule or all rules.
SimplyDanny
Add include_bare_init
option to the explicit_init
rule. include_bare_init
encourages using named constructors over .init()
and type inference.
Martin Redington
#5203
Improved the reported location and reasons provided for issues
detected by the invalid_seiftlint_command
rule.
Martin Redington
#5204
100 is no longer considered to be a magic number by the no_magic_numbers
rule.
Martin Redington
#5215
Adds a strict
configuration file setting, equivalent to the --strict
command line option.
Martin Redington
#5226
Extend implicitly_unwrapped_optional
rule with the new mode
weak_except_iboutlets
that only checks weak
variables.
Ricky Tan
Respect grapheme clusters in counting the number of characters in the collection_alignment
rule.
kishikawakatsumi
#4837
Fix false positive in control_statement
rule that triggered on conditions
with trailing closures where parentheses are recommended by the compiler.
SimplyDanny
#5135
Fix runtime error when an excluded directory does not exist.
SimplyDanny
#5078
Support switch
expressions used in expression contexts in
switch_case_alignment
rule.
SimplyDanny
#5191
#5227
#5080
Fix bug in prefer_self_in_static_references
rule that triggered on
initializers of computed properties in classes when the property had an
accessor block.
SimplyDanny
#5118
Document exclude_ranges
option for number_separator
rule.
SimplyDanny
Rewrite implicit_return
rule with SwiftSyntax fixing a few false positives
and false negatives in the process.
SimplyDanny
#5161
Make sure severity
is configurable for type_contents_order
rule.
SimplyDanny
Bazel: Mark rules_xcodeproj
as a development dependency.
Thi Doãn
JP Simard
#4737
Fix false negatives for the unneeded_synthesized_initializer
rule
for nested structs in classes.
Martin Redington
#5120
Fix some unexpected rule enablement interactions between parent and
child configurations.
Martin Redington
#4876
The no_magic_numbers
rule will not trigger for violations in an
extension, if the extended class inherits from one of the specified
test_parent_classes
, as long as the class declaration and the
extension are in the same source file.
Martin Redington
#5137
Fix false positive in the ns_number_init_as_function_reference
rule
when calling NSNumber.init(value:)
directly.
Marcelo Fabri
#5172
The no_magic_numbers
rule will not trigger for bitwise shift
operations.
Martin Redington
#5171
The accessibility_label_for_image
rule will no longer ignore the
Image(systemName:)
constructor, as many system images do not
have good accessibility labels.
Martin Redington
#5165
Fix false positives for superfluous_disable_command
rule.
Martin Redington
#4798
Fix false positive in the test_case_accessibility
rule.
gibachan
#5211
With bzlmod:
// Pending BCR update
bazel_dep(name = "swiftlint", version = "0.53.0", repo_name = "SwiftLint")
Without bzlmod, put this in your WORKSPACE
:
load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
http_archive(
name = "build_bazel_rules_apple",
sha256 = "9e26307516c4d5f2ad4aee90ac01eb8cd31f9b8d6ea93619fc64b3cbc81b0944",
url = "https://github.com/bazelbuild/rules_apple/releases/download/2.2.0/rules_apple.2.2.0.tar.gz",
)
load(
"@build_bazel_rules_apple//apple:repositories.bzl",
"apple_rules_dependencies",
)
apple_rules_dependencies()
load(
"@build_bazel_rules_swift//swift:repositories.bzl",
"swift_rules_dependencies",
)
swift_rules_dependencies()
load(
"@build_bazel_rules_swift//swift:extras.bzl",
"swift_rules_extra_dependencies",
)
swift_rules_extra_dependencies()
http_archive(
name = "SwiftLint",
sha256 = "75839dc9e8a492a86bb585a3cda3d73b58997d7a14d02f1dba94171766bb8599",
url = "https://github.com/realm/SwiftLint/releases/download/0.53.0/bazel.tar.gz",
)
load("@SwiftLint//bazel:repos.bzl", "swiftlint_repos")
swiftlint_repos()
load("@SwiftLint//bazel:deps.bzl", "swiftlint_deps")
swiftlint_deps()
Then you can run SwiftLint in the current directory with this command:
bazel run @SwiftLint//:swiftlint -- --help
Swiftpack is being maintained by Petr Pavlik | @ptrpavlik | @swiftpackco | API | Analytics