diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 9bbf9b1..e9893f7 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -1,33 +1,13 @@ -name: Release Binaries +name: Release Artifacts on: - release: - types: [created] + push: + tags: + - "*" jobs: - commit_version_files: - name: Commit Version Files - permissions: - contents: write - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v4 - with: - ref: main - fetch-tags: true - - - name: Generate Version Files - run: | - go generate ./cmd/internal/version - - - name: Commit Version Files - uses: stefanzweifel/git-auto-commit-action@v5 - with: - commit_message: "release: update version files" - branch: main - releases-matrix: - name: Release Go Binary + name: Release flow Artifacts permissions: contents: write packages: write @@ -40,34 +20,20 @@ jobs: steps: - uses: actions/checkout@v4 + with: + fetch-depth: 0 - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "1.22.5" - - - name: Generate Version Files - run: | - go generate ./cmd/internal/version + go-version: "1.23.1" - - name: Release for Linux - uses: wangyoucao577/go-release-action@v1 - if: matrix.goos == 'linux' - with: - github_token: ${{ secrets.GITHUB_TOKEN }} - goos: ${{ matrix.goos }} - goarch: ${{ matrix.goarch }} - goversion: "1.22.5" - extra_files: LICENSE README.md - # This linux dependency is required for the clipboard package - pre_command: "apt-get update && apt-get -y install xclip" - - name: Release for MacOS - uses: wangyoucao577/go-release-action@v1 - if: matrix.goos == 'darwin' + - name: Run GoReleaser + uses: goreleaser/goreleaser-action@v6 with: - github_token: ${{ secrets.GITHUB_TOKEN }} - goos: ${{ matrix.goos }} - goarch: ${{ matrix.goarch }} - goversion: "1.22.5" - extra_files: LICENSE README.md + distribution: goreleaser + version: "~> v2" + args: release --clean + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/validate.yaml b/.github/workflows/validate.yaml index 77f6d36..2b8fe44 100644 --- a/.github/workflows/validate.yaml +++ b/.github/workflows/validate.yaml @@ -21,7 +21,7 @@ jobs: - name: Set up Go uses: actions/setup-go@v5 with: - go-version: "^1.22.5" + go-version: "^1.23.1" - name: Install Go Tools run: | @@ -69,7 +69,7 @@ jobs: - name: golangci-lint uses: golangci/golangci-lint-action@v6 with: - version: v1.57.2 + version: v1.60.3 # _____ _ # |_ _|__ ___| |_ diff --git a/.gitignore b/.gitignore index 87b44bf..ad441cf 100644 --- a/.gitignore +++ b/.gitignore @@ -25,6 +25,5 @@ coverage.txt .bin flow flow*.tar.gz -dist -completions/ - +cmd/internal/version/*.txt +dist/ diff --git a/.goreleaser.yaml b/.goreleaser.yaml new file mode 100644 index 0000000..4f269d3 --- /dev/null +++ b/.goreleaser.yaml @@ -0,0 +1,80 @@ +# Documentation https://goreleaser.com + +# yaml-language-server: $schema=https://goreleaser.com/static/schema.json +# vim: set ts=2 sw=2 tw=0 fo=cnqoj + +version: 2 +before: + hooks: + - go mod tidy + - go generate ./... + +builds: + - binary: flow + env: + - CGO_ENABLED=0 + goos: + - linux + - darwin + goarch: + - amd64 + - arm64 + mod_timestamp: '{{ .CommitTimestamp }}' + +gomod: + proxy: true + +archives: + - format: tar.gz + files: + - LICENSE + - README.md + - completions + name_template: >- + {{ .Binary }}_ + {{- .Tag }}_ + {{- .Os }}_ + {{- .Arch }} + +brews: + - name: flow + homepage: https://flowexec.io + license: Apache-2.0 + directory: Formula + repository: + owner: jahvon + name: homebrew-flow + dependencies: + - name: xclip + os: linux + install: | + bin.install "flow" + bash_completion.install "completions/flow.bash" + zsh_completion.install "completions/flow.zsh" + fish_completion.install "completions/flow.fish" + test: | + system "#{bin}/flow --version" + +dockers: + - image_templates: + - ghcr.io/jahvon/flow:latest + - ghcr.io/jahvon/flow:{{.Tag}} + +changelog: + sort: asc + groups: + - title: "New features" + regexp: '^(feat|\(feat.*\)):' + order: 0 + - title: "Bug fixes" + regexp: '^(fix|\(fix.*\)):' + order: 1 + - title: "Documentation updates" + regexp: '^(docs|\(docs.*\)):' + order: 2 + - title: Others + order: 999 + filters: + exclude: + - "^(chore|\\(chore\\))" + - "^(test|\\(test\\))" diff --git a/Dockerfile b/Dockerfile index 8e4ffae..f743ee9 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,7 +1,20 @@ -FROM golang:alpine +FROM golang:1.23.1-bookworm -WORKDIR /app -COPY . /app -RUN go build -o flow +WORKDIR /workspaces +ENV DISABLE_FLOW_INTERACTIVE="true" -ENTRYPOINT ["./flow"] +# TODO: replace with examples repo +ENV WORKSPACE="flow" +ENV REPO="https://github.com/jahvon/flow.git" +ENV BRANCH="" + +COPY . flow +WORKDIR /workspaces/flow +RUN go build -o /usr/local/bin/flow main.go && chmod +x /usr/local/bin/flow && rm -rf /workspaces/flow + +WORKDIR /workspaces +RUN if [ -z "$BRANCH" ]; then git clone $REPO .; else git clone -b $BRANCH $REPO .; fi +RUN flow init workspace $WORKSPACE . --set + +ENTRYPOINT ["flow"] +CMD ["get", "workspace"] \ No newline at end of file diff --git a/cmd/internal/version/version.go b/cmd/internal/version/version.go index e10bd34..4d77721 100644 --- a/cmd/internal/version/version.go +++ b/cmd/internal/version/version.go @@ -24,6 +24,10 @@ var ( buildDate string ) +const ( + unknown = "unknown" +) + // GoVersion returns the version of the go runtime used to compile the binary. var goVersion = runtime.Version() @@ -32,6 +36,15 @@ var osArch = fmt.Sprintf("%s %s", runtime.GOOS, runtime.GOARCH) // generateOutput return the output of the version command. func generateOutput() string { + if gitCommit == "" { + gitCommit = unknown + } + if version == "" { + version = unknown + } + if buildDate == "" { + buildDate = unknown + } return fmt.Sprintf(` Version: %s diff --git a/completions/flow.bash b/completions/flow.bash new file mode 100644 index 0000000..2d63d9b --- /dev/null +++ b/completions/flow.bash @@ -0,0 +1,338 @@ +# bash completion V2 for flow -*- shell-script -*- + +__flow_debug() +{ + if [[ -n ${BASH_COMP_DEBUG_FILE-} ]]; then + echo "$*" >> "${BASH_COMP_DEBUG_FILE}" + fi +} + +# Macs have bash3 for which the bash-completion package doesn't include +# _init_completion. This is a minimal version of that function. +__flow_init_completion() +{ + COMPREPLY=() + _get_comp_words_by_ref "$@" cur prev words cword +} + +# This function calls the flow program to obtain the completion +# results and the directive. It fills the 'out' and 'directive' vars. +__flow_get_completion_results() { + local requestComp lastParam lastChar args + + # Prepare the command to request completions for the program. + # Calling ${words[0]} instead of directly flow allows handling aliases + args=("${words[@]:1}") + requestComp="${words[0]} __complete ${args[*]}" + + lastParam=${words[$((${#words[@]}-1))]} + lastChar=${lastParam:$((${#lastParam}-1)):1} + __flow_debug "lastParam ${lastParam}, lastChar ${lastChar}" + + if [[ -z ${cur} && ${lastChar} != = ]]; then + # If the last parameter is complete (there is a space following it) + # We add an extra empty parameter so we can indicate this to the go method. + __flow_debug "Adding extra empty parameter" + requestComp="${requestComp} ''" + fi + + # When completing a flag with an = (e.g., flow -n=) + # bash focuses on the part after the =, so we need to remove + # the flag part from $cur + if [[ ${cur} == -*=* ]]; then + cur="${cur#*=}" + fi + + __flow_debug "Calling ${requestComp}" + # Use eval to handle any environment variables and such + out=$(eval "${requestComp}" 2>/dev/null) + + # Extract the directive integer at the very end of the output following a colon (:) + directive=${out##*:} + # Remove the directive + out=${out%:*} + if [[ ${directive} == "${out}" ]]; then + # There is not directive specified + directive=0 + fi + __flow_debug "The completion directive is: ${directive}" + __flow_debug "The completions are: ${out}" +} + +__flow_process_completion_results() { + local shellCompDirectiveError=1 + local shellCompDirectiveNoSpace=2 + local shellCompDirectiveNoFileComp=4 + local shellCompDirectiveFilterFileExt=8 + local shellCompDirectiveFilterDirs=16 + local shellCompDirectiveKeepOrder=32 + + if (((directive & shellCompDirectiveError) != 0)); then + # Error code. No completion. + __flow_debug "Received error from custom completion go code" + return + else + if (((directive & shellCompDirectiveNoSpace) != 0)); then + if [[ $(type -t compopt) == builtin ]]; then + __flow_debug "Activating no space" + compopt -o nospace + else + __flow_debug "No space directive not supported in this version of bash" + fi + fi + if (((directive & shellCompDirectiveKeepOrder) != 0)); then + if [[ $(type -t compopt) == builtin ]]; then + # no sort isn't supported for bash less than < 4.4 + if [[ ${BASH_VERSINFO[0]} -lt 4 || ( ${BASH_VERSINFO[0]} -eq 4 && ${BASH_VERSINFO[1]} -lt 4 ) ]]; then + __flow_debug "No sort directive not supported in this version of bash" + else + __flow_debug "Activating keep order" + compopt -o nosort + fi + else + __flow_debug "No sort directive not supported in this version of bash" + fi + fi + if (((directive & shellCompDirectiveNoFileComp) != 0)); then + if [[ $(type -t compopt) == builtin ]]; then + __flow_debug "Activating no file completion" + compopt +o default + else + __flow_debug "No file completion directive not supported in this version of bash" + fi + fi + fi + + # Separate activeHelp from normal completions + local completions=() + local activeHelp=() + __flow_extract_activeHelp + + if (((directive & shellCompDirectiveFilterFileExt) != 0)); then + # File extension filtering + local fullFilter filter filteringCmd + + # Do not use quotes around the $completions variable or else newline + # characters will be kept. + for filter in ${completions[*]}; do + fullFilter+="$filter|" + done + + filteringCmd="_filedir $fullFilter" + __flow_debug "File filtering command: $filteringCmd" + $filteringCmd + elif (((directive & shellCompDirectiveFilterDirs) != 0)); then + # File completion for directories only + + local subdir + subdir=${completions[0]} + if [[ -n $subdir ]]; then + __flow_debug "Listing directories in $subdir" + pushd "$subdir" >/dev/null 2>&1 && _filedir -d && popd >/dev/null 2>&1 || return + else + __flow_debug "Listing directories in ." + _filedir -d + fi + else + __flow_handle_completion_types + fi + + __flow_handle_special_char "$cur" : + __flow_handle_special_char "$cur" = + + # Print the activeHelp statements before we finish + if ((${#activeHelp[*]} != 0)); then + printf "\n"; + printf "%s\n" "${activeHelp[@]}" + printf "\n" + + # The prompt format is only available from bash 4.4. + # We test if it is available before using it. + if (x=${PS1@P}) 2> /dev/null; then + printf "%s" "${PS1@P}${COMP_LINE[@]}" + else + # Can't print the prompt. Just print the + # text the user had typed, it is workable enough. + printf "%s" "${COMP_LINE[@]}" + fi + fi +} + +# Separate activeHelp lines from real completions. +# Fills the $activeHelp and $completions arrays. +__flow_extract_activeHelp() { + local activeHelpMarker="_activeHelp_ " + local endIndex=${#activeHelpMarker} + + while IFS='' read -r comp; do + if [[ ${comp:0:endIndex} == $activeHelpMarker ]]; then + comp=${comp:endIndex} + __flow_debug "ActiveHelp found: $comp" + if [[ -n $comp ]]; then + activeHelp+=("$comp") + fi + else + # Not an activeHelp line but a normal completion + completions+=("$comp") + fi + done <<<"${out}" +} + +__flow_handle_completion_types() { + __flow_debug "__flow_handle_completion_types: COMP_TYPE is $COMP_TYPE" + + case $COMP_TYPE in + 37|42) + # Type: menu-complete/menu-complete-backward and insert-completions + # If the user requested inserting one completion at a time, or all + # completions at once on the command-line we must remove the descriptions. + # https://github.com/spf13/cobra/issues/1508 + local tab=$'\t' comp + while IFS='' read -r comp; do + [[ -z $comp ]] && continue + # Strip any description + comp=${comp%%$tab*} + # Only consider the completions that match + if [[ $comp == "$cur"* ]]; then + COMPREPLY+=("$comp") + fi + done < <(printf "%s\n" "${completions[@]}") + ;; + + *) + # Type: complete (normal completion) + __flow_handle_standard_completion_case + ;; + esac +} + +__flow_handle_standard_completion_case() { + local tab=$'\t' comp + + # Short circuit to optimize if we don't have descriptions + if [[ "${completions[*]}" != *$tab* ]]; then + IFS=$'\n' read -ra COMPREPLY -d '' < <(compgen -W "${completions[*]}" -- "$cur") + return 0 + fi + + local longest=0 + local compline + # Look for the longest completion so that we can format things nicely + while IFS='' read -r compline; do + [[ -z $compline ]] && continue + # Strip any description before checking the length + comp=${compline%%$tab*} + # Only consider the completions that match + [[ $comp == "$cur"* ]] || continue + COMPREPLY+=("$compline") + if ((${#comp}>longest)); then + longest=${#comp} + fi + done < <(printf "%s\n" "${completions[@]}") + + # If there is a single completion left, remove the description text + if ((${#COMPREPLY[*]} == 1)); then + __flow_debug "COMPREPLY[0]: ${COMPREPLY[0]}" + comp="${COMPREPLY[0]%%$tab*}" + __flow_debug "Removed description from single completion, which is now: ${comp}" + COMPREPLY[0]=$comp + else # Format the descriptions + __flow_format_comp_descriptions $longest + fi +} + +__flow_handle_special_char() +{ + local comp="$1" + local char=$2 + if [[ "$comp" == *${char}* && "$COMP_WORDBREAKS" == *${char}* ]]; then + local word=${comp%"${comp##*${char}}"} + local idx=${#COMPREPLY[*]} + while ((--idx >= 0)); do + COMPREPLY[idx]=${COMPREPLY[idx]#"$word"} + done + fi +} + +__flow_format_comp_descriptions() +{ + local tab=$'\t' + local comp desc maxdesclength + local longest=$1 + + local i ci + for ci in ${!COMPREPLY[*]}; do + comp=${COMPREPLY[ci]} + # Properly format the description string which follows a tab character if there is one + if [[ "$comp" == *$tab* ]]; then + __flow_debug "Original comp: $comp" + desc=${comp#*$tab} + comp=${comp%%$tab*} + + # $COLUMNS stores the current shell width. + # Remove an extra 4 because we add 2 spaces and 2 parentheses. + maxdesclength=$(( COLUMNS - longest - 4 )) + + # Make sure we can fit a description of at least 8 characters + # if we are to align the descriptions. + if ((maxdesclength > 8)); then + # Add the proper number of spaces to align the descriptions + for ((i = ${#comp} ; i < longest ; i++)); do + comp+=" " + done + else + # Don't pad the descriptions so we can fit more text after the completion + maxdesclength=$(( COLUMNS - ${#comp} - 4 )) + fi + + # If there is enough space for any description text, + # truncate the descriptions that are too long for the shell width + if ((maxdesclength > 0)); then + if ((${#desc} > maxdesclength)); then + desc=${desc:0:$(( maxdesclength - 1 ))} + desc+="…" + fi + comp+=" ($desc)" + fi + COMPREPLY[ci]=$comp + __flow_debug "Final comp: $comp" + fi + done +} + +__start_flow() +{ + local cur prev words cword split + + COMPREPLY=() + + # Call _init_completion from the bash-completion package + # to prepare the arguments properly + if declare -F _init_completion >/dev/null 2>&1; then + _init_completion -n =: || return + else + __flow_init_completion -n =: || return + fi + + __flow_debug + __flow_debug "========= starting completion logic ==========" + __flow_debug "cur is ${cur}, words[*] is ${words[*]}, #words[@] is ${#words[@]}, cword is $cword" + + # The user could have moved the cursor backwards on the command-line. + # We need to trigger completion from the $cword location, so we need + # to truncate the command-line ($words) up to the $cword location. + words=("${words[@]:0:$cword+1}") + __flow_debug "Truncated words[*]: ${words[*]}," + + local out directive + __flow_get_completion_results + __flow_process_completion_results +} + +if [[ $(type -t compopt) = "builtin" ]]; then + complete -o default -F __start_flow flow +else + complete -o default -o nospace -F __start_flow flow +fi + +# ex: ts=4 sw=4 et filetype=sh diff --git a/completions/flow.fish b/completions/flow.fish new file mode 100644 index 0000000..d5be454 --- /dev/null +++ b/completions/flow.fish @@ -0,0 +1,235 @@ +# fish completion for flow -*- shell-script -*- + +function __flow_debug + set -l file "$BASH_COMP_DEBUG_FILE" + if test -n "$file" + echo "$argv" >> $file + end +end + +function __flow_perform_completion + __flow_debug "Starting __flow_perform_completion" + + # Extract all args except the last one + set -l args (commandline -opc) + # Extract the last arg and escape it in case it is a space + set -l lastArg (string escape -- (commandline -ct)) + + __flow_debug "args: $args" + __flow_debug "last arg: $lastArg" + + # Disable ActiveHelp which is not supported for fish shell + set -l requestComp "FLOW_ACTIVE_HELP=0 $args[1] __complete $args[2..-1] $lastArg" + + __flow_debug "Calling $requestComp" + set -l results (eval $requestComp 2> /dev/null) + + # Some programs may output extra empty lines after the directive. + # Let's ignore them or else it will break completion. + # Ref: https://github.com/spf13/cobra/issues/1279 + for line in $results[-1..1] + if test (string trim -- $line) = "" + # Found an empty line, remove it + set results $results[1..-2] + else + # Found non-empty line, we have our proper output + break + end + end + + set -l comps $results[1..-2] + set -l directiveLine $results[-1] + + # For Fish, when completing a flag with an = (e.g., -n=) + # completions must be prefixed with the flag + set -l flagPrefix (string match -r -- '-.*=' "$lastArg") + + __flow_debug "Comps: $comps" + __flow_debug "DirectiveLine: $directiveLine" + __flow_debug "flagPrefix: $flagPrefix" + + for comp in $comps + printf "%s%s\n" "$flagPrefix" "$comp" + end + + printf "%s\n" "$directiveLine" +end + +# this function limits calls to __flow_perform_completion, by caching the result behind $__flow_perform_completion_once_result +function __flow_perform_completion_once + __flow_debug "Starting __flow_perform_completion_once" + + if test -n "$__flow_perform_completion_once_result" + __flow_debug "Seems like a valid result already exists, skipping __flow_perform_completion" + return 0 + end + + set --global __flow_perform_completion_once_result (__flow_perform_completion) + if test -z "$__flow_perform_completion_once_result" + __flow_debug "No completions, probably due to a failure" + return 1 + end + + __flow_debug "Performed completions and set __flow_perform_completion_once_result" + return 0 +end + +# this function is used to clear the $__flow_perform_completion_once_result variable after completions are run +function __flow_clear_perform_completion_once_result + __flow_debug "" + __flow_debug "========= clearing previously set __flow_perform_completion_once_result variable ==========" + set --erase __flow_perform_completion_once_result + __flow_debug "Successfully erased the variable __flow_perform_completion_once_result" +end + +function __flow_requires_order_preservation + __flow_debug "" + __flow_debug "========= checking if order preservation is required ==========" + + __flow_perform_completion_once + if test -z "$__flow_perform_completion_once_result" + __flow_debug "Error determining if order preservation is required" + return 1 + end + + set -l directive (string sub --start 2 $__flow_perform_completion_once_result[-1]) + __flow_debug "Directive is: $directive" + + set -l shellCompDirectiveKeepOrder 32 + set -l keeporder (math (math --scale 0 $directive / $shellCompDirectiveKeepOrder) % 2) + __flow_debug "Keeporder is: $keeporder" + + if test $keeporder -ne 0 + __flow_debug "This does require order preservation" + return 0 + end + + __flow_debug "This doesn't require order preservation" + return 1 +end + + +# This function does two things: +# - Obtain the completions and store them in the global __flow_comp_results +# - Return false if file completion should be performed +function __flow_prepare_completions + __flow_debug "" + __flow_debug "========= starting completion logic ==========" + + # Start fresh + set --erase __flow_comp_results + + __flow_perform_completion_once + __flow_debug "Completion results: $__flow_perform_completion_once_result" + + if test -z "$__flow_perform_completion_once_result" + __flow_debug "No completion, probably due to a failure" + # Might as well do file completion, in case it helps + return 1 + end + + set -l directive (string sub --start 2 $__flow_perform_completion_once_result[-1]) + set --global __flow_comp_results $__flow_perform_completion_once_result[1..-2] + + __flow_debug "Completions are: $__flow_comp_results" + __flow_debug "Directive is: $directive" + + set -l shellCompDirectiveError 1 + set -l shellCompDirectiveNoSpace 2 + set -l shellCompDirectiveNoFileComp 4 + set -l shellCompDirectiveFilterFileExt 8 + set -l shellCompDirectiveFilterDirs 16 + + if test -z "$directive" + set directive 0 + end + + set -l compErr (math (math --scale 0 $directive / $shellCompDirectiveError) % 2) + if test $compErr -eq 1 + __flow_debug "Received error directive: aborting." + # Might as well do file completion, in case it helps + return 1 + end + + set -l filefilter (math (math --scale 0 $directive / $shellCompDirectiveFilterFileExt) % 2) + set -l dirfilter (math (math --scale 0 $directive / $shellCompDirectiveFilterDirs) % 2) + if test $filefilter -eq 1; or test $dirfilter -eq 1 + __flow_debug "File extension filtering or directory filtering not supported" + # Do full file completion instead + return 1 + end + + set -l nospace (math (math --scale 0 $directive / $shellCompDirectiveNoSpace) % 2) + set -l nofiles (math (math --scale 0 $directive / $shellCompDirectiveNoFileComp) % 2) + + __flow_debug "nospace: $nospace, nofiles: $nofiles" + + # If we want to prevent a space, or if file completion is NOT disabled, + # we need to count the number of valid completions. + # To do so, we will filter on prefix as the completions we have received + # may not already be filtered so as to allow fish to match on different + # criteria than the prefix. + if test $nospace -ne 0; or test $nofiles -eq 0 + set -l prefix (commandline -t | string escape --style=regex) + __flow_debug "prefix: $prefix" + + set -l completions (string match -r -- "^$prefix.*" $__flow_comp_results) + set --global __flow_comp_results $completions + __flow_debug "Filtered completions are: $__flow_comp_results" + + # Important not to quote the variable for count to work + set -l numComps (count $__flow_comp_results) + __flow_debug "numComps: $numComps" + + if test $numComps -eq 1; and test $nospace -ne 0 + # We must first split on \t to get rid of the descriptions to be + # able to check what the actual completion will be. + # We don't need descriptions anyway since there is only a single + # real completion which the shell will expand immediately. + set -l split (string split --max 1 \t $__flow_comp_results[1]) + + # Fish won't add a space if the completion ends with any + # of the following characters: @=/:., + set -l lastChar (string sub -s -1 -- $split) + if not string match -r -q "[@=/:.,]" -- "$lastChar" + # In other cases, to support the "nospace" directive we trick the shell + # by outputting an extra, longer completion. + __flow_debug "Adding second completion to perform nospace directive" + set --global __flow_comp_results $split[1] $split[1]. + __flow_debug "Completions are now: $__flow_comp_results" + end + end + + if test $numComps -eq 0; and test $nofiles -eq 0 + # To be consistent with bash and zsh, we only trigger file + # completion when there are no other completions + __flow_debug "Requesting file completion" + return 1 + end + end + + return 0 +end + +# Since Fish completions are only loaded once the user triggers them, we trigger them ourselves +# so we can properly delete any completions provided by another script. +# Only do this if the program can be found, or else fish may print some errors; besides, +# the existing completions will only be loaded if the program can be found. +if type -q "flow" + # The space after the program name is essential to trigger completion for the program + # and not completion of the program name itself. + # Also, we use '> /dev/null 2>&1' since '&>' is not supported in older versions of fish. + complete --do-complete "flow " > /dev/null 2>&1 +end + +# Remove any pre-existing completions for the program since we will be handling all of them. +complete -c flow -e + +# this will get called after the two calls below and clear the $__flow_perform_completion_once_result global +complete -c flow -n '__flow_clear_perform_completion_once_result' +# The call to __flow_prepare_completions will setup __flow_comp_results +# which provides the program's completion choices. +# If this doesn't require order preservation, we don't use the -k flag +complete -c flow -n 'not __flow_requires_order_preservation && __flow_prepare_completions' -f -a '$__flow_comp_results' +# otherwise we use the -k flag +complete -k -c flow -n '__flow_requires_order_preservation && __flow_prepare_completions' -f -a '$__flow_comp_results' diff --git a/completions/flow.zsh b/completions/flow.zsh new file mode 100644 index 0000000..a7ca3dd --- /dev/null +++ b/completions/flow.zsh @@ -0,0 +1,212 @@ +#compdef flow +compdef _flow flow + +# zsh completion for flow -*- shell-script -*- + +__flow_debug() +{ + local file="$BASH_COMP_DEBUG_FILE" + if [[ -n ${file} ]]; then + echo "$*" >> "${file}" + fi +} + +_flow() +{ + local shellCompDirectiveError=1 + local shellCompDirectiveNoSpace=2 + local shellCompDirectiveNoFileComp=4 + local shellCompDirectiveFilterFileExt=8 + local shellCompDirectiveFilterDirs=16 + local shellCompDirectiveKeepOrder=32 + + local lastParam lastChar flagPrefix requestComp out directive comp lastComp noSpace keepOrder + local -a completions + + __flow_debug "\n========= starting completion logic ==========" + __flow_debug "CURRENT: ${CURRENT}, words[*]: ${words[*]}" + + # The user could have moved the cursor backwards on the command-line. + # We need to trigger completion from the $CURRENT location, so we need + # to truncate the command-line ($words) up to the $CURRENT location. + # (We cannot use $CURSOR as its value does not work when a command is an alias.) + words=("${=words[1,CURRENT]}") + __flow_debug "Truncated words[*]: ${words[*]}," + + lastParam=${words[-1]} + lastChar=${lastParam[-1]} + __flow_debug "lastParam: ${lastParam}, lastChar: ${lastChar}" + + # For zsh, when completing a flag with an = (e.g., flow -n=) + # completions must be prefixed with the flag + setopt local_options BASH_REMATCH + if [[ "${lastParam}" =~ '-.*=' ]]; then + # We are dealing with a flag with an = + flagPrefix="-P ${BASH_REMATCH}" + fi + + # Prepare the command to obtain completions + requestComp="${words[1]} __complete ${words[2,-1]}" + if [ "${lastChar}" = "" ]; then + # If the last parameter is complete (there is a space following it) + # We add an extra empty parameter so we can indicate this to the go completion code. + __flow_debug "Adding extra empty parameter" + requestComp="${requestComp} \"\"" + fi + + __flow_debug "About to call: eval ${requestComp}" + + # Use eval to handle any environment variables and such + out=$(eval ${requestComp} 2>/dev/null) + __flow_debug "completion output: ${out}" + + # Extract the directive integer following a : from the last line + local lastLine + while IFS='\n' read -r line; do + lastLine=${line} + done < <(printf "%s\n" "${out[@]}") + __flow_debug "last line: ${lastLine}" + + if [ "${lastLine[1]}" = : ]; then + directive=${lastLine[2,-1]} + # Remove the directive including the : and the newline + local suffix + (( suffix=${#lastLine}+2)) + out=${out[1,-$suffix]} + else + # There is no directive specified. Leave $out as is. + __flow_debug "No directive found. Setting do default" + directive=0 + fi + + __flow_debug "directive: ${directive}" + __flow_debug "completions: ${out}" + __flow_debug "flagPrefix: ${flagPrefix}" + + if [ $((directive & shellCompDirectiveError)) -ne 0 ]; then + __flow_debug "Completion received error. Ignoring completions." + return + fi + + local activeHelpMarker="_activeHelp_ " + local endIndex=${#activeHelpMarker} + local startIndex=$((${#activeHelpMarker}+1)) + local hasActiveHelp=0 + while IFS='\n' read -r comp; do + # Check if this is an activeHelp statement (i.e., prefixed with $activeHelpMarker) + if [ "${comp[1,$endIndex]}" = "$activeHelpMarker" ];then + __flow_debug "ActiveHelp found: $comp" + comp="${comp[$startIndex,-1]}" + if [ -n "$comp" ]; then + compadd -x "${comp}" + __flow_debug "ActiveHelp will need delimiter" + hasActiveHelp=1 + fi + + continue + fi + + if [ -n "$comp" ]; then + # If requested, completions are returned with a description. + # The description is preceded by a TAB character. + # For zsh's _describe, we need to use a : instead of a TAB. + # We first need to escape any : as part of the completion itself. + comp=${comp//:/\\:} + + local tab="$(printf '\t')" + comp=${comp//$tab/:} + + __flow_debug "Adding completion: ${comp}" + completions+=${comp} + lastComp=$comp + fi + done < <(printf "%s\n" "${out[@]}") + + # Add a delimiter after the activeHelp statements, but only if: + # - there are completions following the activeHelp statements, or + # - file completion will be performed (so there will be choices after the activeHelp) + if [ $hasActiveHelp -eq 1 ]; then + if [ ${#completions} -ne 0 ] || [ $((directive & shellCompDirectiveNoFileComp)) -eq 0 ]; then + __flow_debug "Adding activeHelp delimiter" + compadd -x "--" + hasActiveHelp=0 + fi + fi + + if [ $((directive & shellCompDirectiveNoSpace)) -ne 0 ]; then + __flow_debug "Activating nospace." + noSpace="-S ''" + fi + + if [ $((directive & shellCompDirectiveKeepOrder)) -ne 0 ]; then + __flow_debug "Activating keep order." + keepOrder="-V" + fi + + if [ $((directive & shellCompDirectiveFilterFileExt)) -ne 0 ]; then + # File extension filtering + local filteringCmd + filteringCmd='_files' + for filter in ${completions[@]}; do + if [ ${filter[1]} != '*' ]; then + # zsh requires a glob pattern to do file filtering + filter="\*.$filter" + fi + filteringCmd+=" -g $filter" + done + filteringCmd+=" ${flagPrefix}" + + __flow_debug "File filtering command: $filteringCmd" + _arguments '*:filename:'"$filteringCmd" + elif [ $((directive & shellCompDirectiveFilterDirs)) -ne 0 ]; then + # File completion for directories only + local subdir + subdir="${completions[1]}" + if [ -n "$subdir" ]; then + __flow_debug "Listing directories in $subdir" + pushd "${subdir}" >/dev/null 2>&1 + else + __flow_debug "Listing directories in ." + fi + + local result + _arguments '*:dirname:_files -/'" ${flagPrefix}" + result=$? + if [ -n "$subdir" ]; then + popd >/dev/null 2>&1 + fi + return $result + else + __flow_debug "Calling _describe" + if eval _describe $keepOrder "completions" completions $flagPrefix $noSpace; then + __flow_debug "_describe found some completions" + + # Return the success of having called _describe + return 0 + else + __flow_debug "_describe did not find completions." + __flow_debug "Checking if we should do file completion." + if [ $((directive & shellCompDirectiveNoFileComp)) -ne 0 ]; then + __flow_debug "deactivating file completion" + + # We must return an error code here to let zsh know that there were no + # completions found by _describe; this is what will trigger other + # matching algorithms to attempt to find completions. + # For example zsh can match letters in the middle of words. + return 1 + else + # Perform file completion + __flow_debug "Activating file completion" + + # We must return the result of this command, so it must be the + # last command, or else we must store its result to return it. + _arguments '*:filename:_files'" ${flagPrefix}" + fi + fi + fi +} + +# don't run the completion function when being source-ed or eval-ed +if [ "$funcstack[1]" = "_flow" ]; then + _flow +fi diff --git a/development.flow b/development.flow index 2776b07..f28cca1 100644 --- a/development.flow +++ b/development.flow @@ -41,7 +41,11 @@ executables: exec: dir: // cmd: | + echo "generating code..." go generate ./... + echo "generating completions..." + ./scripts/completions.sh + go run ./tools/docsgen/. - verb: run @@ -83,6 +87,8 @@ executables: go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.60.3 echo "installing ginkgo..." go install github.com/onsi/ginkgo/v2/ginkgo@v2.20.2 + echo "installing goreleaser..." + go install github.com/goreleaser/goreleaser@v2.2.0 - verb: update name: modules @@ -94,4 +100,94 @@ executables: cmd: | echo "updating go modules..." go get -u ./... - go mod tidy \ No newline at end of file + go mod tidy + + - verb: build + name: container + description: Build the flow container image + tags: [docker, development] + aliases: [docker, image] + exec: + dir: // + args: + - envKey: BUILDER + default: docker + flag: builder + - envKey: IMAGE_REPO + default: jahvon/flow + flag: repo + - envKey: IMAGE_TAG + default: latest + flag: tag + cmd: | + echo "building container image..." + $BUILDER build -t $IMAGE_REPO:$IMAGE_TAG . + + - verb: run + name: container + description: Run the flow container image + tags: [docker, development] + aliases: [image, docker] + exec: + dir: // + logMode: text + args: + - envKey: BUILDER + default: docker + flag: builder + - envKey: IMAGE_REPO + default: jahvon/flow + flag: repo + - envKey: IMAGE_TAG + default: latest + flag: tag + - envKey: WORKSPACE + default: active + flag: workspace + - envKey: GIT_REPO + default: https://github.com/jahvon/flow.git + flag: repo + - envKey: BRANCH + default: main + flag: branch + - envKey: CONTAINER_CMD + default: "get workspace" + flag: cmd + cmd: | + echo "running container image..." + $BUILDER run -it -e GIT_REPO=$GIT_REPO \ + -e BRANCH=$BRANCH \ + -e WORKSPACE=$WORKSPACE \ + -t $IMAGE_REPO:$IMAGE_TAG \ + $CONTAINER_CMD + + - verb: release + name: container + description: Push the flow container image to the registry + tags: [docker, development] + aliases: [image, docker] + exec: + dir: // + args: + - envKey: BUILDER + default: docker + flag: builder + - envKey: IMAGE_REPO + default: jahvon/flow + flag: repo + - envKey: IMAGE_TAG + default: latest + flag: tag + cmd: | + echo "pushing container image..." + $BUILDER push $IMAGE_REPO:$IMAGE_TAG + + - verb: release + name: snapshot + description: Create a snapshot release + aliases: [snap] + exec: + dir: // + cmd: | + echo "creating snapshot release..." + goreleaser release --snapshot --clean diff --git a/scripts/completions/flow.bash b/scripts/completions/flow.bash new file mode 100644 index 0000000..e69de29