realm / realm/SwiftLint

Allow parent config as an argument

Open
#5,421 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

New Issue Checklist
Feature Request

I would like to add --parent-config argument to the lint command. That way we don't have to specify the parent-config: inside of the config file. The use case for this is that the parent config path is not known ahead of time and I need to pass it in from a temporary directory where it is pulled and I don't control the path of the directory.

This is how it would look

swiftlint lint --parent-config "path/to/config" 

It would add the parent config to the .swiftlint config file it reads during execution.

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 at the lint command entry point and trace how the .swiftlint config file is loaded and how its parent config is selected. Add support for the --parent-config argument so the supplied path is used during execution, then verify that the command works with a config path from a temporary directory.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
cli
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.