realm/SwiftLint

Feature request: lexicographic sorting options for `sorted_imports`

Open

#4,810 opened on Mar 11, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Swift (19,570 stars) (2,295 forks)batch import
enhancementgood first issue

Description

New Issue Checklist

Describe the bug

import AppTypes
import AVFoundation
import Base
import Logging

Will pass sorted_imports, but swift-format's equivalent of this rule wants lexicographic sorting, and expects

import AppTypes
import Base
import Logging
import AVFoundation

It would be nice if SwiftLint offered a configuration option that preferred a sort order compatible with swift-format

Complete output when running SwiftLint, including the stack trace and command used

N/A

Environment

  • SwiftLint version (run swiftlint version to be sure)? 0.50.3
  • Installation method used (Homebrew, CocoaPods, building from source, etc)? Homebrew
  • Paste your configuration file:

none

no

  • Which Xcode version are you using (check xcodebuild -version)?
Xcode 14.2
Build version 14C18
  • Do you have a sample that shows the issue? Run echo "[string here]" | swiftlint lint --no-cache --use-stdin --enable-all-rules to quickly test if your example is really demonstrating the issue. If your example is more complex, you can use swiftlint lint --path [file here] --no-cache --enable-all-rules.

N/A

Contributor guide

Tech stack
swift
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
SwiftSwiftLint architecture
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Examine the existing `sorted imports` rule implementation in SwiftLint, likely located in `Source/SwiftLintFramework/Rules/` directory. Understand how configuration options are defined and parsed. The goal is to add a new configuration parameter (e.g., `sort order`) that defaults to the current behavior (grouped) and allows `lexicographic` to match swift format. Review the rule's logic to modify sorting comparison. No linked PRs or comments yet; start by searching for the rule file and its configuration structure.
Feature request: lexicographic sorting options for `sorted_imports` · realm/SwiftLint#4810 | Good First Issue