Renamed the library to SwiftSource

ikhvorost · ikhvorost · commit 726825a96fa2 · 2024-02-21T18:12:43.000+02:00
diff --git a/Package.swift b/Package.swift
@@ -13,7 +13,7 @@ let package = Package(
     .watchOS(.v6)
   ],
   products: [
-    .library(name: "SwiftDocCoverage", targets: ["SwiftDocCoverage"]),
+    .library(name: "SwiftSource", targets: ["SwiftSource"]),
     .executable(name: "swift-doc-coverage", targets: ["swift-doc-coverage"])
   ],
   dependencies: [
@@ -22,7 +22,7 @@ let package = Package(
   ],
   targets: [
     .target(
-      name: "SwiftDocCoverage",
+      name: "SwiftSource",
       dependencies: [
         .product(name: "SwiftSyntax", package: "swift-syntax"),
         .product(name: "SwiftParser", package: "swift-syntax"),
@@ -31,7 +31,7 @@ let package = Package(
     .executableTarget(
       name: "swift-doc-coverage",
       dependencies: [
-        .target(name: "SwiftDocCoverage"),
+        .target(name: "SwiftSource"),
         .product(name: "ArgumentParser", package: "swift-argument-parser")
       ]
     ),
diff --git a/Sources/SwiftSource/Coverage.swift b/Sources/SwiftSource/Coverage.swift
@@ -30,7 +30,7 @@ extension String : LocalizedError {
 
 public struct Coverage {
   let urls: [URL]
-  let minAccessLevel: AccessLevel
+  let minAccessLevel: SwiftAccessLevel
   let output: Output
   
   private static func files(path: String, ext: String, skipsHiddenFiles: Bool, ignoreFilenameRegex: String) throws -> [URL]  {
@@ -42,7 +42,9 @@ public struct Coverage {
     if isDirectory.boolValue {
       var urls = [URL]()
       
-      let regex: NSRegularExpression? = ignoreFilenameRegex.isEmpty ? nil : try NSRegularExpression(pattern: ignoreFilenameRegex)
+      let regex: NSRegularExpression? = ignoreFilenameRegex.isEmpty 
+        ? nil
+        : try NSRegularExpression(pattern: ignoreFilenameRegex)
       
       let url = URL(fileURLWithPath: path)
       let resourceKeys = Set<URLResourceKey>([.nameKey, .isDirectoryKey])
@@ -86,7 +88,7 @@ public struct Coverage {
     return formatter
   }()
   
-  public init(paths: [String], skipsHiddenFiles: Bool = true, ignoreFilenameRegex: String = "", minAccessLevel: AccessLevel = .public, output: Output = TerminalOutput()) throws {
+  public init(paths: [String], skipsHiddenFiles: Bool = true, ignoreFilenameRegex: String = "", minAccessLevel: SwiftAccessLevel = .public, output: Output = TerminalOutput()) throws {
     self.urls = try paths.flatMap {
       try Self.files(path: $0, ext: ".swift", skipsHiddenFiles: skipsHiddenFiles, ignoreFilenameRegex: ignoreFilenameRegex)
     }
@@ -126,7 +128,7 @@ public struct Coverage {
     try urls.forEach { url in
       let time = Date()
       
-      let source = try Source(url: url)
+      let source = try SwiftSource(url: url)
       
       guard source.declarations.count > 0 else {
         return
diff --git a/Sources/SwiftSource/DeclProtocol.swift b/Sources/SwiftSource/DeclProtocol.swift
@@ -28,7 +28,7 @@ protocol DeclProtocol: DeclSyntaxProtocol {
   
   // var attributes: AttributeListSyntax
   var modifiers: DeclModifierListSyntax { get }
-  var keyword: Keyword { get }
+  var keyword: SwiftKeyword { get }
   var name: TokenSyntax { get }
   
   var genericParameterClause: GenericParameterClauseSyntax? { get }
@@ -43,50 +43,50 @@ extension DeclProtocol {
   var funcSignature: FunctionSignatureSyntax? { nil }
   var genericWhereClause: GenericWhereClauseSyntax? { nil }
   
-  var comments: [Comment] {
-    leadingTrivia.compactMap { Comment(piece: $0) }
+  var comments: [SwiftComment] {
+    leadingTrivia.compactMap { SwiftComment(piece: $0) }
   }
-  var accessLevel: AccessLevel { AccessLevel(modifiers: modifiers) }
+  var accessLevel: SwiftAccessLevel { SwiftAccessLevel(modifiers: modifiers) }
 }
 
 // MARK: -
 
 extension TypeAliasDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .typealias }
+  var keyword: SwiftKeyword { .typealias }
 }
 
 extension AssociatedTypeDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .associatedtype }
+  var keyword: SwiftKeyword { .associatedtype }
 }
 
 extension ClassDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .class }
+  var keyword: SwiftKeyword { .class }
 }
 
 extension ActorDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .actor }
+  var keyword: SwiftKeyword { .actor }
 }
 
 extension StructDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .struct }
+  var keyword: SwiftKeyword { .struct }
 }
 
 extension ProtocolDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .protocol }
+  var keyword: SwiftKeyword { .protocol }
 }
 
 extension ExtensionDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .extension }
+  var keyword: SwiftKeyword { .extension }
   var name: TokenSyntax { TokenSyntax(.identifier(extendedType.trimmedDescription), presence: .present)}
 }
 
 extension FunctionDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .func }
+  var keyword: SwiftKeyword { .func }
   var funcSignature: FunctionSignatureSyntax? { signature }
 }
 
 extension InitializerDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .`init` }
