Merge pull request #35 from maclong9/main

chore: auto-generated quick fix

Author: maclong9

README.md

@@ -71,6 +71,16 @@ To use WebUI, ensure you have the following installed:
 
 ## Usage
 
+### Script
+
+If you pass no template the static one will be used by default and if you pass no project name it will default to `web-ui-template`
+
+```sh
+curl -fSls https://raw.githubusercontent.com/maclong9/web-ui/refs/heads/main/initialize.sh | sh -s -- --template [static|server] [<project-name>]
+```
+
+### Manually
+
 Add the following to your package dependencies:
 ``` Package.swift
 dependencies: [

Sources/WebUI/Elements/Base/List.swift

@@ -14,6 +14,24 @@ public enum ListType: String {
     case unordered = "ul"
 }
 
+/// Defines styles for HTML list elements.
+///
+/// HTML supports various styles for list elements, such as disc, circle, or square.
+/// This enum provides a type-safe way to specify which style to use.
+public enum ListStyle: String {
+    /// Creates a list with no bullets or numbers.
+    case none = ""
+
+    /// Creates a list with bullets shaped like discs.
+    case disc
+
+    /// Creates a list with bullets shaped like circles.
+    case circle
+
+    /// Creates a list with bullets shaped like squares.
+    case square = "[square]"
+}
+
 /// Generates HTML list elements (`<ul>` or `<ol>`).
 ///
 /// `List` can be rendered as an unordered list with bullet points when sequence is unimportant,
@@ -32,11 +50,13 @@ public enum ListType: String {
 /// ```
 public final class List: Element {
     let type: ListType
+    let style: ListStyle
 
     /// Creates a new HTML list element (`<ul>` or `<ol>`).
     ///
     /// - Parameters:
     ///   - type: List type (ordered or unordered), defaults to unordered.
+    ///   - style: List style (disc, circle, or square), defaults to none.
     ///   - id: Unique identifier for the HTML element.
     ///   - classes: An array of CSS classnames for styling the list.
     ///   - role: ARIA role of the element for accessibility.
@@ -53,6 +73,7 @@ public final class List: Element {
     /// ```
     public init(
         type: ListType = .unordered,
+        style: ListStyle = .none,
         id: String? = nil,
         classes: [String]? = nil,
         role: AriaRole? = nil,
@@ -61,10 +82,11 @@ public final class List: Element {
         @HTMLBuilder content: @escaping () -> [any HTML] = { [] }
     ) {
         self.type = type
+        self.style = style
         super.init(
             tag: type.rawValue,
             id: id,
-            classes: classes,
+            classes: (classes ?? []) + (style != .none ? ["list-\(style.rawValue)"] : []),
             role: role,
             label: label,
             data: data,

Sources/WebUI/Styles/Base/Typography.swift

@@ -199,8 +199,10 @@ public enum Leading: String {
 public enum Decoration: String {
     /// Simple underline beneath the text.
     case underline
+    /// Line above the text.
+    case overline
     /// Line through the middle of the text (strikethrough).
-    case lineThrough
+    case lineThrough = "line-through"
     /// Double line decoration.
     case double
     /// Dotted line decoration.
@@ -209,9 +211,11 @@ public enum Decoration: String {
     case dashed
     /// Wavy line decoration.
     case wavy
-
+    /// Remove line decoration
+    case none = "no-underline"
+    
     /// The corresponding CSS class name for this decoration.
-    var className: String { "decoration-\(rawValue)" }
+    var className: String { "\(rawValue)" }
 }
 
 /// Text wrapping options for controlling how text flows.

Tests/WebUITests/ElementTests.swift

@@ -155,6 +155,17 @@ import Testing
         #expect(rendered.contains("</ol>"))
     }
 
+    @Test("List Styles")
+    func testListStyles() async throws {
+      let disc = List(style: .disc).render()
+      let circle = List(style: .circle).render()
+      let square = List(style: .square).render()
+      
+      #expect(disc.contains("list-disc"))
+      #expect(circle.contains("list-circle"))
+      #expect(square.contains("list-[square]"))
+    }
+  
     // MARK: - Media Tests
 
     @Test("Picture element with multiple sources")

Tests/WebUITests/Styles/BaseTests.swift

@@ -187,7 +187,7 @@ import Testing
     func testFontWithDecorationAndWrapping() async throws {
         let element = Element(tag: "div").font(decoration: .underline, wrapping: .nowrap)
         let rendered = element.render()
-        #expect(rendered.contains("class=\"decoration-underline text-nowrap\""))
+        #expect(rendered.contains("class=\"underline text-nowrap\""))
     }
 
     @Test("Font with family and modifier")

examples/static/.github/workflows/build.yml

@@ -0,0 +1,67 @@
+name: Build and Deploy Static Site
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: write 
+
+jobs:
+  build:
+    runs-on: macos-15
+    steps:
+      # Check out the repository code
+      - uses: actions/checkout@v4
+      
+      # Set up Swift
+      - name: Setup Swift
+        uses: swift-actions/setup-swift@v2
+      
+      # Cache Swift build artifacts
+      - name: Cache Swift Build
+        uses: actions/cache@v4
+        id: cache-swift-build
+        with:
+          path: .build
+          key: ${{ runner.os }}-swift-build-${{ hashFiles('Package.swift', 'Sources/**') }}
+          restore-keys: |
+            ${{ runner.os }}-swift-build-
+      
+      # Build the project
+      - name: Build
+        run: swift build -v
+        if: steps.cache-swift-build.outputs.cache-hit != 'true'
+      
+      # Cache generated site output
+      - name: Cache Generated Site
+        uses: actions/cache@v4
+        id: cache-site-output
+        with:
+          path: .output
+          key: ${{ runner.os }}-site-output-${{ hashFiles('Sources/**') }}
+          restore-keys: |
+            ${{ runner.os }}-site-output-
+      
+      # Run the static site generator
+      - name: Generate Site
+        run: swift run Application
+        if: steps.cache-site-output.outputs.cache-hit != 'true'
+
+      # Push to static branch (only on push to main)
+      - name: Push to static branch
+        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+        run: |
+          git config user.name "GitHub Actions Bot"
+          git config user.email "actions@github.com"
+          git checkout -B static
+          rm -rf ./*
+          mv .output/* .
+          rm -rf .output .gitignore .github .build .swift-format
+          git add .
+          git commit -m "release: update static site content"
+          git push origin static --force
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

examples/static/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+.build/
+.output/
+.swiftpm/

examples/static/.swift-format

@@ -0,0 +1,61 @@
+{
+  "indentation" : {
+    "spaces" : 4
+  },
+  "tabWidth" : 4,
+  "fileScopedDeclarationPrivacy" : {
+    "accessLevel" : "private"
+  },
+  "spacesAroundRangeFormationOperators" : false,
+  "indentConditionalCompilationBlocks" : false,
+  "indentSwitchCaseLabels" : false,
+  "lineBreakAroundMultilineExpressionChainComponents" : false,
+  "lineBreakBeforeControlFlowKeywords" : false,
+  "lineBreakBeforeEachArgument" : true,
+  "lineBreakBeforeEachGenericRequirement" : true,
+  "lineLength" : 120,
+  "maximumBlankLines" : 1,
+  "respectsExistingLineBreaks" : true,
+  "prioritizeKeepingFunctionOutputTogether" : true,
+  "rules" : {
+    "AllPublicDeclarationsHaveDocumentation" : false,
+    "AlwaysUseLiteralForEmptyCollectionInit" : false,
+    "AlwaysUseLowerCamelCase" : false,
+    "AmbiguousTrailingClosureOverload" : true,
+    "BeginDocumentationCommentWithOneLineSummary" : false,
+    "DoNotUseSemicolons" : true,
+    "DontRepeatTypeInStaticProperties" : true,
+    "FileScopedDeclarationPrivacy" : true,
+    "FullyIndirectEnum" : true,
+    "GroupNumericLiterals" : true,
+    "IdentifiersMustBeASCII" : true,
+    "NeverForceUnwrap" : false,
+    "NeverUseForceTry" : false,
+    "NeverUseImplicitlyUnwrappedOptionals" : false,
+    "NoAccessLevelOnExtensionDeclaration" : true,
+    "NoAssignmentInExpressions" : true,
+    "NoBlockComments" : true,
+    "NoCasesWithOnlyFallthrough" : true,
+    "NoEmptyTrailingClosureParentheses" : true,
+    "NoLabelsInCasePatterns" : true,
+    "NoLeadingUnderscores" : false,
+    "NoParensAroundConditions" : true,
+    "NoVoidReturnOnFunctionSignature" : true,
+    "OmitExplicitReturns" : true,
+    "OneCasePerLine" : true,
+    "OneVariableDeclarationPerLine" : true,
+    "OnlyOneTrailingClosureArgument" : true,
+    "OrderedImports" : true,
+    "ReplaceForEachWithForLoop" : true,
+    "ReturnVoidInsteadOfEmptyTuple" : true,
+    "UseEarlyExits" : false,
+    "UseExplicitNilCheckInConditions" : false,
+    "UseLetInEveryBoundCaseVariable" : false,
+    "UseShorthandTypeNames" : true,
+    "UseSingleLinePropertyGetter" : false,
+    "UseSynthesizedInitializer" : false,
+    "UseTripleSlashForDocumentationComments" : true,
+    "UseWhereClausesInForLoops" : false,
+    "ValidateDocumentationComments" : false
+  }
+}

examples/static/Package.resolved

@@ -0,0 +1,21 @@
+// swift-tools-version: 6.1
+
+import PackageDescription
+
+let package = Package(
+    name: "Portfolio",
+    platforms: [.macOS(.v15)],
+    dependencies: [
+        .package(url: "https://github.com/maclong9/web-ui.git", from: "1.0.0")
+    ],
+    targets: [
+        .executableTarget(
+            name: "Application",
+            dependencies: [
+                .product(name: "WebUI", package: "web-ui")
+            ],
+            path: "Sources",
+            resources: [.process("Public")]
+        )
+    ]
+)