Repository files navigation

A tool to enforce Swift style and conventions, loosely based on the nowarchivedGitHub Swift Style Guide.SwiftLint enforces the style guide rules that are generally accepted by theSwift community. These rules are well described in popular style guides likeKodeco's Swift Style Guide.

SwiftLint hooks intoClang andSourceKit to use theAST representationof your source files for more accurate results.

This project adheres to theContributor Covenant Code of Conduct.By participating, you are expected to uphold this code.

Switch Language:中文한국어

To get a high-level overview of SwiftLint, we encourage you to watch thispresentation recorded January 9th, 2017 by JP Simard (transcript provided):

SwiftLint can be used as acommand pluginor abuild tool plugin.

Add

.package(url:"https://github.com/SimplyDanny/SwiftLintPlugins", from:"<version>")

to yourPackage.swift file to consume the latest release of SwiftLintautomatically or pin the dependency to a specific version:

.package(url:"https://github.com/SimplyDanny/SwiftLintPlugins", exact:"<version>")

Therein, replace<version> with the desired minimum or exact version.

Use the following link to add SwiftLint as a Package Dependency to an Xcodeproject:

https://github.com/SimplyDanny/SwiftLintPlugins

brew install swiftlint

Add the following to yourPodfile:

pod'SwiftLint'

This will download the SwiftLint binaries and dependencies inPods/ duringyour nextpod install execution and will allow you to invoke it via${PODS_ROOT}/SwiftLint/swiftlint in your Script Build Phases.

Installing via Cocoapods also enables pinning to a specific version ofSwiftLint rather than simply the latest (which is the case withHomebrew).

Note that this will add the SwiftLint binaries, its dependencies' binaries, andthe Swift binary library distribution to thePods/ directory, so checking inthis directory to SCM such as Git is discouraged.

mint install realm/SwiftLint

Put this in yourMODULE.bazel:

bazel_dep(name="swiftlint",version="0.52.4",repo_name="SwiftLint")

Or put this in yourWORKSPACE:

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

DownloadSwiftLint.pkg from thelatest GitHub release andrun it.

Make sure the build toolBazel and arecentSwift toolchain areinstalled and all tools are discoverable in yourPATH.

To build SwiftLint, clone this repository and runmake install.

SwiftLint can be used as a build tool plugin for bothSwift Package projectsandXcode projects.

The build tool plugin determines the SwiftLint working directory by locatingthe topmost config file within the package/project directory. If a config fileis not found therein, the package/project directory is used as the workingdirectory.

The plugin throws an error when it is unable to resolve the SwiftLint workingdirectory. For example, this will occur in Xcode projects where the target'sSwift files are not located within the project directory.

To maximize compatibility with the plugin, avoid project structures that requirethe use of the--config option.

Build tool plugins run when building each target. When a project has multipletargets, the plugin must be added to the desired targets individually.

To do this, add the plugin to the target(s) to be linted as follows:

.target(...    plugins:[.plugin(name:"SwiftLintBuildToolPlugin",package:"SwiftLintPlugins")]),

The command plugin enables running SwiftLint from the command line as follows:

swift package plugin swiftlint

Build tool plugins run as a build phase of each target. When a project hasmultiple targets, the plugin must be added to the desired targets individually.

To do this, add theSwiftLintBuildToolPlugin to theRun Build Tool Plug-insphase of theBuild Phases for the target(s) to be linted.

For unattended use (e.g. on CI), package plugin and macrovalidations can be disabled with either of the following:

• Usingxcodebuild options:

  -skipPackagePluginValidation-skipMacroValidation

• Setting Xcode defaults:

  defaults write com.apple.dt.Xcode IDESkipPackagePluginFingerprintValidatation -bool YESdefaults write com.apple.dt.Xcode IDESkipMacroFingerprintValidation -bool YES

Project structures where SwiftLint's configuration file is locatedoutside of the package/project directory are not directly supportedby the build tool plugin. This is because it isn't possible to passarguments to build tool plugins (e.g., passing the config file path).

