Rework and rename package

Author: florianpircher

.spi.yml

@@ -1,4 +1,4 @@
 version: 1
 builder:
   configs:
-    - documentation_targets: [LightTableParser]
+    - documentation_targets: [CollectionParser]

Package.swift

@@ -1,18 +1,18 @@
-// swift-tools-version: 5.10
+// swift-tools-version: 6.0
 import PackageDescription
 
 let package = Package(
-	name: "LightTableParser",
+	name: "swift-collection-parser",
 	products: [
 		.library(
-			name: "LightTableParser",
-			targets: ["LightTableParser"]),
+			name: "CollectionParser",
+			targets: ["CollectionParser"]),
 	],
 	targets: [
 		.target(
-			name: "LightTableParser"),
+			name: "CollectionParser"),
 		.testTarget(
-			name: "LightTableParserTests",
-			dependencies: ["LightTableParser"]),
+			name: "CollectionParserTests",
+			dependencies: ["CollectionParser"]),
 	]
 )

README.md

@@ -1,6 +1,6 @@
-# LightTableParser
+# Swift Collection Parser
 
-A Swift package for a type `Parser<Subject: Collection>`.
+Swift Collection Parser is a package for a type `Parser<Subject: Collection>`.
 
 ## Description
 
@@ -9,11 +9,11 @@ The `Parser` type provides a simple parser that can be used to parse arbitrary c
 ```swift
 var parser = Parser(subject: data)
 
-guard let version = parser.read() else {
+guard let version = parser.pop() else {
 	throw DecodingError.missingVersion
 }
 guard let string = String(bytes: parser.read(while: { $0 != 0 }), encoding: .utf8),
-      parser.read() == 0 else {
+      parser.pop(0) else {
 	throw DecodingError.invalidStringValue
 }
 ```

Sources/CollectionParser/Documentation.docc/Documentation.md

@@ -0,0 +1,8 @@
+# ``CollectionParser``
+
+A simple parser that can be used to parse arbitrary collections.
+
+## Overview
+
+The parser takes a collection as its subject and operates on the elements and subsequences of this subject.
+There are general methods for processing any type of element, but there are also specialized methods for working with strings and regular expressions.

Sources/CollectionParser/Documentation.docc/Parser.md

@@ -0,0 +1,71 @@
+# ``Parser``
+
+## Topics
+
+### Creating Parsers
+
+- ``Parser/init(subject:)``
+- ``Parser/init(subject:position:)``
+
+### Parser State
+
+The position is the only mutable state of the parser.
+
+- ``Parser/subject``
+- ``Parser/position``
+
+### Remaining Subject
+
+- ``Parser/remainder()``
+- ``Parser/isAtEnd``
+
+### Peeking Ahead
+
+Look ahead by peeking at the next elements without advancing the parser.
+
+- ``Parser/peek()-1zib3``
+- ``Parser/peek()-2q40y``
+- ``Parser/peek()-76suw``
+
+### Remainder Prefix
+
+Look ahead by matching the prefix of the remainder without advancing the parser.
+
+- ``Parser/hasPrefix(_:)-5sp1u``
+- ``Parser/hasPrefix(_:)-71nio``
+- ``Parser/hasPrefix(_:)-6dwmk``
+- ``Parser/hasPrefix(_:)-215bz``
+
+### Reading Elements
+
+Read the current element, advancing the parser on success.
+
+- ``Parser/pop()``
+- ``Parser/pop(_:)``
+- ``Parser/pop(where:)``
+
+### Reading Subsequences
+
+Read elements, advancing the parser on success.
+
+- ``Parser/read(_:)-35dei``
+- ``Parser/read(_:)-2o7et``
+- ``Parser/read(count:)``
+- ``Parser/read(while:)``
+- ``Parser/read(_:)-23mio``
+
+### Advancing the Parser
+
+Advance the parser position without reading elements.
+
+- ``Parser/advance()``
+- ``Parser/advance(by:)``
+- ``Parser/advance(while:)-22vnw``
+- ``Parser/advance(while:)-414fk``
+- ``Parser/advance(matching:)``
+
+### Views
+
+Work with different views of the subject.
+
+- ``Parser/withView(_:_:)``