+  var keyword: SwiftKeyword { .`init` }
   
   var name: TokenSyntax {
     let optionalMark = optionalMark?.trimmedDescription ?? ""
@@ -97,7 +97,7 @@ extension InitializerDeclSyntax: DeclProtocol {
 }
 
 extension SubscriptDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .subscript }
+  var keyword: SwiftKeyword { .subscript }
   
   var name: TokenSyntax {
     TokenSyntax(.identifier("subscript"), presence: .present)
@@ -109,7 +109,7 @@ extension SubscriptDeclSyntax: DeclProtocol {
 }
 
 extension VariableDeclSyntax: DeclProtocol {
-  var keyword: Keyword { Keyword(token: bindingSpecifier)! }
+  var keyword: SwiftKeyword { SwiftKeyword(token: bindingSpecifier)! }
   
   var name: TokenSyntax {
     let name = bindings.map { $0.pattern.trimmedDescription }.joined(separator: ",")
@@ -118,11 +118,11 @@ extension VariableDeclSyntax: DeclProtocol {
 }
 
 extension EnumDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .enum }
+  var keyword: SwiftKeyword { .enum }
 }
 
 extension EnumCaseDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .case }
+  var keyword: SwiftKeyword { .case }
   
   var name: TokenSyntax {
     let name = elements.map {
@@ -135,10 +135,10 @@ extension EnumCaseDeclSyntax: DeclProtocol {
 }
 
 extension PrecedenceGroupDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .precedencegroup }
+  var keyword: SwiftKeyword { .precedencegroup }
 }
 
 extension MacroDeclSyntax: DeclProtocol {
-  var keyword: Keyword { .macro }
+  var keyword: SwiftKeyword { .macro }
   var funcSignature: FunctionSignatureSyntax? { signature }
 }
diff --git a/Sources/SwiftSource/Output.swift b/Sources/SwiftSource/Output.swift
diff --git a/Sources/SwiftSource/Report.swift b/Sources/SwiftSource/Report.swift
diff --git a/Sources/SwiftSource/SwiftAccessLevel.swift b/Sources/SwiftSource/SwiftAccessLevel.swift
@@ -1,4 +1,4 @@
-//  AccessLevel.swift
+//  SwiftAccessLevel.swift
 //
 //  Created by Iurii Khvorost <iurii.khvorost@gmail.com> on 11.02.2022.
 //  Copyright © 2022 Iurii Khvorost. All rights reserved.
