BMAG v2.0.0: Rewrite

.dev/bootstrap.sh

@@ -0,0 +1,100 @@
+#!/bin/sh
+
+# Ensure the `install_hooks` subshell return codes cascade upwards
+set -e
+
+# If no arguments provided with script call...
+if 
+    [ $# -eq 0 ]
+then
+    # ...then current directory is target directory...
+    DIR="$(pwd)/.dev"
+else
+    # ...else set argument as target directory and cd into it.
+    DIR="$(cd "$(dirname $0)" && pwd)"
+fi
+cd "$DIR/.." || exit 1
+DIR="$(pwd)"
+
+# Default info logging function
+log() {
+    printf "[\x1b[0;1;34m*\x1b[0m] %s: \x1b[0;34m%s\x1b[0m\n" "$(basename $0)" "$*"
+}
+
+# Default error logging function
+e_log() {
+    printf "[\x1b[0;1;31m!\x1b[0m] %s: \x1b[0;1;31m%s\x1b[0m\n" "$(basename $0)" "$*"
+}
+
+# Default success logging function
+s_log() {
+    printf "[\x1b[0;1;32m+\x1b[0m] %s: \x1b[0;1;32m%s\x1b[0m\n" "$(basename $0)" "$*"
+}
+
+setup_git() {
+    # Set up `Signed-off-by` git trailer
+    git config set trailer.sign.key "Signed-off-by: "
+    git config set trailer.sign.ifmissing add
+    git config set trailer.sign.ifexists doNothing
+    git config set trailer.sign.cmd 'echo "$(git config user.name) <$(git config user.email)>"'
+
+    # Set up default commit template
+    git config set commit.template "$DIR/.dev/commit-template"
+}
+
+# Installs the git hooks via checking for differences between `./dev/hooks` and `./.git/hooks`
+# If there are differences, the script nukes pre-existing hooks and inserts its own custom ones
+install_hooks() (
+    hook_src_dir="$DIR/.dev/hooks"
+    hook_dest_dir="$DIR/.git/hooks"
+
+    # If the source dir doesn't exist, the repo is missing stuff
+    if
+        ! test -d "$hook_src_dir"
+    then
+        e_log "Git hook source directory not found; re-clone this repo!"
+        return 1
+    fi
+
+    if 
+        [ $# -eq 0 ]
+    then
+        git diff --quiet "$hook_src_dir" "$hook_dest_dir" 2> /dev/null || {
+            log 'Configuring git hooks...'
+
+            # World's longest `printf` call I swear
+            printf \
+            "[\x1b[0;1;34m*\x1b[0m] %s: \x1b[0;34m%s\n\tfrom \x1b[0m\`%s\`\n\t\x1b[0;34minto \x1b[0m\`%s\`\x1b[0;34m...\x1b[0m\n" \
+            "$(basename $0)" \
+            "Installing git hooks for repository" \
+            "$hook_src_dir" \
+            "$hook_dest_dir"
+
+            rm -rf "$hook_dest_dir"
+            cp -r "$hook_src_dir" "$hook_dest_dir"
+
+            s_log 'Git hooks configured successfully!'
+        }
+    else
+        # Check for differences between the directories; copy repo files if discrepancies exist
+        git diff --quiet "$1" "$2" "$hook_src_dir" 2> /dev/null || {
+            log 'Configuring git hooks...'
+
+            # World's longest `printf` call I swear
+            printf \
+            "[\x1b[0;1;34m*\x1b[0m] %s: \x1b[0;34m%s\n\tfrom \x1b[0m\`%s\`\n\t\x1b[0;34minto \x1b[0m\`%s\`\x1b[0;34m...\x1b[0m\n" \
+            "$(basename $0)" \
+            "Installing git hooks for repository" \
+            "$hook_src_dir" \
+            "$hook_dest_dir"
+
+            rm -rf "$hook_dest_dir"
+            cp -r "$hook_src_dir" "$hook_dest_dir"
+
+            s_log 'Git hooks configured successfully!'
+        }
+    fi
+)
+
+setup_git "$@"
+install_hooks "$@"

.dev/commit-template

@@ -0,0 +1,13 @@
+<type>(scope): <description>
+
+# See Conventional Commits for more info on commit header formatting
+# https://www.conventionalcommits.org/
+
+create:
++ `./foo`: add a file that does something
+
+modify:
+* `./bar`: change the contents of the file
+
+delete:
+- `./baz`: remove the file

.dev/hooks/commit-msg

@@ -0,0 +1,9 @@
+#!/bin/sh
+# This script adds a `Signed-off-by` trailer to the end of the proposed commit message.
+git interpret-trailers --trailer sign --in-place "$1"
+
+test "" = "$(grep '^Signed-off-by: ' "$1" |
+	 sort | uniq -c | sed -e '/^[ 	]*1[ 	]/d')" || {
+	echo >&2 Duplicate Signed-off-by lines.
+	exit 1
+}

