Merge pull request #112 from tayloraswift/internal-imports

internal imports by default, only enable warnings as errors in CI

Author: tayloraswift

.github/workflows/Documentation.yml

@@ -15,20 +15,20 @@ jobs:
         name: Ubuntu 24.04
 
         steps:
-            -   name: Install Swift
+            -   name: 🤍 Install Swift 🤍
                 uses: tayloraswift/swift-install-action@master
                 with:
                     swift-prefix: "swift-6.2.4-release/ubuntu2404/swift-6.2.4-RELEASE"
                     swift-id: "swift-6.2.4-RELEASE-ubuntu24.04"
 
-            -   name: Install Unidoc
+            -   name: 🤍 Install Unidoc 🤍
                 uses: tayloraswift/swift-unidoc-action@master
 
             #   This clobbers everything in the current directory!
-            -   name: Checkout repository
-                uses: actions/checkout@v3
+            -   name: 🤍 Checkout repository 🤍
+                uses: actions/checkout@v6
 
-            -   name: Validate documentation
+            -   name: 🤍 Validate documentation 🤍
                 run: |
                     unidoc compile \
                     --swift-toolchain $SWIFT_INSTALLATION \
@@ -39,16 +39,16 @@ jobs:
         runs-on: macos-26
         name: macOS
         steps:
-            -   name: Install Unidoc
+            -   name: 🤍 Install Unidoc 🤍
                 uses: tayloraswift/swift-unidoc-action@master
 
-            -   name: Checkout repository
-                uses: actions/checkout@v3
+            -   name: 🤍 Checkout repository 🤍
+                uses: actions/checkout@v6
 
-            -   name: Select Xcode 26.3
+            -   name: 🤍 Select Xcode 26.3 🤍
                 run: sudo xcode-select -s /Applications/Xcode_26.3.app/Contents/Developer
 
-            -   name: Validate documentation
+            -   name: 🤍 Validate documentation 🤍
                 run: |
                     unidoc build \
                     --ci fail-on-errors \

.github/workflows/Tests.yml

@@ -7,31 +7,56 @@ on:
         branches: [ master ]
 
 jobs:
+    changes:
+        runs-on: ubuntu-latest
+        name: Assess changes
+        steps:
+            -   name: 💖 Checkout repository 💖
+                uses: actions/checkout@v6
+
+            -   name: 💖 Decide checks 💖
+                uses: tj-actions/changed-files@v47
+                id: changes
+                with:
+                    files_ignore: |
+                        README.md
+                        LICENSE
+                        NOTICE
+                        .mailmap
+                        .gitignore
+                        .github/FUNDING.yml
+        outputs:
+            code_changed: ${{ steps.changes.outputs.any_changed }}
+
     linux:
         runs-on: ubuntu-24.04
         name: Ubuntu 24.04
+        needs: changes
+        if: ${{ needs.changes.outputs.code_changed == 'true' }}
         steps:
-            -   name: Install Swift
+            -   name: 💖 Install Swift 💖
                 uses: tayloraswift/swift-install-action@master
                 with:
                     swift-prefix: "swift-6.2.4-release/ubuntu2404/swift-6.2.4-RELEASE"
                     swift-id: "swift-6.2.4-RELEASE-ubuntu24.04"
 
-            -   name: Checkout repository
-                uses: actions/checkout@v3
+            -   name: 💖 Checkout repository 💖
+                uses: actions/checkout@v6
 
-            -   name: Run tests
+            -   name: 💖 Run tests 💖
                 run: Scripts/TestAll
 
     macos:
         runs-on: macos-26
         name: macOS
+        needs: changes
+        if: ${{ needs.changes.outputs.code_changed == 'true' }}
         steps:
-            -   name: Checkout repository
-                uses: actions/checkout@v3
+            -   name: 💖 Checkout repository 💖
+                uses: actions/checkout@v6
 
-            -   name: Select Xcode 26.3
+            -   name: 💖 Select Xcode 26.3 💖
                 run: sudo xcode-select -s /Applications/Xcode_26.3.app/Contents/Developer
 
-            -   name: Run tests
+            -   name: 💖 Run tests 💖
                 run: Scripts/TestAll

Package.swift

@@ -1,4 +1,5 @@
 // swift-tools-version:6.2
+import class Foundation.ProcessInfo
 import PackageDescription
 
 let package: Package = .init(
@@ -85,6 +86,14 @@ let package: Package = .init(
         ),
     ]
 )
+
+var WarningsAsErrors: Bool {
+    switch ProcessInfo.processInfo.environment["WARNINGS_AS_ERRORS"] {
+    case "true"?: true
+    case "1"?: true
+    default: false
+    }
+}
 package.targets = package.targets.map {
     switch $0.type {
     case .plugin: return $0
@@ -95,8 +104,12 @@ package.targets = package.targets.map {
         var settings: [SwiftSetting] = $0 ?? []
 
         settings.append(.enableUpcomingFeature("ExistentialAny"))
-        settings.append(.treatWarning("ExistentialAny", as: .error))
-        settings.append(.treatWarning("MutableGlobalVariable", as: .error))
+        settings.append(.enableUpcomingFeature("InternalImportsByDefault"))
+
+        if  WarningsAsErrors {
+            settings.append(.treatWarning("ExistentialAny", as: .error))
+            settings.append(.treatWarning("MutableGlobalVariable", as: .error))
+        }
 
         $0 = settings
     } (&$0.swiftSettings)

Scripts/TestAll

@@ -1,5 +1,9 @@
 #!/bin/bash
-set -e
+set -euo pipefail
+
+export WARNINGS_AS_ERRORS=1
+
 swift --version
 swift test
-swift build -c release
+swift build -c release \
+    --explicit-target-dependency-import-check=error

Sources/JSONDecoding/Decoding/JSON.DecodingError.swift

@@ -1,4 +1,4 @@
-import TraceableErrors
+public import TraceableErrors
 
 extension JSON {
     /// An error occurred while decoding a document field.

Sources/JSONParsing/JSON.Array (ext).swift

@@ -1,4 +1,4 @@
-import Grammar
+internal import Grammar
 import JSONAST
 
 extension JSON.Array {

Sources/JSONParsing/JSON.Node (ext).swift

@@ -1,4 +1,4 @@
-import Grammar
+internal import Grammar
 import JSONAST
 
 extension JSON.Node {

Sources/JSONParsing/JSON.Object (ext).swift

@@ -1,4 +1,4 @@
-import Grammar
+internal import Grammar
 import JSONAST
 
 extension JSON.Object {

Sources/JSONParsing/Rules/JSON (ext).swift

@@ -1,4 +1,4 @@
-import Grammar
+internal import Grammar
 
 extension JSON {
     typealias CommaRule<Location> =

Sources/JSONParsing/Rules/JSON.NodeRule.Array.swift

@@ -1,4 +1,4 @@
-import Grammar
+internal import Grammar
 
 extension JSON.NodeRule {
     /// Matches an array literal.