Merge pull request swiftlang#235 from dabelknap/rule-whitelist

Use a whitelisting model for configuring which rules to use.

Author: allevato

Sources/SwiftFormat/PopulatePipeline.swift

@@ -117,7 +117,6 @@ func populate(_ pipeline: Pipeline) {
   pipeline.addFormatter(
     OneVariableDeclarationPerLine.self,
     for:
-      AccessorBlockSyntax.self,
       ClosureExprSyntax.self,
       CodeBlockSyntax.self,
       SourceFileSyntax.self
@@ -152,7 +151,7 @@ func populate(_ pipeline: Pipeline) {
   pipeline.addFormatter(
     UseSingleLinePropertyGetter.self,
     for:
-      AccessorBlockSyntax.self
+      PatternBindingSyntax.self
   )
 
   pipeline.addFormatter(

Sources/SwiftFormatConfiguration/Configuration.swift

@@ -28,13 +28,18 @@ public class Configuration: Codable {
     case respectsExistingLineBreaks
     case blankLineBetweenMembers
     case surroundSymbolsWithBackticks
+    case rules
   }
 
   /// The version of this configuration.
   private let version: Int
 
   /// MARK: Common configuration
 
+  /// The dictionary containing the rule names that we wish to run on. A rule is not used if it is
+  /// marked as `false`, or if it is missing from the dictionary.
+  public var rules: [String: Bool] = [:]
+
   /// The maximum number of consecutive blank lines that may appear in a file.
   public var maximumBlankLines = 1
 
@@ -68,6 +73,7 @@ public class Configuration: Codable {
   /// Constructs a Configuration with all default values.
   public init() {
     self.version = highestSupportedConfigurationVersion
+    self.rules = RuleRegistry.rules
   }
 
   public required init(from decoder: Decoder) throws {
@@ -101,6 +107,7 @@ public class Configuration: Codable {
     self.blankLineBetweenMembers = try container.decodeIfPresent(
       BlankLineBetweenMembersConfiguration.self, forKey: .blankLineBetweenMembers)
       ?? BlankLineBetweenMembersConfiguration()
+    self.rules = try container.decodeIfPresent([String: Bool].self, forKey: .rules) ?? [:]
   }
 
   public func encode(to encoder: Encoder) throws {
@@ -113,6 +120,7 @@ public class Configuration: Codable {
     try container.encode(indentation, forKey: .indentation)
     try container.encode(respectsExistingLineBreaks, forKey: .respectsExistingLineBreaks)
     try container.encode(blankLineBetweenMembers, forKey: .blankLineBetweenMembers)
+    try container.encode(rules, forKey: .rules)
   }
 }
 

Sources/SwiftFormatConfiguration/RuleRegistry.swift

@@ -0,0 +1,57 @@
+//===----------------------------------------------------------------------===//
+//
+// This source file is part of the Swift.org open source project
+//
+// Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+// Licensed under Apache License v2.0 with Runtime Library Exception
+//
+// See https://swift.org/LICENSE.txt for license information
+// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+//
+//===----------------------------------------------------------------------===//
+
+// This file is automatically generated with generate-pipeline. Do Not Edit!
+
+enum RuleRegistry {
+  static let rules: [String: Bool] = [
+    "UseOnlyUTF8": true,
+    "UseSpecialEscapeSequences": true,
+    "BlankLineBetweenMembers": true,
+    "DoNotUseSemicolons": true,
+    "FullyIndirectEnum": true,
+    "GroupNumericLiterals": true,
+    "MultiLineTrailingCommas": true,
+    "NoAccessLevelOnExtensionDeclaration": true,
+    "NoBlockComments": true,
+    "NoCasesWithOnlyFallthrough": true,
+    "NoEmptyAssociatedValues": true,
+    "NoEmptyTrailingClosureParentheses": true,
+    "NoLabelsInCasePatterns": true,
+    "NoParensAroundConditions": true,
+    "NoVoidReturnOnFunctionSignature": true,
+    "OneCasePerLine": true,
+    "OneVariableDeclarationPerLine": true,
+    "OrderedImports": true,
+    "ReturnVoidInsteadOfEmptyTuple": true,
+    "UseEnumForNamespacing": true,
+    "UseShorthandTypeNames": true,
+    "UseSingleLinePropertyGetter": true,
+    "UseTripleSlashForDocumentationComments": true,
+    "AllPublicDeclarationsHaveDocumentation": true,
+    "AlwaysUseLowerCamelCase": true,
+    "AmbiguousTrailingClosureOverload": true,
+    "AvoidInitializersForLiterals": true,
+    "BeginDocumentationCommentWithOneLineSummary": true,
+    "CaseIndentLevelEqualsSwitch": true,
+    "DontRepeatTypeInStaticProperties": true,
+    "IdentifiersMustBeASCII": true,
+    "NeverForceUnwrap": true,
+    "NeverUseForceTry": true,
+    "NeverUseImplicitlyUnwrappedOptionals": true,
+    "NoLeadingUnderscores": true,
+    "OnlyOneTrailingClosureArgument": true,
+    "UseLetInEveryBoundCaseVariable": true,
+    "UseSynthesizedInitializer": true,
+    "ValidateDocumentationComments": true,
+  ]
+}

Sources/SwiftFormatCore/FormatPipeline.swift

@@ -49,7 +49,7 @@ public final class FormatPipeline: SyntaxRewriter, Pipeline {
   public func addFormatter(_ formatType: SyntaxFormatRule.Type, for syntaxTypes: Syntax.Type...) {
     for type in syntaxTypes {
       let formatter = formatType.init(context: context)
-
+      guard let enabled = context.configuration.rules[formatter.ruleName], enabled else { continue }
       // TODO(b/77533378): Respect priority of inserted Formatting passes. Should this be sorted on
       //                   insertion based on the priority of the pass type?
       passMap[SyntaxType(type: type), default: []].append(formatter.visit)

Sources/SwiftFormatCore/LintPipeline.swift

@@ -51,6 +51,7 @@ public final class LintPipeline: SyntaxVisitor, Pipeline {
   public func addLinter(_ lintRule: SyntaxLintRule.Type, for syntaxTypes: Syntax.Type...) {
     for type in syntaxTypes {
       let rule = lintRule.init(context: context)
+      guard let enabled = context.configuration.rules[rule.ruleName], enabled else { continue }
       passMap[SyntaxType(type: type), default: []].append(.linter(rule))
     }
   }
@@ -64,6 +65,7 @@ public final class LintPipeline: SyntaxVisitor, Pipeline {
   public func addFormatter(_ formatRule: SyntaxFormatRule.Type, for syntaxTypes: Syntax.Type...) {
     for type in syntaxTypes {
       let rule = formatRule.init(context: context)
+      guard let enabled = context.configuration.rules[rule.ruleName], enabled else { continue }
       passMap[SyntaxType(type: type), default: []].append(.formatter(rule))
     }
   }

Sources/generate-pipeline/main.swift

@@ -19,6 +19,8 @@ let sourcesDir = URL(fileURLWithPath: #file)
 let rulesDir =  sourcesDir.appendingPathComponent("SwiftFormatRules")
 let outputFile =  sourcesDir.appendingPathComponent("SwiftFormat")
                             .appendingPathComponent("PopulatePipeline.swift")
+let ruleRegistryFile = sourcesDir.appendingPathComponent("SwiftFormatConfiguration")
+                                 .appendingPathComponent("RuleRegistry.swift")
 let fm = FileManager.default
 
 // These rules will not be added to the pipeline
@@ -182,3 +184,45 @@ for (className, types) in registry.lintingPasses.sorted(by: { $0.key < $1.key })
   )
 }
 handle.write("}\n")
+
+// Generate rule registry dictionary for configuration
+
+// Delete the existing ruleRegistry file.
+if fm.fileExists(atPath: ruleRegistryFile.path) {
+  try fm.removeItem(at: ruleRegistryFile)
+}
+fm.createFile(atPath: ruleRegistryFile.path, contents: nil, attributes: nil)
+let registryHandle = try FileHandle(forWritingTo: ruleRegistryFile)
+
+registryHandle.write(
+  """
+  //===----------------------------------------------------------------------===//
+  //
+  // This source file is part of the Swift.org open source project
+  //
+  // Copyright (c) 2014 - 2018 Apple Inc. and the Swift project authors
+  // Licensed under Apache License v2.0 with Runtime Library Exception
+  //
+  // See https://swift.org/LICENSE.txt for license information
+  // See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
+  //
+  //===----------------------------------------------------------------------===//
+
+  // This file is automatically generated with generate-pipeline. Do Not Edit!
+
+  enum RuleRegistry {
+    static let rules: [String: Bool] = [
+
+  """
+)
+
+for fileRule in registry.filePasses.sorted() {
+  registryHandle.write("    \"\(fileRule)\": true,\n")
+}
+for (className, _) in registry.formattingPasses.sorted(by: { $0.key < $1.key }) {
+  registryHandle.write("    \"\(className)\": true,\n")
+}
+for (className, _) in registry.lintingPasses.sorted(by: { $0.key < $1.key }) {
+  registryHandle.write("    \"\(className)\": true,\n")
+}
+registryHandle.write("  ]\n}\n")