Merge pull request #5 from sdidla/prepare_509.0.0

Prepare 509.0.0 release

Author: sdidla

.circleci/config.yml

@@ -27,15 +27,15 @@ jobs:
       - run: 
           name: Generate documentation 
           command: |
-                    mkdir -p "rendered/docs/HatchParser"
+                    mkdir -p "rendered/docs/Hatch"
                     swift package \
-                        --allow-writing-to-directory "rendered/docs/HatchParser" \
+                        --allow-writing-to-directory "rendered/docs/Hatch" \
                         generate-documentation \
                         --target HatchParser \
                         --disable-indexing \
                         --transform-for-static-hosting \
-                        --hosting-base-path "/Hatch/docs/HatchParser/" \
-                        --output-path "rendered/docs/HatchParser"
+                        --hosting-base-path "/Hatch/docs/Hatch/" \
+                        --output-path "rendered/docs/Hatch"
       - run:
             name: Install dependencies
             command: |

.swiftpm/xcode/xcshareddata/xcschemes/Hatch-Package.xcscheme

@@ -80,6 +80,16 @@
                ReferencedContainer = "container:">
             </BuildableReference>
          </TestableReference>
+         <TestableReference
+            skipped = "NO">
+            <BuildableReference
+               BuildableIdentifier = "primary"
+               BlueprintIdentifier = "HatchTests"
+               BuildableName = "HatchTests"
+               BlueprintName = "HatchTests"
+               ReferencedContainer = "container:">
+            </BuildableReference>
+         </TestableReference>
       </Testables>
    </TestAction>
    <LaunchAction

.swiftpm/xcode/xcshareddata/xcschemes/HatchParser.xcscheme

@@ -9,35 +9,21 @@ let package = Package(
     platforms: [.iOS(.v13), .macOS(.v10_15)],
     products: [
         .executable(name: "HatchExample", targets: ["HatchExample"]),
-        .library(name: "HatchParser", targets: ["HatchParser"]),
-        .library(name: "HatchBuilder", targets: ["HatchBuilder"]),
+        .library(name: "Hatch", targets: ["Hatch"]),
     ],
     dependencies: [
         .package(name: "swift-syntax", url: "https://github.com/apple/swift-syntax.git", from: "509.0.0")
     ],
     targets: [
-        .executableTarget(
-            name: "HatchExample",
-            dependencies: [
-                .target(name: "HatchParser"),
-                .target(name: "HatchBuilder")
-            ]
-        ),
+        .executableTarget(name: "HatchExample", dependencies: [.target(name: "Hatch")]),
         .target(
-            name: "HatchParser",
+            name: "Hatch",
             dependencies: [
                 .product(name: "SwiftSyntax", package: "swift-syntax"),
                 .product(name: "SwiftParser", package: "swift-syntax")
             ]
         ),
-        .target(
-            name: "HatchBuilder"
-        ),
-
-        .testTarget(
-            name: "HatchParserTests",
-            dependencies: ["HatchParser"]
-        )
+        .testTarget(name: "HatchTests", dependencies: ["Hatch"])
     ]
 )
 

Package.swift

@@ -3,24 +3,28 @@
 
 # Hatch
 
