https://github.com/sshtools/sequins
A Java library for prettier console output
https://github.com/sshtools/sequins
Last synced: over 1 year ago
JSON representation
A Java library for prettier console output
- Host: GitHub
- URL: https://github.com/sshtools/sequins
- Owner: sshtools
- License: apache-2.0
- Created: 2023-01-10T23:20:08.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-01-03T12:39:29.000Z (over 1 year ago)
- Last Synced: 2025-01-23T00:13:31.346Z (over 1 year ago)
- Language: Java
- Size: 198 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sequins
Some extensions and helpers used to augment [JLine3](https://github.com/jline/jline3), as used in
several [JADAPTIVE](https://jadaptive.com) command line applications such as [Push SFTP](https://github.com/sshtools/push-sftp).
## Get Sequins
It is available in Maven Central.
```xml
com.sshtools
sequins
0.0.4
```
## Features
* Nested progress output with animated spinners
* Simple prompting (passwords, yes/no, text)
* Highlights `MessageFormat.format()` and `String.format()` arguments.
* Draw tables with box drawing characters
## Anti-features
* Will not support full screen features
## TODO
* Tests
* More Widgets
## Examples
### HelloWorld
```java
Sequins.create().messageln("Hello World");
```
### HelloWorld Formatting
The formatter arguments will be bolded.
```java
var terminal = Sequins.create();
var rnd = new Random();
terminal.messageln("Hello World, its {0} degrees outside today, with a {1}% chance of rain.", rnd.nextInt(-10, 50), rnd.nextInt(0, 100));
```
### Errors
Will output on `System.err` instead of `System.out`.
```java
var terminal = Sequins.create();
try {
throw new Exception("Bang!");
}
catch(Exception e) {
terminal.errorln("Something has gone terribly wrong");
terminal.error(e);
}
```
### Prompting
Prompt for text, passwords, confirmation.
```java
var terminal = Sequins.create();
var name = terminal.prompt("what is your name?");
var age = terminal.prompt("Hello {0}, what is you age?", name);
if(terminal.yesNo("Are you sure {0}, age {1}.", name, age)) {
var pw = terminal.password("Ok then {0}, what is your password?", name);
terminal.messageln("Thanks, storing password {0} for later shenannigans", new String(pw));
}
```
### Sequences
With a sequence you can create a string of formatted and styled text, using background and foreground colours and text styles such as italic, bold, and underline.
```java
var terminal = Sequins.create();
var seq = terminal.createSequence();
var encoded = seq.str("With a ").boldOn().str("sequence").boldOff().
str(" you can create a string of formatted and styled text, ").
str("using ").bg(Color.RED).str("background").defaultBg().
str(" and ").fg(Color.GREEN).str("foreground").defaultFg().
str(" colours and text styles such as ").
italic(true).str("italic").italic(false).ch(' ').
boldOn().str("bold").boldOff().str(" and ").
underlineOn().str("underline").underlineOff().ch('.').toString();
var wrt = terminal.getWriter();
wrt.write(encoded);
wrt.flush();
```
### Progress
Intended for long running tasks, where output might be line by line, or animated progress. Progress can be nested too (with the output of each nested level being indented further).
```java
var terminal = Sequins.create();
bldr = terminal.progressBuilder();
bldr.withIndeterminate();
bldr.withHideCursor();
bldr.withPercentageText();
try(var progress = bldr.build()) {
progress.message(Level.NORMAL, "Line 1. {0}", "Arg1");
sleep(DELAY);
progress.message(Level.NORMAL, "Line 2. {0}", "Arg2");
sleep(1000);
for(int i = 0 ; i <= 10; i++) {
progress.progressMessage("Count {0}", i);
sleep(3000);
}
}
```