Merge pull request #615 from natikgadzhi/feature/generate-pipeline/ru…

…le-documentation Generate rule docs automatically
apple · Sep 7, 2023 · f14a625 · f14a625
2 parents 5a5d876 + 284ed05
commit f14a625
Show file tree

Hide file tree

Showing 6 changed files with 631 additions and 1 deletion.
diff --git a/Documentation/Configuration.md b/Documentation/Configuration.md
@@ -103,6 +103,18 @@ An example `.swift-format` configuration file is shown below.
 }
 ```
 
+## Linter and Formatter Rules Configuration
+
+In the `rules` block of `.swift-format`, you can specify which rules to apply
+when linting and formatting your project. Read the
+[rules documentation](Documentation/RuleDocumentation.md) to see the list of all
+supported linter and formatter rules, and their overview.
+
+You can also run this command to see the list of rules in the default
+`swift-format` configuration:
+
+    $ swift-format dump-configuration
+
 ## API Configuration
 
 The `SwiftConfiguration` module contains a `Configuration` type that is