https://github.com/kc-2001ms/swiftli
Swift framework to easily build CLI (CUI) for command line tools
https://github.com/kc-2001ms/swiftli
cli clt cui resultbuilder swift swift-argument-parser swiftui-like
Last synced: about 1 month ago
JSON representation
Swift framework to easily build CLI (CUI) for command line tools
- Host: GitHub
- URL: https://github.com/kc-2001ms/swiftli
- Owner: KC-2001MS
- License: bsd-3-clause
- Created: 2024-06-04T00:24:53.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-12-06T15:26:21.000Z (5 months ago)
- Last Synced: 2025-04-11T16:11:54.713Z (about 1 month ago)
- Topics: cli, clt, cui, resultbuilder, swift, swift-argument-parser, swiftui-like
- Language: Swift
- Homepage: https://iroiro.dev/SwiftLI/documentation/swiftli/
- Size: 1.68 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# SwiftLI
SwiftLI is a library aimed at writing command line displays in Swift in a SwiftUI-like manner, and was inspired by SwiftUI and Ignite.
Just as SwiftUI is a library that makes it easy to build a GUI in Swift, SwiftLI aims to make it easy to build a CLI in Swift.
## Requirement
The following environment is required to use this library.
## Demo
The library includes a command line tool that allows you to verify its operation. Please use the following method to check the command line tool along with the source code.
### Using CMake
1. download this project file
2. open a terminal
3. Type the following command
``` sh
cd
make install
```
### Using Homebrew
1. Type the following command in a terminal
``` sh
brew install kc-2001ms/tap/sclt
```
## Usage
You can easily build a command line CUI by constructing your code as follows
```swift
import ArgumentParser
import SwiftLI
struct TextCommand: ParsableCommand {
static var configuration = CommandConfiguration(
commandName: "text",
abstract: "Display of Text structure",
discussion: """
Command to check the display of Text structure
""",
version: "0.0.2",
shouldDisplay: true,
helpNames: [.long, .short]
)
mutating func run() {
let group = Group {
Text("Text View")
.background(Color.white)
.forgroundColor(Color.blue)
.bold()
.newLine()
Group {
Group {
Text("Text.forgroundColor(_ color: Color)")
.forgroundColor(.red)
Spacer()
Text(".red")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Group {
Text("Text.backgroundColor(_ color: Color)")
.background(.red)
Spacer()
Text(".red")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Text("Text.bold()")
.bold()
.newLine()
Group {
Text("Text.bold(_ isActive: Bool)")
.bold(false)
Spacer()
Text("false")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Group {
Text("Text.fontWeight(_ weight: Weight)")
.fontWeight(.thin)
Spacer()
Text(".thin")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Text("Text.italic()")
.italic()
.newLine()
Group {
Text("Text.italic(_ isActive: Bool)")
.italic(false)
Spacer()
Text("false")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Text("Text.underline()")
.underline()
.newLine()
Group {
Text("Text.underline(_ isActive: Bool)")
.underline(false)
Spacer()
Text("false")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Group {
Text("Text.blink(_ style: BlinkStyle)")
.blink(.default)
Spacer()
Text(".default")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Text("Text.hidden()")
.hidden()
.newLine()
Group {
Text("Text.hidden(_ isActive: Bool)")
.hidden(false)
Spacer()
Text("false")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
Text("Text.strikethrough()")
.strikethrough()
.newLine()
Group {
Text("Text.strikethrough(_ isActive: Bool)")
.strikethrough(false)
Spacer()
Text("false")
.fontWeight(.thin)
.forgroundColor(.red)
}
.newLine()
}
}
group.render()
}
}
```
## Install
Add the following files to the Package.swift file for use. For more information, please visit [swift.org](https://www.swift.org/documentation/package-manager/).
``` swift
dependencies: [
// Add this code
.package(url: "https://github.com/KC-2001MS/SwiftLI.git", from: "0.3.0"),
],
```
## Swift-DocC
Swift-DocC is currently being implemented.
[Documentation](https://kc-2001ms.github.io/SwiftLI/documentation/swiftli)
## Contribution
See [CONTRIBUTING.md](https://github.com/KC-2001MS/SwiftLI/blob/main/CONTRIBUTING.md) if you want to make a contribution.
## Licence
[SwiftLI](https://github.com/KC-2001MS/SwiftLI/blob/main/LICENSE)
## Supporting
If you would like to make a donation to this project, please click here. The money you give will be used to improve my programming skills and maintain the application.
[Pay by PayPal](https://paypal.me/iroiroWork?country.x=JP&locale.x=ja_JP)
## Author
[Keisuke Chinone](https://github.com/KC-2001MS)