realm / realm/SwiftLint

Rule request: Add Arguments to YAML configuration

Open
#4,326 1 comment 1 reaction 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
New rule request

Thanks to the work done by folks recently, we can now add SwiftLint as a Build Tool Plug-in which is amazing! It comes with the caveat:

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.

Could there please be the ability to have some of the arguments in the yaml? Such as -- strict for example. Or is there a way to do this that I am missing?

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

Start by reviewing the SwiftLint Swift Package Manager Build Tool Plug-in work referenced in pull request #4176 and the stated limitation on passing executable options. Define how YAML should represent arguments such as strict mode, then verify that the configuration is honored when the plug-in runs. The issue does not name specific files or tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
build-system, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.