Support for monorepo/workspace-level configuration in VSCode extension

[fatbobman]

Current Setup

I'm working with a monorepo structure using VSCode workspace:

MyProject.code-workspce

{
  "folders": [
    { "path": "Domain" },    // Swift Package
    { "path": "Persistent" } // Swift Package
  ],
"settings": {
    "swiftlint.configSearchPaths": ["${workspaceFolder}"],
  },
}

The workspace directory structure:

MyProject/
├── .swiftlint.yml          // Workspace-level config
├── MyProject.code-workspace
├── Domain/
│   └── Package.swift
│   └── .vscode/settings.json
└── Persistent/
    └── Package.swift
│   └── .vscode/settings.json

Current Behavior

The VSCode SwiftLint extension doesn't seem to recognize the workspace-level .swiftlint.yml configuration. Currently, we have to:

• Either duplicate the config file in each package directory

Expected Behavior

When using a workspace:

1. The extension should recognize a workspace-level .swiftlint.yml
2. This config should apply to all Swift files in the workspace unless overridden by package-specific configs
3. Ideally, the extension's configSearchPaths setting in workspace settings should work relative to the workspace root

Question

What's the recommended way to maintain a single SwiftLint configuration in a monorepo/workspace setup? Is this a feature that could be supported in the extension?

[fatbobman]

I found the way to set it up.

[SimplyDanny]

I found the way to set it up.

Great! Would you like to share your solution in case others are interested, too?

[fatbobman]

@SimplyDanny

MyProject.code-workspace

"swiftlint.configSearchPaths": ["../.swiftlint.yml", ".swiftlint.yml"]

in each Package .vscode/settings.json

"swiftlint.configSearchPaths": ["../.swiftlint.yml", ".swiftlint.yml"]

in .swiftlint.yml

A path (Package) name must be used, and wildcards cannot be used.

included:
  - Domain/Sources
  - Persistent/Sources

excluded:
  - .build
  - .swiftpm
  - Generated
  - Domain/Tests
  - Persistent/Test

Now whether you open workspace or package directly, lint is easy to use.