@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public enum AccessLevel: Int {
+public enum SwiftAccessLevel: Int {
   case `open`
   case `public`
   case `internal`
@@ -53,7 +53,7 @@ public enum AccessLevel: Int {
         continue
       }
       
-      if let accessLevel = AccessLevel(token: modifier.name) {
+      if let accessLevel = SwiftAccessLevel(token: modifier.name) {
         self = accessLevel
         return
       }
diff --git a/Sources/SwiftSource/SwiftComment.swift b/Sources/SwiftSource/SwiftComment.swift
@@ -1,4 +1,4 @@
-//  Comment.swift
+//  SwiftComment.swift
 //
 //  Created by Iurii Khvorost <iurii.khvorost@gmail.com> on 11.02.2024.
 //  Copyright © 2022 Iurii Khvorost. All rights reserved.
@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public struct Comment {
+public struct SwiftComment {
   private let piece: TriviaPiece
   
   public var text: String {
diff --git a/Sources/SwiftSource/SwiftDeclaration.swift b/Sources/SwiftSource/SwiftDeclaration.swift
@@ -1,4 +1,4 @@
-//  Declaration.swift
+//  SwiftDeclaration.swift
 //
 //  Created by Iurii Khvorost <iurii.khvorost@gmail.com> on 09.08.2022.
 //  Copyright © 2022 Iurii Khvorost. All rights reserved.
@@ -35,10 +35,10 @@ fileprivate struct StringBuilder {
   }
 }
 
-public struct Declaration {
-  public let comments: [Comment]
-  public let accessLevel: AccessLevel
-  public var keyword: Keyword
+public struct SwiftDeclaration {
+  public let comments: [SwiftComment]
+  public let accessLevel: SwiftAccessLevel
+  public var keyword: SwiftKeyword
   public let name: String
   public let line: Int
   public let column: Int
diff --git a/Sources/SwiftSource/SwiftKeyword.swift b/Sources/SwiftSource/SwiftKeyword.swift
@@ -1,4 +1,4 @@
-//  Keyword.swift
+//  SwiftKeyword.swift
 //
 //  Created by Iurii Khvorost <iurii.khvorost@gmail.com> on 11.02.2024.
 //  Copyright © 2022 Iurii Khvorost. All rights reserved.
@@ -24,7 +24,7 @@
 import SwiftSyntax
 
 
-public enum Keyword: String {
+public enum SwiftKeyword: String {
   case actor
   case `associatedtype`
   case `case`
diff --git a/Sources/SwiftSource/SwiftSource.swift b/Sources/SwiftSource/SwiftSource.swift
@@ -1,4 +1,4 @@
-//  Source.swift
+//  SwiftSource.swift
 //
 //  Created by Iurii Khvorost <iurii.khvorost@gmail.com> on 08.08.2022.
 //  Copyright © 2022 Iurii Khvorost. All rights reserved.
@@ -25,9 +25,9 @@ import Foundation
 import SwiftSyntax
 
 
-public struct Source {
+public struct SwiftSource {
   public let url: URL?
-  public let declarations: [Declaration]
+  public let declarations: [SwiftDeclaration]
   
   private init(url: URL?, source: String) {
     self.url = url
diff --git a/Sources/SwiftSource/Visitor.swift b/Sources/SwiftSource/Visitor.swift
@@ -29,7 +29,7 @@ class Visitor: SyntaxVisitor {
   private var context = [DeclProtocol]()
   private let converter: SourceLocationConverter
   
-  private(set) var declarations = [Declaration]()
+  private(set) var declarations = [SwiftDeclaration]()
   
   init(source: String) {
     let sourceFile = Parser.parse(source: source)
@@ -45,7 +45,7 @@ class Visitor: SyntaxVisitor {
       ? context.map { $0.name.trimmedDescription }.joined(separator: ".")
       : nil
     
-    let declaration = Declaration(decl: decl, path: path, location: startLocation)
+    let declaration = SwiftDeclaration(decl: decl, path: path, location: startLocation)
     declarations.append(declaration)
   }
   
diff --git a/Sources/swift-doc-coverage/main.swift b/Sources/swift-doc-coverage/main.swift
@@ -23,13 +23,13 @@
 
 import Foundation
 import ArgumentParser
-import SwiftDocCoverage
+import SwiftSource
 
 
-enum AccessLevelArgument: String, ExpressibleByArgument {
+enum AccessLevel: String, ExpressibleByArgument {
   case open, `public`, `internal`, `fileprivate`, `private`
   
-  var accessLevel: AccessLevel {
+  var accessLevel: SwiftAccessLevel {
     switch self {
       case .open: return .open
       case .public: return .public
@@ -62,8 +62,8 @@ struct SwiftDocCoverage: ParsableCommand {
   @Option(name: .shortAndLong, help: "Skip source code files with file paths that match the given regular expression.")
   var ignoreFilenameRegex: String = ""
   
-  @Option(name: .shortAndLong, help: "The minimum access level of the symbols considered for coverage statistics: \(AccessLevelArgument.open), \(AccessLevelArgument.public), \(AccessLevelArgument.internal), \(AccessLevelArgument.fileprivate), \(AccessLevelArgument.private).")
-  var minimumAccessLevel: AccessLevelArgument = .public
+  @Option(name: .shortAndLong, help: "The minimum access level of the symbols considered for coverage statistics: \(AccessLevel.open), \(AccessLevel.public), \(AccessLevel.internal), \(AccessLevel.fileprivate), \(AccessLevel.private).")
+  var minimumAccessLevel: AccessLevel = .public
   
   @Option(name: .shortAndLong, help: "Report modes: \(ReportArgument.statistics.rawValue), \(ReportArgument.warnings.rawValue), \(ReportArgument.json.rawValue).")
   var report: ReportArgument = .statistics
diff --git a/Tests/SwiftDocCoverageTests/SwiftDocCoverageTests.swift b/Tests/SwiftDocCoverageTests/SwiftDocCoverageTests.swift

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ protocol DeclProtocol: DeclSyntaxProtocol {`
`28`	`28`
`29`	`29`	`// var attributes: AttributeListSyntax`
`30`	`30`	`var modifiers: DeclModifierListSyntax { get }`
`31`		`- var keyword: Keyword { get }`
	`31`	`+ var keyword: SwiftKeyword { get }`
`32`	`32`	`var name: TokenSyntax { get }`
`33`	`33`
`34`	`34`	`var genericParameterClause: GenericParameterClauseSyntax? { get }`
`@@ -43,50 +43,50 @@ extension DeclProtocol {`
`43`	`43`	`var funcSignature: FunctionSignatureSyntax? { nil }`
`44`	`44`	`var genericWhereClause: GenericWhereClauseSyntax? { nil }`
`45`	`45`
`46`		`- var comments: [Comment] {`
`47`		`- leadingTrivia.compactMap { Comment(piece: $0) }`
	`46`	`+ var comments: [SwiftComment] {`
	`47`	`+ leadingTrivia.compactMap { SwiftComment(piece: $0) }`
`48`	`48`	`}`
`49`		`- var accessLevel: AccessLevel { AccessLevel(modifiers: modifiers) }`
	`49`	`+ var accessLevel: SwiftAccessLevel { SwiftAccessLevel(modifiers: modifiers) }`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`// MARK: -`
`53`	`53`
`54`	`54`	`extension TypeAliasDeclSyntax: DeclProtocol {`
`55`		`- var keyword: Keyword { .typealias }`
	`55`	`+ var keyword: SwiftKeyword { .typealias }`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`extension AssociatedTypeDeclSyntax: DeclProtocol {`
`59`		`- var keyword: Keyword { .associatedtype }`
	`59`	`+ var keyword: SwiftKeyword { .associatedtype }`
`60`	`60`	`}`
`61`	`61`
`62`	`62`	`extension ClassDeclSyntax: DeclProtocol {`
`63`		`- var keyword: Keyword { .class }`
	`63`	`+ var keyword: SwiftKeyword { .class }`
`64`	`64`	`}`
`65`	`65`
`66`	`66`	`extension ActorDeclSyntax: DeclProtocol {`
`67`		`- var keyword: Keyword { .actor }`
	`67`	`+ var keyword: SwiftKeyword { .actor }`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`extension StructDeclSyntax: DeclProtocol {`
`71`		`- var keyword: Keyword { .struct }`
	`71`	`+ var keyword: SwiftKeyword { .struct }`
`72`	`72`	`}`
`73`	`73`
`74`	`74`	`extension ProtocolDeclSyntax: DeclProtocol {`
`75`		`- var keyword: Keyword { .protocol }`
	`75`	`+ var keyword: SwiftKeyword { .protocol }`
`76`	`76`	`}`
`77`	`77`
`78`	`78`	`extension ExtensionDeclSyntax: DeclProtocol {`
`79`		`- var keyword: Keyword { .extension }`
	`79`	`+ var keyword: SwiftKeyword { .extension }`
`80`	`80`	`var name: TokenSyntax { TokenSyntax(.identifier(extendedType.trimmedDescription), presence: .present)}`
`81`	`81`	`}`
`82`	`82`
`83`	`83`	`extension FunctionDeclSyntax: DeclProtocol {`
`84`		`- var keyword: Keyword { .func }`
	`84`	`+ var keyword: SwiftKeyword { .func }`
`85`	`85`	`var funcSignature: FunctionSignatureSyntax? { signature }`
`86`	`86`	`}`
`87`	`87`
`88`	`88`	`extension InitializerDeclSyntax: DeclProtocol {`
`89`		- var keyword: Keyword { .`init` }
	`89`	+ var keyword: SwiftKeyword { .`init` }
`90`	`90`
`91`	`91`	`var name: TokenSyntax {`
`92`	`92`	`let optionalMark = optionalMark?.trimmedDescription ?? ""`
`@@ -97,7 +97,7 @@ extension InitializerDeclSyntax: DeclProtocol {`
`97`	`97`	`}`
`98`	`98`
`99`	`99`	`extension SubscriptDeclSyntax: DeclProtocol {`
`100`		`- var keyword: Keyword { .subscript }`
	`100`	`+ var keyword: SwiftKeyword { .subscript }`
`101`	`101`
`102`	`102`	`var name: TokenSyntax {`
`103`	`103`	`TokenSyntax(.identifier("subscript"), presence: .present)`
`@@ -109,7 +109,7 @@ extension SubscriptDeclSyntax: DeclProtocol {`
`109`	`109`	`}`
`110`	`110`
`111`	`111`	`extension VariableDeclSyntax: DeclProtocol {`
`112`		`- var keyword: Keyword { Keyword(token: bindingSpecifier)! }`
	`112`	`+ var keyword: SwiftKeyword { SwiftKeyword(token: bindingSpecifier)! }`
`113`	`113`
`114`	`114`	`var name: TokenSyntax {`
`115`	`115`	`let name = bindings.map { $0.pattern.trimmedDescription }.joined(separator: ",")`
`@@ -118,11 +118,11 @@ extension VariableDeclSyntax: DeclProtocol {`
`118`	`118`	`}`
`119`	`119`
`120`	`120`	`extension EnumDeclSyntax: DeclProtocol {`
`121`		`- var keyword: Keyword { .enum }`
	`121`	`+ var keyword: SwiftKeyword { .enum }`
`122`	`122`	`}`
`123`	`123`
`124`	`124`	`extension EnumCaseDeclSyntax: DeclProtocol {`
`125`		`- var keyword: Keyword { .case }`
	`125`	`+ var keyword: SwiftKeyword { .case }`
`126`	`126`
`127`	`127`	`var name: TokenSyntax {`
`128`	`128`	`let name = elements.map {`
`@@ -135,10 +135,10 @@ extension EnumCaseDeclSyntax: DeclProtocol {`
`135`	`135`	`}`
`136`	`136`
`137`	`137`	`extension PrecedenceGroupDeclSyntax: DeclProtocol {`
`138`		`- var keyword: Keyword { .precedencegroup }`
	`138`	`+ var keyword: SwiftKeyword { .precedencegroup }`
`139`	`139`	`}`
`140`	`140`
`141`	`141`	`extension MacroDeclSyntax: DeclProtocol {`
`142`		`- var keyword: Keyword { .macro }`
	`142`	`+ var keyword: SwiftKeyword { .macro }`
`143`	`143`	`var funcSignature: FunctionSignatureSyntax? { signature }`
`144`	`144`	`}`