If your project structure doesn't work directly with the build toolplugin, please consider one of the following options:

• To use a config file located outside the package/project directory, a configfile may be added to that directory specifying a parent config path to theother config file, e.g.,parent_config: path/to/.swiftlint.yml.
• You can also consider the use of aRun Script Build Phase in place of the buildtool plugin.

If the build tool plugin does not work for your project setup or whenadditional custom setup is required, SwiftLint can be added as a Run ScriptBuild Phase. This is useful when a project setup relies on the--configSwiftLint option; or to lint all targets together in a singleswiftlintinvocation. File inclusions and exclusions can be configured in the.swiftlint.yml configuration.

To do this, add a custom script to aRun Script phase of theBuild Phasesof the primary app target, after theCompile Sources phase. Use thefollowing script implementation:

ifcommand -v swiftlint>/dev/null2>&1then    swiftlintelseecho"warning:`swiftlint` command not found - See https://github.com/realm/SwiftLint#installation for installation instructions."fi

If you're using the SwiftLintPlugin in a Swift package,you may refer to theswiftlint executable in thefollowing way:

SWIFT_PACKAGE_DIR="${BUILD_DIR%Build/*}SourcePackages/artifacts"SWIFTLINT_CMD=$(ls"$SWIFT_PACKAGE_DIR"/swiftlintplugins/SwiftLintBinary/SwiftLintBinary.artifactbundle/swiftlint-*-macos/bin/swiftlint| head -n 1)iftest -f"$SWIFTLINT_CMD"2>&1then"$SWIFTLINT_CMD"elseecho"warning:`swiftlint` command not found - See https://github.com/realm/SwiftLint#installation for installation instructions."fi

Xcode 15 made a significant change by setting the default value of theENABLE_USER_SCRIPT_SANDBOXING build setting fromNO toYES.As a result, SwiftLint encounters an error related to missing file permissions,which typically manifests aserror: Sandbox: swiftlint(19427) deny(1) file-read-data.

To resolve this issue, it is necessary to manually set theENABLE_USER_SCRIPT_SANDBOXING setting toNO for the specific target thatSwiftLint is being configured for.

If you installed SwiftLint via Homebrew on Apple Silicon, you might experiencethis 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 findSwiftLint, you can either add/opt/homebrew/bin to thePATH environmentvariable in your build phase:

if [["$(uname -m)"== arm64 ]]thenexport PATH="/opt/homebrew/bin:$PATH"fiifcommand -v swiftlint>/dev/null2>&1then    swiftlintelseecho"warning:`swiftlint` command not found - See https://github.com/realm/SwiftLint#installation for installation instructions."fi

or you can create a symbolic link in/usr/local/bin pointing to the actualbinary:

ln -s /opt/homebrew/bin/swiftlint /usr/local/bin/swiftlint

If you wish to fix violations as well, your script could runswiftlint --fix && swiftlint instead of justswiftlint. This will meanthat all correctable violations are fixed while ensuring warnings show up inyour project for remaining violations.

If you've installed SwiftLint via CocoaPods the script should look like this:

"${PODS_ROOT}/SwiftLint/swiftlint"

To integrate SwiftLint withVisual Studio Code, install thevscode-swiftlintextension from the marketplace.

You can use the officialswiftlint fastlane actionto run SwiftLint as part of your fastlane process.