-Generate Swift using Swift.
-
-This package contains two modules:
-- `HatchParser` Provides a simple, extensible parser to to get a hierarchical list of symbols from swift code using [SwiftSyntax](https://github.com/apple/swift-syntax)
-- `HatchBuilder` Provides a string concatenating `resultBuidler` so expressions can be interspersed with strings 
+A simple, extensible parser to to get a hierarchical list of symbols from swift code using [SwiftSyntax](https://github.com/apple/swift-syntax)
 
 ## Documentation
 
-- [`HatchParser`](https://sdidla.github.io/Hatch/docs/HatchParser/documentation/hatchparser/)
-   
+- [Hatch Documentation](https://sdidla.github.io/Hatch/docs/Hatch/documentation/hatch/)
+
+## Usage
+
+When using Swift Package Manager, add the following to your package dependencies in the `Package.swift` file:
+
+```swift
+  .package(url: "https://github.com/sdidla/Hatch.git", from: "<#latest swift-syntax tag#>")
+```
+
 ## Releases
 
 Hatch [releases](https://github.com/sdidla/Hatch/releases/) correspond to releases of [SwiftSyntax](https://github.com/apple/swift-syntax)
 
 ## Example
 
 ```swift
-import HatchParser
+import Hatch
 
 let source: String = <some swift code>
 let symbols = SymbolParser.parse(source: source)
@@ -55,49 +59,48 @@ Output:
 
 ```
 ▿ 3 elements
-  ▿ HatchParser.Struct
+  ▿ Hatch.Struct
     - name: "A1"
     ▿ children: 3 elements
-      ▿ HatchParser.Struct
+      ▿ Hatch.Struct
         - name: "BC"
         ▿ children: 3 elements
-          ▿ HatchParser.Struct
+          ▿ Hatch.Struct
             - name: "C1"
             - children: 0 elements
             - inheritedTypes: 0 elements
-          ▿ HatchParser.Struct
+          ▿ Hatch.Struct
             - name: "C2"
             - children: 0 elements
             - inheritedTypes: 0 elements
-          ▿ HatchParser.Struct
+          ▿ Hatch.Struct
             - name: "C3"
             - children: 0 elements
             - inheritedTypes: 0 elements
         - inheritedTypes: 0 elements
-      ▿ HatchParser.Struct
+      ▿ Hatch.Struct
         - name: "BD"
         ▿ children: 2 elements
-          ▿ HatchParser.Struct
+          ▿ Hatch.Struct
             - name: "D1"
             - children: 0 elements
             - inheritedTypes: 0 elements
-          ▿ HatchParser.Struct
+          ▿ Hatch.Struct
             - name: "D2"
             - children: 0 elements
             - inheritedTypes: 0 elements
         - inheritedTypes: 0 elements
-      ▿ HatchParser.Struct
+      ▿ Hatch.Struct
         - name: "BX"
         - children: 0 elements
         - inheritedTypes: 0 elements
     - inheritedTypes: 0 elements
-  ▿ HatchParser.Struct
+  ▿ Hatch.Struct
     - name: "A2"
     - children: 0 elements
     - inheritedTypes: 0 elements
-  ▿ HatchParser.Enum
+  ▿ Hatch.Enum
     - name: "MyEnum"
     - children: 0 elements
     - inheritedTypes: 0 elements
-
 ```

README.md

@@ -1,13 +1,13 @@
-# ``HatchParser``
+# ``Hatch``
 
-HatchParser is a simple, extensible symbol parser based on `SwiftSyntax`
+Hatch is a simple, extensible symbol parser based on `SwiftSyntax`
 
 ## Usage
 
 Extracting symbols from a string or contents of a file using ``SymbolParser/parse(source:)``
 
 ```swift
-import HatchParser
+import Hatch
 
 let path = "~/Repositories/myProject"
 let directoryURL = URL(fileURLWithPath: path)
@@ -22,7 +22,7 @@ let allSymbols = try FileManager.default
 dump(allSymbols)
 ```
 
-You can use swift standard library methods to `filter`, `map`, `compactMap` etc. `HatchParser` provides an additional method on a collection of symbols called ``Symbol/flattened()`` that returns a flat array of symbols derived from the symbol tree while preserving the subtree
+You can use swift standard library methods to `filter`, `map`, `compactMap` etc. `Hatch` provides an additional method on a collection of symbols called ``Symbol/flattened()`` that returns a flat array of symbols derived from the symbol tree while preserving the subtree
 
 For example, to extract all the enum case elements from a specific enum, you can do:
 

Sources/HatchParser/Documentation.docc/HatchParser.md Sources/Hatch/Documentation.docc/Hatch.md

@@ -1,5 +1,27 @@
 import Foundation
 
+/// Provides string concatenation support to make it easier to generate swift code
+///
+/// Example:
+/// ```swift
+/// @StringBuilder var myFile: String {
+///     """
+///     switch symbol {
+///     """
+///
+///     for symbol in symbolNames {
+///     """
+///         case \(symbol)
+///     """
+///     }
+///
+///     """
+///     }
+///     """
+/// }
+///
+/// try myFile.write(toFile: "myFile.swift", atomically: true, encoding: .utf8)
+/// ```
 @resultBuilder public struct StringBuilder {
     static public func buildBlock(_ components: String?...) -> String? {
         return components.compactMap { $0 }.joined(separator: "\n")

Sources/HatchParser/Scope.swift Sources/Hatch/Scope.swift

@@ -1,7 +1,6 @@
 import Foundation
-import HatchParser
-import HatchBuilder
 import SwiftSyntax
+import Hatch
 
 @main
 public struct ExampleApp {

Sources/HatchBuilder/CodeBuilder.swift Sources/Hatch/StringBuilder.swift

@@ -1,5 +1,5 @@
 import XCTest
-@testable import HatchParser
+@testable import Hatch
 
 final class SymbolVisitorTests: XCTestCase {