initial commit

Author: jedib0t

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior. Code samples if possible.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Software (please complete the following information):**
+ - OS: [e.g. OSX]
+ - GoLang Version [e.g. 1.10]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+## Proposed Changes
+  -
+  -
+  -
+
+Fixes #<insert Issue # here if applicable>.

.github/workflows/ci.yml

@@ -0,0 +1,52 @@
+name: CI
+
+on:
+  # Pushes and pulls to all branches
+  push:
+  pull_request:
+
+  # Run on the first day of every month
+  schedule:
+    - cron: "0 0 1 * *"
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+jobs:
+  # Build and test everything
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout the code
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      # Set up the GoLang environment
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.20'
+
+      # Download all the tools used in the steps that follow
+      - name: Set up Tools
+        run: |
+          go install github.com/fzipp/gocyclo/cmd/gocyclo@v0.5.1
+          go install github.com/mattn/goveralls@v0.0.12
+          go install go.uber.org/mock/mockgen@latest
+
+      # Run all the unit-tests
+      - name: Test
+        run: |
+          make test
+
+      # Run the benchmarks to ensure no performance degradation
+      - name: Benchmark
+        run: make bench
+
+#
+#      # Upload all the unit-test coverage reports to Coveralls
+#      - name: Upload Coverage Report
+#        env:
+#          COVERALLS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#        run: goveralls -service=github -coverprofile=.coverprofile
+#

.gitignore

@@ -0,0 +1,6 @@
+/.idea/
+/demo*
+/profile/
+.coverprofile
+*.prof
+*.swp

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at jedib0t@outlook.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 jedib0t
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Makefile

