realm / realm/SwiftLint

Setting to exclude files listed in `.gitignore` or other existing ignore files

Open
#6,245 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Swift
Stars
19.7k
Forks
2.3k
Avg merge
1d 1h
Merged PRs (30d)
11

Description

New Issue Checklist
Feature or Enhancement Proposal

Please add a setting to exclude files listed in .gitignore or in other existing ignore files.

I want to lint all Swift files in my repo, but .build contains many generated Swift files that get linted.

.build & other paths are already ignored by my .gitignore; I shouldn't need to copy such ignored paths into .swiftlint.yml.

Other file names or ignore file formats can also be supported. You could always take the union of all ignores from all supported ignore files from standard locations, allow format & path to be specified, and allow multiple ignore files, potentially with multiple ignore files per same type.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin by reviewing how SwiftLint currently reads .swiftlint.yml and selects files for linting. Compare that behavior with the requested use of .gitignore and other ignore files, including paths such as .build. Done means the issue's desired configuration and supported ignore-file behavior are defined and implemented with coverage for excluded generated Swift files.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.