.dev/hooks/post-checkout

@@ -0,0 +1,3 @@
+#!/bin/sh
+# This script sets up the `Signed-off-by` git trailer and runs `../contributor.sh`
+$(git rev-parse --show-toplevel)/.dev/bootstrap.sh $@

.dev/release.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+rm -rf ./.releases
+mkdir .releases
+
+bmag_release_tag=$(git tag --points-at HEAD | tail -n 1)
+if [ -n "$release_tag" ]; then
+    exit 1
+fi
+bmag_prefix="bmag_${bmag_release_tag}"
+bmag_tar_name="${bmag_prefix}.tar.gz"
+bmag_zip_name="${bmag_prefix}.zip"
+
+cd ./.releases || exit
+tar -cvf "$bmag_tar_name" ../localization ../src ../bmag.json ../LICENSE ../README.md
+zip -r "$bmag_zip_name" ../localization ../src ../bmag.json ../LICENSE ../README.md

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,37 @@
+---
+name: Bug report
+about: Create a report regarding erroneous behaviour.
+title: "[BUG] "
+labels: bug
+assignees: uptudev
+
+---
+
+## Description
+
+A clear and concise description of what the bug is.
+
+## Procedure
+
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+## Screenshots
+
+If applicable, add screenshots to help explain your problem.
+
+## Platform
+
+ - OS: [e.g. iOS]
+ - Version [e.g. 22]
+ - Hardware: [e.g. Intel i7 4770k, 16GB DDR3, GTX 780Ti]
+
+## Context/Misc Info
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/code-of-conduct-violation.md

@@ -0,0 +1,26 @@
+---
+name: Code of Conduct violation
+about: Report a violation of our community Code of Conduct
+title: "[COC] "
+labels: coc_violation
+assignees: ''
+
+---
+
+## Description
+
+**Link to the violating communication and summarize it.**
+Include the following:
+- who sent the offending communication,
+- how the communication was sent (Discord, IRC, etc.),
+- when the communication was sent, and
+- what the communication said
+
+## Violated clause
+
+**Refer to the clause in `CODE_OF_CONDUCT.md` which the above violates.**
+If `CODE_OF_CONDUCT.md` is missing, refer to [the Contributor Covenant v2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).
+
+## Screenshots
+
+Where possible, add screenshots for documentation.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,23 @@
+---
+name: Feature request
+about: Suggest an idea for an unimplemented feature.
+title: "[REQUEST] "
+labels: enhancement
+assignees: uptudev
+
+---
+
+## Overview
+
+**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 [...]. If problem has to do with unexpected behaviour, open a bug report instead.
+
+## Suggestion
+**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.
+
+## Context/Misc Info
+Add any other context or screenshots about the feature request here.

.github/pull_request_template.md

@@ -0,0 +1,9 @@
+## Describe your changes
+
+## Issue ticket number and link (if applicable)
+
+## Checklist before requesting a review
+- [ ] I have performed a self-review of my code.
+- [ ] If it is a core feature, I have added thorough tests.
+- [ ] Will this be part of a product update? If yes, please write one phrase
+about this update below.

.gitignore

@@ -0,0 +1,3 @@
+# holds the balatro source code for reverse engineering
+exe_dump/
+.releases/