diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..1923d41 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +root = true + +[*] +indent_style = space +indent_size = 2 +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml new file mode 100644 index 0000000..e77117c --- /dev/null +++ b/.github/workflows/workflow.yml @@ -0,0 +1,70 @@ +name: Main workflow + +on: + pull_request: + push: + schedule: + - cron: 0 0 * * 5 + +jobs: + plugin_test: + strategy: + fail-fast: false + matrix: + os: + - macos-latest + - ubuntu-latest + + runs-on: ${{ matrix.os }} + + steps: + - name: asdf_plugin_test + uses: asdf-vm/actions/plugin-test@v1 + with: + command: zig version + + test: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Setup asdf + uses: asdf-vm/actions/setup@v1 + + - name: Install bats-core + run: brew install bats-core + + - name: Test plugin + run: | + asdf plugin-add zig $GITHUB_WORKSPACE + make test + env: + GITHUB_API_TOKEN: ${{ github.token }} + + lint: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Install ShellCheck + run: brew install shellcheck + + - name: Run ShellCheck + run: make lint + + format: + runs-on: ubuntu-latest + + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Install shfmt + run: brew install shfmt + + - name: Run shfmt + run: make fmt-check diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..c8fe09a --- /dev/null +++ b/Makefile @@ -0,0 +1,18 @@ +SH_SRCFILES = $(shell git ls-files "bin/*") +SHFMT_BASE_FLAGS = -s -i 2 -ci + +fmt: + shfmt -w $(SHFMT_BASE_FLAGS) $(SH_SRCFILES) +.PHONY: fmt + +fmt-check: + shfmt -d $(SHFMT_BASE_FLAGS) $(SH_SRCFILES) +.PHONY: fmt-check + +lint: + shellcheck $(SH_SRCFILES) +.PHONY: lint + +test: + bats test +.PHONY: test diff --git a/bin/install b/bin/install new file mode 100755 index 0000000..8ceec84 --- /dev/null +++ b/bin/install @@ -0,0 +1,76 @@ +#!/usr/bin/env bash + +set -eo pipefail + +# shellcheck disable=SC1090 +source "$(dirname "$0")/../lib/json.bash" + +trap cleanup SIGINT SIGTERM ERR + +cleanup() { + trap - SIGINT SIGTERM ERR + rm -rf "$ASDF_INSTALL_PATH" + echo + echo -e "\e[33mCleanup:\e[m Something went wrong!" + echo + echo "$(caller): ${BASH_COMMAND}" +} + +fail() { + echo -e "\e[31mFail:\e[m $*" + exit 1 +} + +install_zig() { + local install_type=$1 + local version=$2 + local install_path=$3 + + if [ "$install_type" != "version" ]; then + fail "asdf-zig supports release installs only" + fi + + local platform + + case "$OSTYPE" in + darwin*) platform="macos" ;; + freebsd*) platform="freebsd" ;; + linux*) platform="linux" ;; + *) fail "Unsupported platform" ;; + esac + + local architecture + + case "$(uname -m)" in + aarch64* | arm64) architecture="aarch64" ;; + armv7*) architecture="armv7a" ;; + i686*) architecture="i386" ;; + riscv64*) architecture="riscv64" ;; + x86_64*) architecture="x86_64" ;; + *) fail "Unsupported architecture" ;; + esac + + local json + json=$(curl --fail --silent --location https://ziglang.org/download/index.json) + + local download_url + download_url=$( + json_parse "$json" | + grep "$version" | + grep "${architecture}-${platform}" | + grep "tarball" | + awk 'NR==1 { print $2 }' | + tr -d '"' + ) + + local source_path="${install_path}/zig-${platform}-${architecture}-${version}.tar.xz" + + echo "∗ Downloading and installing Zig..." + curl --fail --silent --location --create-dirs --output "$source_path" "$download_url" + tar -xf "$source_path" -C "$install_path" --strip-components=1 + mkdir -p "${install_path}/bin" + ln -s "${install_path}/zig" "${install_path}/bin/zig" + echo "The installation was successful!" +} + +install_zig "$ASDF_INSTALL_TYPE" "$ASDF_INSTALL_VERSION" "$ASDF_INSTALL_PATH" diff --git a/bin/list-all b/bin/list-all new file mode 100755 index 0000000..70952b8 --- /dev/null +++ b/bin/list-all @@ -0,0 +1,20 @@ +#!/bin/bash + +set -Eeo pipefail + +# shellcheck disable=SC1090 +source "$(dirname "$0")/../lib/json.bash" + +json=$(curl --fail --silent --location https://ziglang.org/download/index.json) + +sort_versions() { + sed 'h; s/[+-]/./g; s/.p\([[:digit:]]\)/.z\1/; s/$/.z/; G; s/\n/ /' | + LC_ALL=C sort -t. -k 1,1 -k 2,2n -k 3,3n -k 4,4n -k 5,5n | awk '{print $2}' +} + +json_parse "$json" | + sed 's/^\[\(.*\)\].*$/\1/' | + grep -Eo '[0-9]+.[0-9]+.[0-9]+' | + uniq | + sort_versions | + xargs echo diff --git a/lib/json.bash b/lib/json.bash new file mode 100755 index 0000000..101a5e2 --- /dev/null +++ b/lib/json.bash @@ -0,0 +1,155 @@ +#!/usr/bin/env bash + +# JSON parsing stolen from https://github.com/dominictarr/JSON.sh + +throw() { + echo "$*" >&2 + exit 1 +} + +awk_egrep() { + local pattern_string=$1 + + gawk '{ + while ($0) { + start=match($0, pattern); + token=substr($0, start, RLENGTH); + print token; + $0=substr($0, start+RLENGTH); + } + }' pattern="$pattern_string" +} + +json_tokenize() { + local GREP + local ESCAPE + local CHAR + + if echo "test string" | egrep -ao --color=never "test" >/dev/null 2>&1; then + GREP='egrep -ao --color=never' + else + GREP='egrep -ao' + fi + + if echo "test string" | egrep -o "test" >/dev/null 2>&1; then + ESCAPE='(\\[^u[:cntrl:]]|\\u[0-9a-fA-F]{4})' + CHAR='[^[:cntrl:]"\\]' + else + GREP=awk_egrep + ESCAPE='(\\\\[^u[:cntrl:]]|\\u[0-9a-fA-F]{4})' + CHAR='[^[:cntrl:]"\\\\]' + fi + + local STRING="\"$CHAR*($ESCAPE$CHAR*)*\"" + local NUMBER='-?(0|[1-9][0-9]*)([.][0-9]*)?([eE][+-]?[0-9]*)?' + local KEYWORD='null|false|true' + local SPACE='[[:space:]]+' + + # Force zsh to expand $A into multiple words + local is_wordsplit_disabled=$(unsetopt 2>/dev/null | grep -c '^shwordsplit$') + if [ $is_wordsplit_disabled != 0 ]; then setopt shwordsplit; fi + $GREP "$STRING|$NUMBER|$KEYWORD|$SPACE|." | egrep -v "^$SPACE$" + if [ $is_wordsplit_disabled != 0 ]; then unsetopt shwordsplit; fi +} + +json_parse_array() { + local index=0 + local ary='' + + read -r token + case "$token" in + ']') ;; + *) + while :; do + json_parse_value "$1" "$index" + index=$((index + 1)) + ary="$ary""$value" + + read -r token + case "$token" in + ']') break ;; + ',') ary="$ary," ;; + *) fail "EXPECTED , or ] GOT ${token:-EOF}" ;; + esac + + read -r token + done + ;; + esac + + value=$(printf '[%s]' "$ary") +} + +json_parse_object() { + local key + local obj='' + + read -r token + case "$token" in + '}') ;; + *) + while :; do + case "$token" in + '"'*'"') key=$token ;; + *) fail "EXPECTED string GOT ${token:-EOF}" ;; + esac + + read -r token + case "$token" in + ':') ;; + *) fail "EXPECTED : GOT ${token:-EOF}" ;; + esac + + read -r token + json_parse_value "$1" "$key" + obj="$obj$key:$value" + + read -r token + case "$token" in + '}') break ;; + ',') obj="$obj," ;; + *) fail "EXPECTED , or } GOT ${token:-EOF}" ;; + esac + + read -r token + done + ;; + esac + + value=$(printf '{%s}' "$obj") + : +} + +json_parse_value() { + local jpath="${1:+$1,}$2" + + case "$token" in + '{') json_parse_object "$jpath" ;; + '[') json_parse_array "$jpath" ;; + # At this point, the only valid single-character tokens are digits. + '' | [!0-9]) fail "EXPECTED value GOT ${token:-EOF}" ;; + # value with solidus ("\/") replaced in json strings with normalized value: "/" + *) value=$(echo "$token" | sed 's#\\/##g') ;; + esac + + [ "$value" = '' ] && return + printf "[%s]\t%s\n" "$jpath" "$value" + : +} + +json_parse() { + json="$1" + + [ -z "$json" ] && return + + echo "$json" | json_tokenize | ( + read -r token + json_parse_value + read -r token + ) + + case "$token" in + '') ;; + *) fail "EXPECTED EOF GOT $token" ;; + esac +} diff --git a/test/install.bats b/test/install.bats new file mode 100644 index 0000000..beec461 --- /dev/null +++ b/test/install.bats @@ -0,0 +1,7 @@ +#!/usr/bin/env bats + +@test "install command fails if the input is not version number" { + run asdf install zig ref + [ "$status" -eq 1 ] + echo "$output" | grep "supports release installs only" +}