Merge pull request #18 from ra1028/feat/support-filelist-params

feat: Support filelist parameter via command line

Author: ra1028

.gitignore

@@ -5,4 +5,5 @@ xcuserdata/
 vendor/
 .bundle/
 .tmp
+.swiftpm/
 swift-mod.zip

.swift-mod.yml

@@ -2,18 +2,12 @@ format:
   indent: 4
   lineBreakBeforeEachArgument: true
 
-targets:
-  main:
-    paths:
-      - Sources
-    excludedPaths:
-      - "**/main.swift"
-    rules:
-      defaultAccessLevel:
-        accessLevel: openOrPublic
-        implicitInternal: true
+rules:
+  defaultAccessLevel:
+    accessLevel: openOrPublic
+    implicitInternal: true
 
-      defaultMemberwiseInitializer:
-        implicitInitializer: true
-        implicitInternal: true
-        ignoreClassesWithInheritance: true
+  defaultMemberwiseInitializer:
+    implicitInitializer: true
+    implicitInternal: true
+    ignoreClassesWithInheritance: true

.version

@@ -1 +1 @@
-0.0.10
+0.1.0

Makefile

@@ -1,4 +1,5 @@
-SWIFT_FORMAT_PATHS := Sources/ $(shell find Tests/**/*.swift -not -name XCTestManifests.swift)
+SWIFT_FORMAT_PATHS := Sources $(shell find Tests -type f -name "*.swift")
+SWIFT_MOD_PATHS := $(shell find Sources -type f -name "*.swift" -not -path "Sources/swift-mod/*")
 SWIFT_BUILD_FLAGS := -c release --disable-sandbox
 TOOL_NAME := swift-mod
 XCODE_DEFAULT_TOOLCHAIN := /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain
@@ -18,9 +19,6 @@ TOOL_BIN := $(TOOL_BIN_DIR)/$(TOOL_NAME)
 
 .PHONY: $(MAKECMDGOALS)
 
-xcodeproj:
-	swift package generate-xcodeproj
-
 build:
 	swift build $(SWIFT_BUILD_FLAGS)
 	@echo $(TOOL_BIN)
@@ -29,7 +27,7 @@ test:
 	swift test -c release --parallel
 
 mod:
-	swift run -c release swift-mod
+	swift run -c release swift-mod $(SWIFT_MOD_PATHS)
 
 format:
 	swift run -c release --package-path ./Tools -- swift-format format --configuration .swift-format.json -i -r $(SWIFT_FORMAT_PATHS)

Package.resolved

@@ -2,68 +2,59 @@
 
 import PackageDescription
 
-let testsSuffix = "Tests"
-
-let core = Target.target(
-    name: "SwiftModCore",
-    dependencies: [
-        .product(name: "SwiftSyntaxParser", package: "swift-syntax"),
-        .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
-        "Yams",
-    ]
-)
-
-let coreTests = Target.testTarget(
-    name: core.name + testsSuffix,
-    dependencies: [.target(name: core.name)] + core.dependencies
-)
-
-let rules = Target.target(
-    name: "SwiftModRules",
-    dependencies: [.target(name: core.name)] + core.dependencies
-)
-
-let rulesTests = Target.testTarget(
-    name: rules.name + testsSuffix,
-    dependencies: [.target(name: rules.name)] + rules.dependencies
-)
-
-let commands = Target.target(
-    name: "SwiftModCommands",
-    dependencies: [.target(name: rules.name)] + rules.dependencies
-)
-
-let commandsTests = Target.testTarget(
-    name: commands.name + testsSuffix,
-    dependencies: [.target(name: commands.name)] + commands.dependencies
-)
-
-let cli = Target.executableTarget(
-    name: "swift-mod",
-    dependencies: [.target(name: commands.name)] + commands.dependencies
-)
-
 let package = Package(
     name: "swift-mod",
     platforms: [
        .macOS("10.15")
     ],
     products: [
-        .executable(name: "swift-mod", targets: [cli.name])
+        .executable(
+            name: "swift-mod",
+            targets: ["swift-mod"]
+        )
     ],
     dependencies: [
         .package(url: "https://github.com/apple/swift-syntax", .upToNextMinor(from: "0.50600.1")),
+        .package(url: "https://github.com/apple/swift-argument-parser", .upToNextMinor(from: "1.1.2")),
         .package(url: "https://github.com/apple/swift-tools-support-core.git", from: "0.2.3"),
         .package(url: "https://github.com/jpsim/Yams.git", from: "5.0.0")
     ],
     targets: [
-        cli,
-        commands,
-        commandsTests,
-        rules,
-        rulesTests,
-        core,
-        coreTests,
+        .executableTarget(
+            name: "swift-mod",
+            dependencies: ["SwiftModCommands"]
+        ),
+        .target(
+            name: "SwiftModCommands",
+            dependencies: [
+                "SwiftModRules",
+                .product(name: "ArgumentParser", package: "swift-argument-parser"),
+            ]
+        ),
+        .testTarget(
+            name: "SwiftModCommandsTests",
+            dependencies: ["SwiftModCommands"]
+        ),
+        .target(
+            name: "SwiftModRules",
+            dependencies: ["SwiftModCore"]
+        ),
+        .testTarget(
+            name: "SwiftModRulesTests",
+            dependencies: ["SwiftModRules"]
+        ),
+        .target(
+            name: "SwiftModCore",
+            dependencies: [
+                .product(name: "SwiftSyntaxParser", package: "swift-syntax"),
+                .product(name: "SwiftToolsSupport-auto", package: "swift-tools-support-core"),
+                "Yams",
+            ]
+        ),
+        .testTarget(
+            name: "SwiftModCoreTests",
+            dependencies: ["SwiftModCore"]
+        ),
     ],
     swiftLanguageVersions: [.v5]
 )