swiftlint(mode::lint,# SwiftLint mode: :lint (default) or :autocorrectexecutable:"Pods/SwiftLint/swiftlint",# The SwiftLint binary path (optional). Important if you've installed it via CocoaPodspath:"/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 aDocker image usingUbuntu. So just the first time you need to pull the docker image using thenext command:

docker pull ghcr.io/realm/swiftlint:latest

Then following times, you just runswiftlint inside of the docker like:

docker run -it -v`pwd`:`pwd` -w`pwd` ghcr.io/realm/swiftlint:latest

This will executeswiftlint 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:latestLinting Swift filesin current working directoryLinting'RuleDocumentation.swift' (1/490)...Linting'YamlSwiftLintTests.swift' (490/490)Done linting! Found 0 violations, 0 seriousin 490 files.

Here you have more documentation about the usage ofDocker Images.

$ swiftlint helpOVERVIEW: 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 selected group of rules  lint (default)          Print lint warnings and errors  baseline                Operations on existing baselines  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.

Runswiftlint in the directory containing the Swift files to lint. Directorieswill be searched recursively.

To specify a list of files when usinglint oranalyze(like the list of files modified by Xcode specified by theExtraBuildPhase Xcodeplugin, or modified files in the working tree based ongit ls-files -m), youcan do so by passing the option--use-script-input-files and setting thefollowing instance variables:SCRIPT_INPUT_FILE_COUNTandSCRIPT_INPUT_FILE_0,SCRIPT_INPUT_FILE_1, ...,SCRIPT_INPUT_FILE_{SCRIPT_INPUT_FILE_COUNT - 1}.Similarly, files can be read from file lists by passingthe option--use-script-input-file-lists and setting thefollowing instance variables:SCRIPT_INPUT_FILE_LIST_COUNTandSCRIPT_INPUT_FILE_LIST_0,SCRIPT_INPUT_FILE_LIST_1, ...,SCRIPT_INPUT_FILE_LIST_{SCRIPT_INPUT_FILE_LIST_COUNT - 1}.

These are same environment variables set for input files tocustom 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 Swiftcompiler, it just communicates with the official one you already have installedon your machine.

You should always run SwiftLint with the same toolchain you use to compile yourcode.

You may want to override SwiftLint's default Swift toolchain if you havemultiple 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 theusr/lib/ subdirectory ofthe value passed in the paths above.

You may also set theTOOLCHAINS environment variable to the reverse-DNSnotation 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 theLINUX_SOURCEKIT_LIB_PATHenvironment variable.

SwiftLint can be run as apre-commit hook.Onceinstalled, add this to the.pre-commit-config.yaml in the root of your repository:

repos:  -repo:https://github.com/realm/SwiftLintrev:0.57.1hooks:      -id:swiftlint

Adjustrev to the SwiftLint version of your choice.pre-commit autoupdatecan be used to update to the current version.

SwiftLint can be configured usingentry to apply fixes and fail on errors:

-repo:https://github.com/realm/SwiftLintrev:0.57.1hooks:    -id:swiftlintentry:swiftlint --fix --strict

Over 200 rules are included in SwiftLint and the Swift community (that's you!)continues to contribute more over time.Pull requestsare encouraged.

You can find an updated list of rules and more information about them in theRule Directory.

You can also check theSource/SwiftLintBuiltInRules/Rulesdirectory to see their implementation.

opt_in_rules are disabled by default (i.e., you have to explicitly enable themin your configuration file).

Guidelines on when to mark a rule as opt-in:

• A rule that can have many false positives (e.g.empty_count)
• A rule that is too slow
• A rule that is not general consensus or is only useful in some cases(e.g.force_unwrapping)

Rules can be disabled with a comment inside a source file with the followingformat:

// swiftlint:disable <rule1> [<rule2> <rule3>...]

The rules will be disabled until the end of the file or until the linter sees amatching enable comment:

// swiftlint:enable <rule1> [<rule2> <rule3>...]

For example:

// swiftlint:disable colonletnoWarning:String="" // No warning about colons immediately after variable names!// swiftlint:enable colonlethasWarning:String="" // Warning generated about colons immediately after variable names

Including theall keyword will disable all rules until the linter sees amatching enable comment:

// swiftlint:disable all// swiftlint:enable all

For example:

// swiftlint:disable allletnoWarning:String="" // No warning about colons immediately after variable names!leti="" // Also no warning about short identifier names// swiftlint:enable alllethasWarning:String="" // Warning generated about colons immediately after variable nameslety="" // Warning generated about short identifier names

It's also possible to modify adisable orenable 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_castletnoWarning=NSNumber()as!IntlethasWarning=NSNumber()as!IntletnoWarning2=NSNumber()as!Int // swiftlint:disable:this force_castletnoWarning3=NSNumber()as!Int// swiftlint:disable:previous force_cast

Runswiftlint rules to print a list of all available rules and theiridentifiers.

Configure SwiftLint by adding a.swiftlint.yml file from the directory you'llrun 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. Thespecialall identifier will enable all opt in linter rules, except the oneslisted indisabled_rules.
• only_rules: Only the rules specified in this list will be enabled.Cannot be specified alongsidedisabled_rules oropt_in_rules.
• analyzer_rules: This is an entirely separate list of rules that are onlyrun by theanalyze command. All analyzer rules are opt-in, so this is theonly configurable rule list, there are no equivalents fordisabled_rulesandonly_rules. The specialall identifier can also be used here to enableall analyzer rules, except the ones listed indisabled_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_statementopt_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_whitespaceanalyzer_rules:# rules run by `swiftlint analyze`  -explicit_self# Case-sensitive paths to include during linting. Directory paths supplied on the# command line will be ignored.included:   -Sourcesexcluded:# 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# If true, SwiftLint will treat all errors as warnings.lenient:false# The path to a baseline file, which will be used to filter out detected violations.baseline:Baseline.json# The path to save detected violations to as a new baseline.write_baseline:Baseline.json# If true, SwiftLint will check for updates after linting or analyzing.check_for_updates:true# configurable rules can be customized from this configuration file# binary rules can set their severity levelforce_cast:warning# implicitlyforce_try:severity:warning# explicitly# rules that have both warning and error levels, can set just the warning level# implicitlyline_length:110# they can set both implicitly with an arraytype_body_length:  -300# warning  -400# error# or they can set both explicitlyfile_length:warning:500error:1200# naming rules can set warnings/errors for min_length and max_length# additionally they can set excluded namestype_name:min_length:4# only warningmax_length:# warning and errorwarning:40error:50excluded:iPhone# excluded via stringallowed_symbols:["_"]# these are allowed in type namesidentifier_name:min_length:# only min_lengtherror:4# only errorexcluded:# excluded via string array    -id    -URL    -GlobalAPIKeyreporter:"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, SwiftLintcan also run two types of custom rules that you can define yourself in your ownprojects:

These rules are written the same way as the Swift-based rules that ship withSwiftLint so they're fast, accurate, can leverage SwiftSyntax, can be unittested, and more.

Using these requires building SwiftLint with Bazel as described inthis video or its associated code ingithub.com/jpsim/swiftlint-bazel-example.

You can define custom regex-based rules in your configuration file using thefollowing syntax:

custom_rules:pirates_beat_ninjas:# rule identifierincluded:      -".*\\.swift"# regex that defines paths to include during linting. optional.excluded:      -".*Test\\.swift"# regex that defines paths to exclude during linting. optionalname:"Pirates Beat Ninjas"# rule name. optional.regex:"([nN]inja)"# matching patterncapture_group:0# number of regex capture group to highlight the rule violation at. optional.match_kinds:# SyntaxKinds to match. optional.      -comment      -identifiermessage:"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 theflagss andm enabled, that is.matches newlinesand^/$match the start and end of lines,respectively. If you do not want to have. match newlines, for example, theregex can be prepended by(?-s).

You can filter the matches by providing one or morematch_kinds, which willreject matches that include syntax kinds that are not present in this list. Hereare 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 askingSourceKitten. For example,sourcekitten syntax --text "struct S {}" delivers

• source.lang.swift.syntaxtype.keyword for thestruct keyword and
• source.lang.swift.syntaxtype.identifier for its nameS

which match tokeyword andidentifier in the above list.

If using custom rules in combination withonly_rules, you must include theliteral stringcustom_rules in theonly_rules list:

only_rules:  -custom_rulescustom_rules:no_hiding_in_strings:regex:"([nN]inja)"match_kinds:string

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 areoverwritten with a corrected version.

Please make sure to have backups of these files before runningswiftlint --fix, otherwise important data may be lost.

Standard linting is disabled while correcting because of the high likelihood ofviolations (or their offsets) being incorrect after modifying a file whileapplying corrections.

Theswiftlint analyze command can lint Swift files using thefull type-checked AST. The compiler log path containing the cleanswiftc buildcommand invocation (incremental builds will fail) must be passed toanalyzevia the--compiler-log-path flag.e.g.--compiler-log-path /path/to/xcodebuild.log

This can be obtained by

1. Cleaning DerivedData (incremental builds won't work with analyze)
2. Runningxcodebuild -workspace {WORKSPACE}.xcworkspace -scheme {SCHEME} > xcodebuild.log
3. Runningswiftlint 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 isthen applied just as a single configuration file would get applied.

There are quite a lot of use cases where using multiple configuration filescould be helpful:

For instance, one could use a team-wide shared SwiftLint configuration whileallowing 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 achild_config and/or aparent_config reference within aconfiguration file. These references should be local paths relative to thefolder of the configuration file they are specified in. This even worksrecursively, as long as there are no cycles and no ambiguities.

A child config is treated as a refinement and thus has a higher priority,while a parent config is considered a base with lower priority in case ofconflicts.

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 shouldlook like this:

child_config:.swiftlint_refinement.ymlparent_config:Base/.swiftlint_base.yml

When merging parent and child configs,included andexcluded configurationsare processed carefully to account for differences in the directory locationof the containing configuration files.

Just as you can provide localchild_config/parent_config references,instead of referencing local paths, you can just put urls that lead toconfiguration files. In order for SwiftLint to detect these remote references,they must start withhttp:// orhttps://.

The referenced remote configuration files may even recursively reference otherremote 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 triesto get a new version of every remote configuration that is referenced. If thisrequest times out, a cached version is used if available. If there is no cachedversion available, SwiftLint fails – but no worries, a cached version should bethere once SwiftLint has run successfully at least once.

If needed, the timeouts for the remote configuration fetching can be specifiedmanually via the configuration file(s) using theremote_timeout/remote_timeout_if_cached specifiers. These values defaultto 2 seconds or 1 second, respectively.

Instead of just providing one configuration file when running SwiftLint via thecommand line, you can also pass a hierarchy, where the first configuration istreated as a parent, while the last one is treated as the highest-prioritychild.

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 rootfolder), you can put other configuration files named.swiftlint.yml into thedirectory structure that then get merged as a child config, but only with aneffect for those files that are within the same directory as the config or in adeeper directory where there isn't another configuration file. In other words:Nested configurations don't work recursively – there's a maximum number of onenested configuration per file that may be applied in addition to the mainconfiguration.

.swiftlint.yml files are only considered as a nested configuration if theyhave not been used to build the main configuration already (e. g. by havingbeen referenced via something likechild_config: Folder/.swiftlint.yml).Also,parent_config/child_config specifications of nested configurationsare getting ignored because there's no sense to that.

If one (or more) SwiftLint file(s) are explicitly specified via the--configparameter, that configuration will be treated as an override, no matter whetherthere exist other.swiftlint.yml files somewhere within the directory.So if you want to use nested configurations, you can't use the--configparameter.

MIT licensed.

SwiftLint is utterly maintained by volunteers contributing to its successentirely in their free time. As such, SwiftLint isn't a commercial productin any way.

Be kind to the people maintaining SwiftLint as a hobby and accept that theirtime is limited. Support them by contributing to the project, reporting issues,and helping others in the community.

Special thanks go toMacStadium for providingphysical Mac mini machines to run our performance tests.

We also thank Realm (now MongoDB) for their inital contributions and setup ofthe project.