Make ConfigSchemaGen as a subcommand of sourcekit-lsp-dev-utils

Author: kateinoigakukun

SourceKitLSPDevUtils/Package.swift

@@ -0,0 +1,28 @@
+// swift-tools-version: 6.0
+
+import PackageDescription
+
+let package = Package(
+  name: "SourceKitLSPDevUtils",
+  platforms: [.macOS(.v10_15)],
+  products: [
+    .executable(name: "sourcekit-lsp-dev-utils", targets: ["SourceKitLSPDevUtils"]),
+  ],
+  dependencies: [
+    .package(url: "https://github.com/swiftlang/swift-syntax.git", from: "600.0.1"),
+    .package(url: "https://github.com/apple/swift-argument-parser.git", from: "1.5.0"),
+  ],
+  targets: [
+    .executableTarget(name: "SourceKitLSPDevUtils", dependencies: [
+      "ConfigSchemaGen",
+      .product(name: "ArgumentParser", package: "swift-argument-parser"),
+    ]),
+    .target(
+      name: "ConfigSchemaGen",
+      dependencies: [
+        .product(name: "SwiftSyntax", package: "swift-syntax"),
+        .product(name: "SwiftParser", package: "swift-syntax"),
+      ]
+    )
+  ]
+)

SourceKitLSPDevUtils/README.md

@@ -0,0 +1,3 @@
+# sourcekit-lsp-dev-utils
+
+This directory contains utilities for developing SourceKit-LSP.

Utilities/ConfigSchemaGen/Sources/ConfigSchemaGen/ConfigSchemaGen.swift renamed to SourceKitLSPDevUtils/Sources/ConfigSchemaGen/ConfigSchemaGen.swift

@@ -2,14 +2,16 @@ import Foundation
 import SwiftParser
 import SwiftSyntax
 
-@main
-struct ConfigSchemaGen {
+/// The main entry point for generating a JSON schema and Markdown documentation
+/// for the SourceKit-LSP configuration file format
+/// (`.sourcekit-lsp/config.json`) from the Swift type definitions in
+/// `SKOptions` Swift module.
+public struct ConfigSchemaGen {
   static let projectRoot = URL(fileURLWithPath: #filePath)
     .deletingLastPathComponent()
     .deletingLastPathComponent()
     .deletingLastPathComponent()
     .deletingLastPathComponent()
-    .deletingLastPathComponent()
   static let sourceDir =
     projectRoot
     .appendingPathComponent("Sources")
@@ -22,7 +24,7 @@ struct ConfigSchemaGen {
     .appendingPathComponent("Documentation")
     .appendingPathComponent("Configuration File.md")
 
-  static func main() throws {
+  public static func generate() throws {
     let sourceFiles = FileManager.default.enumerator(at: sourceDir, includingPropertiesForKeys: nil)!
     let typeNameResolver = TypeDeclResolver()
 

Utilities/ConfigSchemaGen/Sources/ConfigSchemaGen/JSONSchema.swift renamed to SourceKitLSPDevUtils/Sources/ConfigSchemaGen/JSONSchema.swift

@@ -0,0 +1,13 @@
+import ArgumentParser
+import ConfigSchemaGen
+
+struct GenerateConfigSchema: ParsableCommand {
+    static let configuration = CommandConfiguration(
+        commandName: "generate-config-schema",
+        abstract: "Generate a JSON schema and documentation for the SourceKit-LSP configuration file"
+    )
+
+    func run() throws {
+        try ConfigSchemaGen.generate()
+    }
+}

Utilities/ConfigSchemaGen/Sources/ConfigSchemaGen/OptionDocument.swift renamed to SourceKitLSPDevUtils/Sources/ConfigSchemaGen/OptionDocument.swift

@@ -0,0 +1,12 @@
+import ArgumentParser
+
+@main
+struct SourceKitLSPDevUtils: ParsableCommand {
+    static let configuration = CommandConfiguration(
+        commandName: "sourcekit-lsp-dev-utils",
+        abstract: "Utilities for developing SourceKit-LSP",
+        subcommands: [
+            GenerateConfigSchema.self,
+        ]
+    )
+}