Rework and rename package

Author: florianpircher

.spi.yml

@@ -1,4 +1,4 @@
 version: 1
 builder:
   configs:
-    - documentation_targets: [LightTableFilePaths]
+    - documentation_targets: [ScopedFilePath]

Package.swift

@@ -1,8 +1,8 @@
-// swift-tools-version: 5.10
+// swift-tools-version: 6.0
 import PackageDescription
 
 let package = Package(
-	name: "LightTableFilePaths",
+	name: "swift-scoped-file-path",
 	platforms: [
 		.macOS(.v12),
 		.iOS(.v15),
@@ -13,15 +13,12 @@ let package = Package(
 	],
 	products: [
 		.library(
-			name: "LightTableFilePaths",
-			targets: ["LightTableFilePaths"]),
+			name: "ScopedFilePath",
+			targets: ["ScopedFilePath"]),
 	],
 	targets: [
 		.target(
-			name: "LightTableFilePaths"),
-		.testTarget(
-			name: "LightTableFilePathsTests",
-			dependencies: ["LightTableFilePaths"]),
+			name: "ScopedFilePath"),
 	]
 )
 

README.md

@@ -1,3 +1,3 @@
-# LightTableFilePaths
+# Swift Scoped File Path
 
 A Swift package introducing separate `AbsoluteFilePath` and `RelativeFilePath` based on `FilePath` from [Swift System](https://github.com/apple/swift-system).

Sources/FilePath.Component.swift

@@ -1,7 +1,4 @@
 //
-//  AbsoluteFilePath.swift
-//  LightTableFilePaths
-//
 //  Copyright 2024 Florian Pircher
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,7 +21,7 @@ import System
 import SystemPackage
 #endif
 
-public struct AbsoluteFilePath: ExtendedFilePath, Sendable {
+public struct AbsoluteFilePath: ScopedFilePathProtocol, Sendable {
 	public let storage: FilePath
 
 	public init?(_ path: FilePath) {

Sources/AbsoluteFilePath.swift renamed to Sources/ScopedFilePath/AbsoluteFilePath.swift

@@ -1,4 +1,4 @@
-# ``LightTableFilePaths``
+# ``ScopedFilePath``
 
 Separate `AbsoluteFilePath` and `RelativeFilePath` types.
 
@@ -20,4 +20,4 @@ Both are immutable and offer API specific to their use cases.
 
 ### Abstraction
 
-- ``ExtendedFilePath``
+- ``ScopedFilePathProtocol``

Sources/Documentation.docc/Documentation.md renamed to Sources/ScopedFilePath/Documentation.docc/Documentation.md

@@ -1,7 +1,4 @@
 //
-//  FilePathCompareOptions.swift
-//  LightTableFilePaths
-//
 //  Copyright 2024 Florian Pircher
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");

Sources/FilePathCompareOptions.swift renamed to Sources/ScopedFilePath/FilePathCompareOptions.swift

@@ -1,7 +1,4 @@
 //
-//  RelativeFilePath.swift
-//  LightTableFilePaths
-//
 //  Copyright 2024 Florian Pircher
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,7 +21,7 @@ import System
 import SystemPackage
 #endif
 
-public struct RelativeFilePath: ExtendedFilePath, ExpressibleByStringLiteral, Sendable {
+public struct RelativeFilePath: ScopedFilePathProtocol, ExpressibleByStringLiteral, Sendable {
 	public let storage: FilePath
 
 	public init?(_ path: FilePath) {

Sources/RelativeFilePath.swift renamed to Sources/ScopedFilePath/RelativeFilePath.swift

@@ -1,7 +1,4 @@
 //
-//  ExtendedFilePath.swift
-//  LightTableFilePaths
-//
 //  Copyright 2024 Florian Pircher
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");
@@ -24,7 +21,7 @@ import System
 import SystemPackage
 #endif
 
-public protocol ExtendedFilePath: Hashable, CustomStringConvertible {
+public protocol ScopedFilePathProtocol: Hashable, CustomStringConvertible {
 	typealias Component = FilePath.Component
 	typealias CompareOptions = FilePathCompareOptions
 
@@ -33,13 +30,13 @@ public protocol ExtendedFilePath: Hashable, CustomStringConvertible {
 	init?(_ path: FilePath)
 }
 
-extension ExtendedFilePath {
-	public var components: FilePath.ComponentView { storage.components }
-	public var lastComponent: FilePath.Component? { storage.lastComponent }
-	public var description: String { storage.string }
-	public var string: String { storage.string }
-	public var stem: String? { storage.stem }
-	public var `extension`: String? { storage.extension }
+extension ScopedFilePathProtocol {
+	public var components: FilePath.ComponentView { self.storage.components }
+	public var lastComponent: FilePath.Component? { self.storage.lastComponent }
+	public var description: String { self.storage.string }
+	public var string: String { self.storage.string }
+	public var stem: String? { self.storage.stem }
+	public var `extension`: String? { self.storage.extension }
 
 	public init?(platformString: [CInterop.PlatformChar]) {
 		self.init(FilePath(platformString: platformString))
@@ -58,53 +55,49 @@ extension ExtendedFilePath {
 	}
 
 	public static func == (lhs: Self, rhs: Self) -> Bool {
-		lhs.storage == rhs.storage
+		lhs.self.storage == rhs.self.storage
 	}
 
 	public func hash(into hasher: inout Hasher) {
-		hasher.combine(storage)
+		hasher.combine(self.storage)
 	}
 
 	public var isEmpty: Bool {
-		storage.isEmpty
+		self.storage.isEmpty
 	}
 
 	public func appending(_ other: String) -> Self {
-		Self(storage.appending(other))!
+		Self(self.storage.appending(other))!
 	}
 
 	public func appending(_ other: FilePath.Component) -> Self {
-		Self(storage.appending(other))!
+		Self(self.storage.appending(other))!
 	}
 
 	public func appending(_ components: some Collection<FilePath.Component>) -> Self {
-		Self(storage.appending(components))!
+		Self(self.storage.appending(components))!
 	}
 
 	public func withExtension(_ `extension`: String?) -> Self {
-		var valueCopy = storage
+		var valueCopy = self.storage
 
 		valueCopy.extension = `extension`
 
 		return Self(valueCopy)!
 	}
 
 	public func removingLastComponent() -> Self {
-		Self(storage.removingLastComponent())!
+		Self(self.storage.removingLastComponent())!
 	}
 
 	public func starts(with prefix: Self, options: FilePathCompareOptions) -> Bool {
 		if options.contains(.unicodeEquality) {
-			storage.components.starts(with: prefix.components) { a, b in
+			self.storage.components.starts(with: prefix.components) { a, b in
 				a.string == b.string
 			}
 		}
 		else {
-			storage.starts(with: prefix.storage)
+			self.storage.starts(with: prefix.self.storage)
 		}
 	}
-	
-	public func withPrecomposedString<R>(_ body: (UnsafePointer<CInterop.PlatformChar>) throws -> R) rethrows -> R {
-		try self.storage.string.precomposedStringWithCanonicalMapping.withCString(body)
-	}
 }

Sources/ExtendedFilePath.swift renamed to Sources/ScopedFilePath/ScopedFilePathProtocol.swift

@@ -1,7 +1,4 @@
 //
-//  URL.swift
-//  LightTableFilePaths
-//
 //  Copyright 2024 Florian Pircher
 //
 //  Licensed under the Apache License, Version 2.0 (the "License");