This is a tool that enforces only explicitly declared dependencies are imported and also can enforce extra rules for forbidden import statements per target. You can also create a nice mermaid diagram for your local packages adding some extra config properties.
Swift build provides the --explicit-target-dependency-import-check flag but unfortunatelly it is not available with xcodebuild.
- Use the above tool as a pre-commit hook to avoid increasing your build time.
brew tap michaelversus/swiftimportchecks https://github.com/michaelversus/SwiftImportChecks
brew install swiftimportchecks-clets you specify a path to your .sic.yml configuration file, if you have one-rsets the path SwiftImportChecks should scan. This defaults to your current working directory.-psets the name of your project file (for example MyProject.xcodeproj), if you need one-ssets the path for a container for your local SPM Packages, if you want to parse those-venables verbose output. Default value is false
You can customize the behavior of SwiftImportChecks by creating a .sic.yml file in the directory you wish to scan. This is a YAML file that allows you to exclude paths, import statements and packages globally and also per target. For example, if you need to:
- exclude
.buildand.githubpaths from scanning - exclude target
SomeTargetfrom scanning - exclude package
SomePackagefrom scanning - exclude
someInternalPathonly forSICDemoApptarget from scanning - exclude
SomeImportimport statements only forSICDemoApptarget from scanning - throw error when scan finds
STLTimport statement only forSICDemoApptarget - create a mermaid diagram for all your local packages
configurations:
SICDemoApp:
excluded:
- someInternalPath
excludedImports:
- SomeImport
forbiddenImports:
- STLT
excludedPaths:
- .build
- .github
excludedTargets:
- SomeTarget
excludedPackages:
- SomePackage
diagrams:
regular:
layers:
- Foundation
- Frameworkswiftimportchecks -c ./.sic.yml -p MyProject.xcodeproj -s PackagesSwiftImportChecks can generate a mermaid diagram for your local packages if you follow the below steps:
- Add the
diagramsproperty in your .sic.yml file like demonstrated above with theregularproperty and some layers ordered from bottom to top. - You need to add comments at the top of your local package files like this:
// swift-tools-version: 6.0
// The swift-tools-version declares the minimum version of Swift required to build this package.
// this comment will add ExampleModule inside the Foundation layer
// swiftimportchecks:0:ExampleModule
import PackageDescription
let package = Package(
name: "ExamplePackage",
dependencies: [
.package(url: "https://github.com/jpsim/Yams.git", from: "5.0.0")
],
targets: [
.target(name: "ExampleModule", dependencies: ["Yams"]),
]
)// swift-tools-version: 6.0
// The swift-tools-version declares the minimum version of Swift required to build this package.
// this comment will add OtherModule inside the Framework layer
// swiftimportchecks:1:OtherModule
import PackageDescription
let package = Package(
name: "OtherPackage",
dependencies: [
.package(url: "https://github.com/jpsim/Yams.git", from: "5.0.0")
],
targets: [
.target(name: "OtherModule", dependencies: ["Yams"]),
]
)The above example will create a diagram like this one inside the local packages directory:
SwiftImportChecks is built on top of
- Apple's SwiftSyntax library for parsing code, which is available under the Apache License v2.0 with Runtime Library Exception.
- tuist's XcodeProj library for parsing the xcodeproj file, which is available under the MIT license.
- jpsim's YAMS library for parsing yaml files, which is available under the MIT license.
Two amazing projects that I was inspired from to build the above tool are:
- twostraws Sitrep a source code analyzer for Swift projects, which is available under the Apache License v2.0 with Runtime Library Exception.
- nikoloutsos explicitDependencyImportCheck a Swift build plugin that enforces clean dependency management, which is available under the MIT license.
Swift, the Swift logo, and Xcode are trademarks of Apple Inc., registered in the U.S. and other countries.
Contributions are more than welcome!