@@ -0,0 +1,32 @@
+.PHONY: all test
+
+default: test
+
+all: test bench
+
+bench:
+	go test ./... -bench=. -benchmem
+
+cyclo:
+	gocyclo -over 13 ./*/*.go
+
+fmt:
+	go fmt $(shell go list ./...)
+
+gen:
+	mockgen -destination mocks/input/mock_reader.go github.com/jedib0t/go-prompter/input Reader
+	mockgen -destination mocks/prompt/mock_prompter.go github.com/jedib0t/go-prompter/prompt Prompter
+
+run:
+	go run ./examples/prompt/sql
+
+test: gen fmt vet cyclo
+	go test -cover -coverprofile=.coverprofile -race $(shell go list ./...)
+
+tools:
+	go install github.com/fzipp/gocyclo/cmd/gocyclo@v0.5.1
+	go install go.uber.org/mock/mockgen@latest
+
+vet:
+	go vet $(shell go list ./...)
+

README.md

@@ -0,0 +1,46 @@
+# go-prompter
+
+[![Go Reference](https://pkg.go.dev/badge/github.com/jedib0t/go-prompter.svg)](https://pkg.go.dev/github.com/jedib0t/go-prompter)
+![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)
+[![Build Status](https://github.com/jedib0t/go-prompter/workflows/CI/badge.svg?branch=main)](https://github.com/jedib0t/go-prompter/actions?query=workflow%3ACI+event%3Apush+branch%3Amain)
+[![Coverage Status](https://coveralls.io/repos/github/jedib0t/go-prompter/badge.svg?branch=main)](https://coveralls.io/github/jedib0t/go-prompter?branch=main)
+[![Go Report Card](https://goreportcard.com/badge/github.com/jedib0t/go-prompter)](https://goreportcard.com/report/github.com/jedib0t/go-prompter)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=jedib0t_go-prompter&metric=alert_status)](https://sonarcloud.io/dashboard?id=jedib0t_go-prompter)
+
+Build full-featured CLI prompts in GoLang.
+
+A SQL prompt demo with most of the major features in play:
+
+<img src="prompt/demo.gif" alt="Demo"/>
+
+## Features
+
+* Single-line and Multi-line prompt with line numbers
+* [Syntax-Highlighting](prompt/syntax_highlighter.go) - use [Chroma](https://github.com/alecthomas/chroma) or roll-your-own
+* Flexible [Auto-Complete](prompt/auto_completer.go) drop-downs
+  * Start with built-in `AutoCompleter` for simple Keywords `Prompter.SetAutoCompleter(...)`
+  * Expand to context based additional Keywords using `Prompter.SetAutoCompleterContextual(...)`
+* Generate prompts with or without a "prefix"
+* Header and Footer generator functions for dynamic content
+* History integration with built-in go-back/go-forward/list/rerun
+* Completely customizable [KeyMap](prompt/key_map.go)
+  * Control what Actions can be triggered by what (special) Key-combinations
+* Custom command-shortcuts if the KeyMap is not flexible enough
+* Extremely flexible [Styling/Customization](prompt/style.go)
+  * Auto-Complete look and feel
+  * Cursor look and feel
+  * Dimensions (height/width)
+  * Line-Numbers look and feel
+  * Scrollbar look and feel
+
+## Bonus
+
+* [Input](input) package that wraps around [bubbletea](https://github.com/charmbracelet/bubbletea)
+  and provides a basic interface to capture input events
+  * Key-presses
+  * Mouse-clicks and motion
+  * Window/terminal resizes
+* [Powerline](powerline) package to generate Powerline-like lines
+  * Supports "segments" on both left and right sides
+  * Can auto-adjust and auto-remove segments to meet terminal width limitations
+  * Usable as header and/or prefix for the Prompt

SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.x.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Please create a new issue on this repo describing the vulnerability,
+and (if known) how to resolve it.

examples/color/main.go

@@ -0,0 +1,65 @@
+package main
+
+import (
+	"fmt"
+	"os"
+	"strings"
+
+	"github.com/jedib0t/go-pretty/v6/text"
+	"github.com/jedib0t/go-prompter/prompt"
+	"github.com/muesli/termenv"
+	"golang.org/x/term"
+)
+
+var (
+	colorsTitle = prompt.Color{
+		Foreground: termenv.BackgroundColor(),
+		Background: termenv.ForegroundColor(),
+	}
+)
+
+func main() {
+	termWidth, _, _ := term.GetSize(int(os.Stdout.Fd()))
+
+	out := strings.Builder{}
+	out.WriteString("\n")
+	out.WriteString(colorsTitle.Sprint(" 256-color Mode "))
+	out.WriteString("\n")
+	for bg := 0; bg < 256; bg++ {
+		if bg == 0 {
+			out.WriteString("\n      Standard Colors  High-Intensity Colors\n")
+		} else if bg == 8 {
+			out.WriteString("  ")
+		} else if bg == 16 {
+			out.WriteString("\n\n216 Colors\n")
+		} else if bg > 16 && bg < 232 && (bg-16)%18 == 0 { // 216-colors
+			if termWidth < 180 {
+				out.WriteString("\n") // 18 colors in one line
+			} else if (bg-16)%36 == 0 {
+				out.WriteString("\n") // 36 colors in one line
+			}
+		} else if bg == 232 {
+			out.WriteString("\n\nGrayscale Colors\n")
+		} else if bg == 244 {
+			if termWidth < 120 { // 12 grayscale colors in one line
+				out.WriteString("\n")
+			}
+		}
+
+		// determine foreground color based on how bright the background is
+		fg := 16 // black by default
+		if bg >= 16 && (bg-16)%36 < 18 && bg < 244 {
+			fg = 15 // white for darker background
+		}
+		c := prompt.Color{
+			Foreground: termenv.ANSI256Color(fg),
+			Background: termenv.ANSI256Color(bg),
+		}
+		out.WriteString(c.Sprintf(" %03d ", bg))
+	}
+	out.WriteString("\n")
+
+	for _, line := range strings.Split(out.String(), "\n") {
+		fmt.Println(text.AlignCenter.Apply(line, termWidth))
+	}
+}