Playground readme (#6)

* palyground reamde

* gh-format

Author: Alexander-Ignition

.github/workflows/test.yml

@@ -54,5 +54,5 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
       - name: swift-format lint
-        run: make lint 2>&1 | Scripts/gh-workflow.swift
+        run: make lint 2>&1 | Scripts/gh-format.swift
         shell: bash

Makefile

@@ -8,6 +8,9 @@ clean:
 	swift package clean
 	rm -rf $(OUTPUD_DIR)
 
+README.md: Playgrounds/README.playground/Contents.swift
+	cat $< | ./Scripts/markdown.swift > $@
+
 # MARK: - format
 
 lint:

Playgrounds/Example.playground/Contents.swift

@@ -0,0 +1,54 @@
+/*:
+ # 🌌 SQLyra 🎼
+
+ [![Test](https://github.com/Alexander-Ignition/SQLyra/actions/workflows/test.yml/badge.svg)](https://github.com/Alexander-Ignition/SQLyra/actions/workflows/test.yml)
+ [![Swift 5.9](https://img.shields.io/badge/swift-5.9-brightgreen.svg?style=flat)](https://developer.apple.com/swift)
+ [![GitHub license](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://github.com/Alexander-Ignition/SQLyra/blob/master/LICENSE)
+
+ Swift SQLite wrapper.
+
+ [Documentation](https://alexander-ignition.github.io/SQLyra/documentation/sqlyra/)
+
+ - Note: this readme file is available as Xcode playground in Playgrounds/README.playground
+
+ ## Open
+
+ Create database in memory for reading and writing.
+ */
+import SQLyra
+
+let database = try Database.open(
+    at: "new.db",
+    options: [.readwrite, .memory]
+)
+/*:
+ ## Create table
+
+ Create table for contacts with fields `id` and `name`.
+ */
+try database.execute(
+    """
+    CREATE TABLE contacts(
+        id INT PRIMARY KEY NOT NULL,
+        name TEXT
+    );
+    """
+)
+/*:
+ ## Insert
+
+ Insert new contacts Paul and John.
+ */
+try database.execute("INSERT INTO contacts (id, name) VALUES (1, 'Paul');")
+try database.execute("INSERT INTO contacts (id, name) VALUES (2, 'John');")
+/*:
+ ## Select
+
+ Select all contacts from database.
+ */
+struct Contact: Codable {
+    let id: Int
+    let name: String
+}
+
+let contacts = try database.prepare("SELECT * FROM contacts;").array(decoding: Contact.self)

Playgrounds/Example.playground/contents.xcplayground

@@ -0,0 +1,2 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<playground version='7.0' target-platform='macos' swift-version='6' display-mode='raw' buildActiveScheme='true' importAppTypes='true'/>

Playgrounds/README.playground/Contents.swift

@@ -7,3 +7,48 @@
 Swift SQLite wrapper.
 
 [Documentation](https://alexander-ignition.github.io/SQLyra/documentation/sqlyra/)
+
+- Note: this readme file is available as Xcode playground in Playgrounds/README.playground
+
+## Open
+
+Create database in memory for reading and writing.
+```swift
+import SQLyra
+
+let database = try Database.open(
+    at: "new.db",
+    options: [.readwrite, .memory]
+)
+```
+## Create table
+
+Create table for contacts with fields `id` and `name`.
+```swift
+try database.execute(
+    """
+    CREATE TABLE contacts(
+        id INT PRIMARY KEY NOT NULL,
+        name TEXT
+    );
+    """
+)
+```
+## Insert
+
+Insert new contacts Paul and John.
+```swift
+try database.execute("INSERT INTO contacts (id, name) VALUES (1, 'Paul');")
+try database.execute("INSERT INTO contacts (id, name) VALUES (2, 'John');")
+```
+## Select
+
+Select all contacts from database.
+```swift
+struct Contact: Codable {
+    let id: Int
+    let name: String
+}
+
+let contacts = try database.prepare("SELECT * FROM contacts;").array(decoding: Contact.self)
+```

Playgrounds/README.playground/contents.xcplayground

@@ -1,9 +1,13 @@
 #!/usr/bin/env swift
 
-// Workflow commands for GitHub Actions
-// https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions
-// Usage: xcrun swift-format lint --recursive --strict ./ 2>&1 | Scripts/gh-workflow.swift
-// Test: echo "Sources/SQLime/SQLParameter.swift:23:1: warning: [TrailingWhitespace] remove trailing whitespace" | Scripts/gh-workflow.swift
+/*
+ Usage: xcrun swift-format lint --recursive --strict ./ 2>&1 | Scripts/gh-format.swift
+
+ Test: echo "Sources/SQLime/SQLParameter.swift:23:1: warning: [TrailingWhitespace] remove trailing whitespace" | Scripts/gh-workflow.swift
+
+ Workflow commands for GitHub Actions
+ https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions
+ */
 
 let regex = #/(?<file>.+\.swift):(?<line>\d+):(?<column>\d+): (?<severity>.+): \[(?<title>.+)\] (?<message>.+)/#
 while let line = readLine() {

README.md

@@ -0,0 +1,32 @@
+#!/usr/bin/env swift
+
+/*
+ OVERVIEW: Convert Xcode Playground to markdown
+
+ USAGE: cat Playgrounds/Example.playground/Contents.swift | ./Scripts/markdown.swift
+ */
+
+enum TextBlock {
+    case unknown, code, comment
+}
+
+var block = TextBlock.unknown
+
+while let line = readLine() {
+    if line.hasPrefix("/*") {
+        if block == .code {
+            print("```")
+        }
+        block = .comment
+    } else if line.hasSuffix("*/") {
+        print("```swift")
+        block = .code
+    } else if block == .comment {
+        print(line.drop(while: \.isWhitespace))
+    } else {
+        print(line)
+    }
+}
+if block == .code {
+    print("```")
+}