Merge pull request #1033 from apollographql/add/docgen_script

Rename SwiftScript folder, add stub for doc generator
apollographql · Feb 21, 2020 · 7eb2f3c · 7eb2f3c
2 parents 8bcb3c6 + 9ef1cf8
commit 7eb2f3c
Show file tree

Hide file tree

Showing 12 changed files with 19 additions and 13 deletions.
diff --git a/.gitignore b/.gitignore
@@ -55,4 +55,4 @@ node_modules/
 package-lock.json
 scripts/apollo
 scripts/apollo.tar.gz
-Codegen/ApolloCLI
+SwiftScripts/ApolloCLI
diff --git a/Apollo.xcodeproj/project.pbxproj b/Apollo.xcodeproj/project.pbxproj
@@ -1619,7 +1619,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "cd \"${SRCROOT}/Codegen\"\nswift run Codegen -t \"GitHub\"\n";
+			shellScript = "cd \"${SRCROOT}/SwiftScripts\"\nswift run Codegen -t \"GitHub\"\n";
 		};
 		9FCE2D061E6C251100E34457 /* Generate Apollo Client API */ = {
 			isa = PBXShellScriptBuildPhase;
@@ -1633,7 +1633,7 @@
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 			shellPath = /bin/sh;
-			shellScript = "cd \"${SRCROOT}/Codegen\"\nswift run Codegen -t \"StarWars\"\n";
+			shellScript = "cd \"${SRCROOT}/SwiftScripts\"\nswift run Codegen -t \"StarWars\"\n";
 			showEnvVarsInLog = 0;
 		};
 /* End PBXShellScriptBuildPhase section */

diff --git a/Codegen/ApolloCLI/.keep → SwiftScripts/ApolloCLI/.keep b/Codegen/ApolloCLI/.keep → SwiftScripts/ApolloCLI/.keep
diff --git a/Codegen/Package.resolved → SwiftScripts/Package.resolved b/Codegen/Package.resolved → SwiftScripts/Package.resolved
diff --git a/Codegen/Package.swift → SwiftScripts/Package.swift b/Codegen/Package.swift → SwiftScripts/Package.swift
@@ -7,14 +7,16 @@ let package = Package(
     name: "Codegen",
     dependencies: [
         .package(path: ".."),
-        .package(url: "https://github.com/apple/swift-tools-support-core", from: "0.0.1")
+        .package(url: "https://github.com/apple/swift-tools-support-core", from: "0.0.1"),
     ],
     targets: [
         .target(
             name: "Codegen",
             dependencies: ["ApolloCodegenLib", "SwiftToolsSupport-auto"]),
         .target(name: "SchemaDownload",
                 dependencies: ["ApolloCodegenLib"]),
+        .target(name: "DocumentationGenerator",
+                dependencies: []),
         .testTarget(
             name: "CodegenTests",
             dependencies: ["Codegen"]),

diff --git a/Codegen/README.md → SwiftScripts/README.md b/Codegen/README.md → SwiftScripts/README.md
diff --git a/Codegen/Sources/Codegen/ArgumentSetup.swift → ...ripts/Sources/Codegen/ArgumentSetup.swift b/Codegen/Sources/Codegen/ArgumentSetup.swift → ...ripts/Sources/Codegen/ArgumentSetup.swift
diff --git a/Codegen/Sources/Codegen/main.swift → SwiftScripts/Sources/Codegen/main.swift b/Codegen/Sources/Codegen/main.swift → SwiftScripts/Sources/Codegen/main.swift
@@ -8,7 +8,7 @@ let parentFolderOfScriptFile = FileFinder.findParentFolder()
 // Use that to calculate the source root
 let sourceRootURL = parentFolderOfScriptFile
     .deletingLastPathComponent() // Sources
-    .deletingLastPathComponent() // Codegen
+    .deletingLastPathComponent() // SwiftScripts
     .deletingLastPathComponent() // apollo-ios
 
 // In a typical app, you'll only need to do this for one target, so you'd
@@ -25,7 +25,7 @@ try FileManager.default.apollo_createFolderIfNeeded(at: targetURL)
 
 // Calculate where you want to download the CLI folder.
 let cliFolderURL = sourceRootURL
-    .appendingPathComponent("Codegen")
+    .appendingPathComponent("SwiftScripts")
     .appendingPathComponent("ApolloCLI")
 
 do {

diff --git a/SwiftScripts/Sources/DocumentationGenerator/main.swift b/SwiftScripts/Sources/DocumentationGenerator/main.swift
@@ -0,0 +1,4 @@
+import Foundation
+
+// TODO: Create this when I can import Sourcedocs as a library.
+
diff --git a/Codegen/Sources/SchemaDownload/main.swift → ...Scripts/Sources/SchemaDownload/main.swift b/Codegen/Sources/SchemaDownload/main.swift → ...Scripts/Sources/SchemaDownload/main.swift
@@ -7,11 +7,11 @@ let parentFolderOfScriptFile = FileFinder.findParentFolder()
 // Use that to calculate the source root
 let sourceRootURL = parentFolderOfScriptFile
     .deletingLastPathComponent() // Sources
-    .deletingLastPathComponent() // Codegen
+    .deletingLastPathComponent() // SwiftScripts
     .deletingLastPathComponent() // apollo-ios
 
 let cliFolderURL = sourceRootURL
-    .appendingPathComponent("Codegen")
+    .appendingPathComponent("SwiftScripts")
     .appendingPathComponent("ApolloCLI")
 
 let endpoint = URL(string: "http://localhost:8080/graphql")!

diff --git a/...gen/Tests/CodegenTests/CodegenTests.swift → ...pts/Tests/CodegenTests/CodegenTests.swift b/...gen/Tests/CodegenTests/CodegenTests.swift → ...pts/Tests/CodegenTests/CodegenTests.swift
diff --git a/docs/source/api-reference.md b/docs/source/api-reference.md
@@ -30,7 +30,7 @@ sourcedocs generate \
     --link-ending "/" \
     -- \
     -scheme Apollo \
-    -workspace Apollo.xcworkspace
+    -project Apollo.xcodeproj
 ```
 
 To generate docs for the `ApolloCodegenLib` project, `cd` into the source root and run: 
@@ -41,7 +41,7 @@ sourcedocs generate \
     --link-ending "/" \
     -- \
     -scheme ApolloCodegenLib \
-    -workspace Apollo.xcworkspace
+    -project Apollo.xcodeproj
 ```
 
 
@@ -53,7 +53,7 @@ sourcedocs generate \
     --link-ending "/" \
     -- \
     -scheme ApolloSQLite \
-    -workspace Apollo.xcworkspace
+    -project Apollo.xcodeproj
 ```
 
 To generate for docs the `ApolloWebSocket` project, `cd` into the source root and run: 
@@ -64,7 +64,7 @@ sourcedocs generate \
     --link-ending "/" \
     -- \
     -scheme ApolloWebSocket \
-    -workspace Apollo.xcworkspace
+    -project Apollo.xcodeproj
 ```
 
 ## From Source Instructions
@@ -85,5 +85,5 @@ swift run sourcedocs generate \
     --link-ending "/" \
     -- \
     -scheme "ApolloWebSocket" \
-    -workspace "Apollo.xcworkspace"
+    -project "Apollo.xcodeproj"
 ``