Rename IfConfigError -> IfConfigDiagnostic

Author: DougGregor

Sources/SwiftIfConfig/CMakeLists.txt

@@ -13,7 +13,7 @@ add_swift_syntax_library(SwiftIfConfig
   ConfiguredRegions.swift
   IfConfigRegionState.swift
   IfConfigDecl+IfConfig.swift
-  IfConfigError.swift
+  IfConfigDiagnostic.swift
   IfConfigEvaluation.swift
   IfConfigFunctions.swift
   SyntaxLiteralUtils.swift

Sources/SwiftIfConfig/IfConfigError.swift renamed to Sources/SwiftIfConfig/IfConfigDiagnostic.swift

@@ -14,8 +14,11 @@ import SwiftDiagnostics
 import SwiftSyntax
 import SwiftSyntaxBuilder
 
-/// Describes the kinds of errors that can occur when processing #if conditions.
-enum IfConfigError: Error, CustomStringConvertible {
+/// Describes the kinds of diagnostics that can occur when processing #if
+/// conditions. This is an Error-conforming type so we can throw errors when
+/// needed, but the cases themselves are a mix of warnings and errors when
+/// rendered as a diagnostic.
+enum IfConfigDiagnostic: Error, CustomStringConvertible {
   case unknownExpression(ExprSyntax)
   case unhandledFunction(name: String, syntax: ExprSyntax)
   case requiresUnlabeledArgument(name: String, role: String, syntax: ExprSyntax)
@@ -134,11 +137,11 @@ enum IfConfigError: Error, CustomStringConvertible {
   }
 }
 
-extension IfConfigError: DiagnosticMessage {
+extension IfConfigDiagnostic: DiagnosticMessage {
   var message: String { description }
 
   var diagnosticID: MessageID {
-    .init(domain: "SwiftIfConfig", id: "IfConfigError")
+    .init(domain: "SwiftIfConfig", id: "IfConfigDiagnostic")
   }
 
   var severity: SwiftDiagnostics.DiagnosticSeverity {

Sources/SwiftIfConfig/IfConfigEvaluation.swift

@@ -49,7 +49,7 @@ func evaluateIfConfig(
   /// Record an if-config evaluation error before returning it. Use this for
   /// every 'throw' site in this evaluation.
   func recordError(
-    _ error: IfConfigError
+    _ error: IfConfigDiagnostic
   ) -> (active: Bool, syntaxErrorsAllowed: Bool, diagnostics: [Diagnostic]) {
     return recordError(error, at: error.syntax)
   }
@@ -87,7 +87,7 @@ func evaluateIfConfig(
       active: result,
       syntaxErrorsAllowed: false,
       diagnostics: [
-        IfConfigError.integerLiteralCondition(
+        IfConfigDiagnostic.integerLiteralCondition(
           syntax: condition,
           replacement: result
         ).asDiagnostic
@@ -234,7 +234,7 @@ func evaluateIfConfig(
       // The historical "macabi" environment has been renamed to "macCatalyst".
       if role == "environment" && arg == "macabi" {
         extraDiagnostics.append(
-          IfConfigError.macabiIsMacCatalyst(syntax: argExpr)
+          IfConfigDiagnostic.macabiIsMacCatalyst(syntax: argExpr)
             .asDiagnostic
         )
 
@@ -335,7 +335,7 @@ func evaluateIfConfig(
       } else {
         // Complain about unknown endianness
         extraDiagnostics.append(
-          IfConfigError.endiannessDoesNotMatch(syntax: argExpr, argument: arg)
+          IfConfigDiagnostic.endiannessDoesNotMatch(syntax: argExpr, argument: arg)
             .asDiagnostic
         )
 
@@ -466,7 +466,7 @@ func evaluateIfConfig(
 
           // Warn that we did this.
           extraDiagnostics.append(
-            IfConfigError.ignoredTrailingComponents(
+            IfConfigDiagnostic.ignoredTrailingComponents(
               version: versionTuple,
               syntax: secondArg.expression
             ).asDiagnostic
@@ -542,7 +542,7 @@ private func extractImportPath(_ expression: some ExprSyntaxProtocol) throws ->
     return [name]
   }
 
-  throw IfConfigError.expectedModuleName(syntax: ExprSyntax(expression))
+  throw IfConfigDiagnostic.expectedModuleName(syntax: ExprSyntax(expression))
 }
 
 /// Determine whether the given condition only involves disjunctions that
@@ -624,7 +624,7 @@ private func diagnoseLikelySimulatorEnvironmentTest(
     return nil
   }
 
-  return IfConfigError.likelySimulatorPlatform(syntax: ExprSyntax(binOp)).asDiagnostic
+  return IfConfigDiagnostic.likelySimulatorPlatform(syntax: ExprSyntax(binOp)).asDiagnostic
 }
 
 extension IfConfigClauseSyntax {
@@ -643,7 +643,7 @@ extension IfConfigClauseSyntax {
       {
 
         foldingDiagnostics.append(
-          IfConfigError.badInfixOperator(syntax: ExprSyntax(binOp)).asDiagnostic
+          IfConfigDiagnostic.badInfixOperator(syntax: ExprSyntax(binOp)).asDiagnostic
         )
         return
       }

Sources/SwiftIfConfig/VersionTuple+Parsing.swift

@@ -58,7 +58,7 @@ extension VersionTuple {
     func recordComponent(_ value: Int) throws {
       let limit = components.isEmpty ? 9223371 : 999
       if value < 0 || value > limit {
-        throw IfConfigError.compilerVersionOutOfRange(value: value, upperLimit: limit, syntax: versionSyntax)
+        throw IfConfigDiagnostic.compilerVersionOutOfRange(value: value, upperLimit: limit, syntax: versionSyntax)
       }
 
       components.append(value)
@@ -68,14 +68,14 @@ extension VersionTuple {
     for (index, componentString) in componentStrings.enumerated() {
       // Check ahead of time for empty version components
       if componentString.isEmpty {
-        throw IfConfigError.emptyVersionComponent(syntax: versionSyntax)
+        throw IfConfigDiagnostic.emptyVersionComponent(syntax: versionSyntax)
       }
 
       // The second component is always "*", and is never used for comparison.
       if index == 1 {
         if componentString != "*" {
           extraDiagnostics.append(
-            IfConfigError.compilerVersionSecondComponentNotWildcard(syntax: versionSyntax).asDiagnostic
+            IfConfigDiagnostic.compilerVersionSecondComponentNotWildcard(syntax: versionSyntax).asDiagnostic
           )
         }
         try recordComponent(0)
@@ -84,15 +84,15 @@ extension VersionTuple {
 
       // Every other component must be an integer value.
       guard let component = Int(componentString) else {
-        throw IfConfigError.invalidVersionOperand(name: "_compiler_version", syntax: versionSyntax)
+        throw IfConfigDiagnostic.invalidVersionOperand(name: "_compiler_version", syntax: versionSyntax)
       }
 
       try recordComponent(component)
     }
 
     // Only allowed to specify up to 5 version components.
     if components.count > 5 {
-      throw IfConfigError.compilerVersionTooManyComponents(syntax: versionSyntax)
+      throw IfConfigDiagnostic.compilerVersionTooManyComponents(syntax: versionSyntax)
     }
 
     // In the beginning, '_compiler_version(string-literal)' was designed for a