docs: clarified swiftformat.options #17

vknabel · Dec 12, 2022 · 4812ab7 · 4812ab7
1 parent afd1819
commit 4812ab7
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# Unreleased
+
+- docs: clarified `swiftformat.options` #17
+
 # 1.5.1
 
 - fix: on Linux, must also be linked

diff --git a/README.md b/README.md
@@ -42,14 +42,14 @@ let package = Package(
 
 ## Configuration
 
-| Config                                    | Type       | Default                      | Description                                            |
-| ----------------------------------------- | ---------- | ---------------------------- | ------------------------------------------------------ |
-| `swiftformat.enable`                      | `Bool`     | `true`                       | Whether SwiftFormat should actually do something.      |
-| `swiftformat.onlyEnableOnSwiftPMProjects` | `Bool`     | `false`                      | Requires and uses a SwiftFormat as SwiftPM dependency. |
-| `swiftformat.onlyEnableWithConfig`        | `Bool`     | `false`                      | Only format if config present.                         |
-| `swiftformat.path`                        | `String`   | `/usr/local/bin/swiftformat` | The location of the globally installed SwiftFormat.    |
-| `swiftformat.options`                     | `[String]` | `[]`                         | Additional parameters for SwiftFormat.                 |
-| `swiftformat.configSearchPaths`           | `[String]` | `[".swiftformat"]`           | Possible paths for SwiftFormat config.                 |
+| Config                                    | Type       | Default                      | Description                                                                                |
+| ----------------------------------------- | ---------- | ---------------------------- | ------------------------------------------------------------------------------------------ |
+| `swiftformat.enable`                      | `Bool`     | `true`                       | Whether SwiftFormat should actually do something.                                          |
+| `swiftformat.onlyEnableOnSwiftPMProjects` | `Bool`     | `false`                      | Requires and uses a SwiftFormat as SwiftPM dependency.                                     |
+| `swiftformat.onlyEnableWithConfig`        | `Bool`     | `false`                      | Only format if config present.                                                             |
+| `swiftformat.path`                        | `String`   | `/usr/local/bin/swiftformat` | The location of the globally installed SwiftFormat.                                        |
+| `swiftformat.options`                     | `[String]` | `[]`                         | Additional [options for SwiftFormat](https://github.com/nicklockwood/SwiftFormat#options). |
+| `swiftformat.configSearchPaths`           | `[String]` | `[".swiftformat"]`           | Possible paths for SwiftFormat config.                                                     |
 
 ## Contributors
 

diff --git a/package.json b/package.json
@@ -77,7 +77,7 @@
         "swiftformat.options": {
           "type": "array",
           "default": [],
-          "description": "Additional parameters for SwiftFormat.",
+          "description": "Additional options for SwiftFormat: https://github.com/nicklockwood/SwiftFormat#options",
           "items": {
             "type": "string"
           }