2 Commits

11 changed files with 123 additions and 15 deletions

View File

@@ -0,0 +1,20 @@
{
"name": "terminal-ui",
"image": "mcr.microsoft.com/devcontainers/java:1-21-bookworm",
"features": {
"ghcr.io/devcontainers/features/java:1": {
"version": "21",
"installGradle": "true",
"installMaven": "false"
}
},
"postCreateCommand": "java -version && ./gradlew --version",
"customizations": {
"vscode": {
"extensions": [
"vscjava.vscode-java-pack",
"vscjava.vscode-gradle"
]
}
}
}

20
.editorconfig Normal file
View File

@@ -0,0 +1,20 @@
# EditorConfig: consistent style across editors
# https://editorconfig.org
root = true
[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.{java,kts}]
indent_style = space
indent_size = 4
[*.{yml,yaml,md,json}]
indent_size = 2
[*.bat]
end_of_line = crlf

9
.gitattributes vendored Normal file
View File

@@ -0,0 +1,9 @@
# Normalize line endings
* text=auto eol=lf
*.bat text eol=crlf
*.cmd text eol=crlf
# GitHub linguist: don't count these as language
gradle/wrapper/gradle-wrapper.jar binary
*.jar binary
*.zip binary

27
.github/release-drafter.yml vendored Normal file
View File

@@ -0,0 +1,27 @@
# Config for release-drafter v6: categorizes PRs in draft release notes
# https://github.com/release-drafter/release-drafter
template: |
## What's Changed
$CHANGES
**Full Changelog**: https://github.com/jakubbbdev/terminal-ui/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION
name-template: 'v$RESOLVED_VERSION'
tag-template: 'v$RESOLVED_VERSION'
categories:
- title: '🚀 Features'
labels: [feature, enhancement]
- title: '🐛 Bug Fixes'
labels: [bug, fix]
- title: '📚 Documentation'
labels: [documentation]
- title: '⬆️ Dependencies'
labels: [dependencies]
- title: 'Other'
labels: ['*']
exclude-labels:
- skip-changelog

View File

@@ -21,6 +21,13 @@ jobs:
- name: Checkout
uses: actions/checkout@v4
- name: Set up JDK 21
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 21
cache: gradle
- name: Initialize CodeQL
uses: github/codeql-action/init@v3
with:

22
.github/workflows/release-drafter.yml vendored Normal file
View File

@@ -0,0 +1,22 @@
# Drafts release notes from merged PRs when you create a release.
# Install: add a Release Drafter config (see below), then create a release on GitHub;
# this workflow will update the draft with categorized PRs.
name: Release Drafter
on:
push:
branches: [main, master]
workflow_dispatch:
permissions:
contents: read
pull-requests: write
jobs:
update_release_draft:
runs-on: ubuntu-latest
steps:
- name: Draft Release
uses: release-drafter/release-drafter@v6
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@@ -3,6 +3,10 @@
Java library for terminal UI: tables, rules, colors, prompts, menus, SelectList, pager, and more. Fluent API, ANSI support, testable.
[![CI](https://github.com/jakubbbdev/terminal-ui/actions/workflows/ci.yml/badge.svg)](https://github.com/jakubbbdev/terminal-ui/actions/workflows/ci.yml)
[![Java 21](https://img.shields.io/badge/Java-21-ED8B00?logo=openjdk)](https://openjdk.org/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/jakubbbdev/terminal-ui)
## Requirements
@@ -21,18 +25,6 @@ Run tests:
./gradlew test
```
Demo (non-interactive):
```bash
./gradlew run
```
Interactive demo (best run in a real terminal):
```bash
./gradlew runDemo2
```
## Usage (excerpt)
```java

11
SECURITY.md Normal file
View File

@@ -0,0 +1,11 @@
# Security
## Reporting a vulnerability
If you find a security issue, please report it responsibly:
1. **Do not** open a public issue.
2. Email the maintainers or report via [GitHub Security Advisories](https://github.com/jakubbbdev/terminal-ui/security/advisories/new) (if enabled).
3. Give a clear description and steps to reproduce; well respond as soon as we can.
Thank you for helping keep this project safe.

View File

@@ -22,7 +22,7 @@ repositories {
}
dependencies {
testImplementation(platform("org.junit:junit-bom:6.0.3"))
testImplementation(platform("org.junit:junit-bom:5.10.0"))
testImplementation("org.junit.jupiter:junit-jupiter")
testRuntimeOnly("org.junit.platform:junit-platform-launcher")
}

View File

@@ -72,7 +72,7 @@ public final class Confirm {
}
/**
* Uses the given scanner for one line. Use when sharing one scanner (e.g. demo).
* Uses the given scanner for one line. Use when sharing one scanner (e.g. interactive app).
*/
public boolean ask(Scanner sharedScanner) {
if (sharedScanner == null) return ask();

View File

@@ -64,7 +64,7 @@ public final class Prompt {
/**
* Prompts and returns the next line from the given scanner. Use this when
* sharing one scanner (e.g. in a demo) so input blocks correctly.
* sharing one scanner (e.g. in an interactive app) so input blocks correctly.
*/
public String ask(Scanner sharedScanner) {
if (sharedScanner == null) return ask();