Support sorting array elements, e.g. in Package.swift

[simonnickel]

I have a project with many internal Swift packages inside of it. The rules are properly applied to files in these packages. They are not applied to the Package.swift files of these packages though.

I am trying to sort the list of dependencies in each Package.swift. Using // swiftformat:sort:begin in both places: It works for code files in the package, but not for the Package.swift.

Am I doing something wrong, or is this expected? Is some additional configuration needed to cover these files?

[calda]

Can you share sample code of how you're using the swiftformat:sort:begin directive? The sortDeclaration rule sorts declarations (e.g. properties of types, or top-level global properties) but doesn't support sorting array elements.

[simonnickel]

An example of a Package.swift file:

Package(
    name: "PackageName",
    products: [
        .library(
            name: "PackageName",
            targets: ["PackageName"]
        ),
    ],
    dependencies: [
        .package(path: "../AnotherPackage"),
        .package(path: "../OtherPackage"),
    ],
    targets: [
        .target(
            name: "PackageName",
            dependencies: [
                "OtherPackage",
                "AnotherPackage",
            ]
        )
    ]
)

The goal is to sort the content of both dependencies arrays.

The sortDeclaration rule sorts declarations (e.g. properties of types, or top-level global properties) but doesn't support sorting array elements.

I guess that's the explanation then. I expected // swiftformat:sort:begin | :end to just sort every line in between.

Is there a way to achieve that?

[calda]

It would definitely be nice to add support for sorting arrays, but that's not implemented currently