Package.swift

@@ -74,15 +74,15 @@ swift-mod init
 
 ```sh
 swift-mod rules
-swift-mod rules --detail [RULE IDENTIFIER] # Display more detailed rule description
+swift-mod rules --rule [RULE NAME] # Display more detailed rule description
 ```
 
 4. Edit your configuration file with an editor you like, refering to the [documentation](#configuration).
 
 5. Run
 
 ```sh
-swift-mod
+swift-mod <list of input files>
 ```
 
 ---
@@ -95,26 +95,45 @@ swift-mod [COMMAND] [OPTIONS]
 
 All commands can be display a usage by option `-h/--help`.
 
-- `run` (or not specified): Modifies Swift source code by rules.
+- `run` (or not specified)
 
-  |OPTION|SHORT|USAGE|
-  |:-|:-|:-|
-  |--configuration|-c|The path to a configuration Yaml file|
-  |--target|-t|The target name to be run partially|
-  |--dry-run||Run without actually changing any files|
-  |--check||Dry run that an error occurs if the any files should be changed|
+```
+OVERVIEW: Runs modification.
+
+USAGE: swift-mod run [--mode <mode>] [--configuration <configuration>] [<paths> ...]
+
+ARGUMENTS:
+  <paths>                 Zero or more input filenames.
+
+OPTIONS:
+  -m, --mode <mode>                   Overrides running mode: modify|dry-run|check. (default: modify)
+  -c, --configuration <configuration> The path to a configuration file.
+  -h, --help                          Show help information.
+```
+
+- `init`
+
+```
+OVERVIEW: Generates a modify configuration file.
+
+USAGE: swift-mod init [--output <output>]
 
-- `init`: Generates a modify configuration file.
+OPTIONS:
+  -o, --output <output>   An output for the configuration file to be generated.
+  -h, --help              Show help information.
+```
 
-  |OPTION|SHORT|USAGE|
-  |:-|:-|:-|
-  |--output|-o|Path where the modify configuration should be generated|
+- `rules`
 
-- `rules`: Display the list of rules and overview.
+```
+OVERVIEW: Display the list of rules.
 
-  |OPTION|SHORT|USAGE|
-  |:-|:-|:-|
-  |--detail|-d|A rule identifier to displaying detailed description|
+USAGE: swift-mod rules [--rule <rule>]
+
+OPTIONS:
+  -r, --rule <rule>       A rule name to see detail.
+  -h, --help              Show help information.
+```
 
 ---
 
@@ -124,7 +143,7 @@ Modification rules and targets are defines with YAML-formatted file. By default,
 Any file name is allowed with passing with option like follows:  
 
 ```sh
-swift-mod --configuration your-config-file.yml
+swift-mod --configuration <configuration>
 ```
 
 ### Example
@@ -133,25 +152,14 @@ swift-mod --configuration your-config-file.yml
 format:
   indent: 4
   lineBreakBeforeEachArgument: true
-targets:
-  main:
-    paths:
-      - "**/main.swift"
-    excludedPaths:
-      - Modules/
-    rules:
-      defaultAccessLevel:
-        accessLevel: internal
-        implicitInternal: true
-  module:
-    paths:
-      - Modules/
-    rules:
-      defaultAccessLevel:
-        accessLevel: openOrPublic
-        implicitInternal: true
-      defaultMemberwiseInitializer:
-        enabled: true
+rules:
+  defaultAccessLevel:
+    accessLevel: openOrPublic
+    implicitInternal: true
+  defaultMemberwiseInitializer:
+    implicitInitializer: false
+    implicitInternal: true
+    ignoreClassesWithInheritance: false
 ```
 
 ### Format
@@ -164,28 +172,8 @@ Format according to this setting only when changes occur.
 |indent|The number of spaces, or `tab` by text|Optional|4|
 |lineBreakBeforeEachArgument|Indicating whether to insert new lines before each function argument|Optional|true|
 
-### Targets
-
-Defines the several targets by name key that defines different paths or rules to apply.  
-Glob paths are allowed for `paths` and `excludedPaths`.  
-Each target can runs partially by command with option like follows:  
-
-```sh
-swift-mod --target [TARGET NAME]
-```
-
-|KEY|VALUE|REQUIREMENT|DEFAULT|
-|:-|:-|:-|:-|
-|paths|The file names or paths to be applied rules. The directory is recursively lookup.|Required||
-|excludedPaths|The file name or paths to be ecluded from resolved `paths`|Optional|None|
-|rules|The set of rules to be applied|Required||
-
 ### Rules
 
-Defines a modification rules enabled and its settings.  
-All rules are opt-in.  
-Rules where all settings are optional can specify only Boolean value indicating whether it's enabled by key `enabled`.  
-
 #### Default Access Level
 
 |IDENTIFIER|OVERVIEW|
@@ -325,8 +313,7 @@ Run command:
 Pods/swift-mod/swift-mod [COMMAND] [OPTIONS]
 ```
 
-\* If you have changed the name of `Xcode.app` used in toolchain (`xcode-select -p`), `swift-mod` via CocoaPods can't be excuted. Please set the Xcode name to `Xcode.app`. (See: https://forums.swift.org/t/swiftsyntax-with-swift-5-1/29051)  
-
+\* If you have changed the name of `Xcode.app` used in toolchain (`xcode-select -p`), `swift-mod` via CocoaPods can't be excuted. Please set the Xcode name to `Xcode.app`. (See: <https://forums.swift.org/t/swiftsyntax-with-swift-5-1/29051>)  
 
 ### Swift Version Support
 
@@ -339,12 +326,8 @@ So you should use swift-mod version that built with compatible version of Swift
 |5.2          |0.0.4                           |
 |5.3          |0.0.5                           |
 |5.4          |0.0.6                           |
-|5.5          |latest                          |
-
-### Issue on macOS Before 10.14.4
-
-Swift tool binary that works with static-stdlib can't running on macOS before 10.14.4.  
-You need to update macOS or install the [Swift 5 Runtime Support for Command Line Tools](https://support.apple.com/kb/DL1998).  
+|5.5          |0.0.7                           |
+|5.6          |latest                          |
 
 ---
 
@@ -366,12 +349,6 @@ In addition, swift-mod supports running on Linux, so you should test by installi
 make docker-test
 ```
 
-### Known Issue
-
-Currently, swift-mod doesn't works properly with builds in `debug` configuration.  
-It may due to stack overflow with tail recursion in the method that enumerating the Swift file paths.  
-swift-mod works with optimizing tail recursion by builds in `release` configuration.  
-
 ---
 
 ## License

README.md

@@ -0,0 +1,19 @@
+import ArgumentParser
+import TSCBasic
+
+public enum Mode: String, CaseIterable, ExpressibleByArgument {
+    case modify
+    case dryRun = "dry-run"
+    case check
+}
+
+extension AbsolutePath: ExpressibleByArgument {
+    public init?(argument: String) {
+        if let cwd = localFileSystem.currentWorkingDirectory {
+            self.init(argument, relativeTo: cwd)
+        }
+        else {
+            try? self.init(validating: argument)
+        }
+    }
+}