initial commit

Author: tatanus

.github/CODEOWNERS

@@ -0,0 +1,7 @@
+##########################################
+#             code ownership
+##########################################
+
+# default ownership:
+* @tatanus
+

.github/FUNDING.yml

@@ -0,0 +1,16 @@
+# These are supported funding model platforms
+
+github: [tatanus] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
+polar: # Replace with a single Polar username
+buy_me_a_coffee: # Replace with a single Buy Me a Coffee username
+thanks_dev: # Replace with a single thanks.dev username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: tatanus
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Download '...'
+2. Run '....'
+3. Select '....'
+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.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. Ubuntu MacOS]
+ - Bash Version [e.g. 5.0]
+
+**Additional context**
+Add any other context about the problem here.
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: tatanus
+
+---
+
+**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,77 @@
+# Pull Request Template for the Bash_setup Project
+
+## Description
+
+Please provide a summary of the changes made, including:
+- The issue(s) fixed or the enhancement(s) added.
+- Relevant motivation and context for the change.
+- Any dependencies required for this update.
+
+---
+
+## Type of Change
+
+Please select the type of change by marking the relevant option(s) with `[x]`:
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] Documentation update (adds or modifies documentation)
+- [ ] Third-party dependency update (e.g., new tools, libraries, or resources)
+
+---
+
+## How Has This Been Tested?
+
+Describe the tests you ran to verify your changes, including:
+1. Commands executed to validate the script's behavior.
+2. Environment details:
+   - Operating System and version (e.g., Ubuntu 20.04, macOS Ventura).
+   - Bash version (`bash --version`).
+   - Any relevant configurations or dependencies used for testing.
+3. Test results:
+   - Example input and output for the changes.
+
+**Testing Checklist:**
+- [ ] Local testing with various edge cases and normal inputs.
+- [ ] Verified compatibility with related scripts/modules.
+- [ ] Reviewed logging outputs (if applicable).
+
+---
+
+## Screenshots (If Applicable)
+
+If the changes involve user-facing functionality or outputs, please include **before and after screenshots** to help reviewers understand the impact of the change.
+
+---
+
+## Checklist
+
+Please complete the checklist below to ensure your PR meets the project standards:
+
+- [ ] I have run `shellcheck` using the repository's `.shellcheckrc` file to verify linting:
+  ```bash
+  shellcheck --shell=bash --external-sources -x -S style -f gcc <your-script.sh>
+  ```
+- [ ] I have formatted all scripts using `shfmt`:
+  ```bash
+  shfmt -i 4 -ci -bn -kp -sr -ln bash -d .
+  ```
+- [ ] I have verified that my changes are consistent with the project's [Style Guide](./STYLEGUIDE.md).
+- [ ] I have updated or added relevant tests (e.g., unit tests, test scripts).
+- [ ] All existing tests pass successfully after my changes.
+- [ ] I have added or updated documentation as needed, and linked any relevant PRs in related repositories (e.g., documentation or tools).
+- [ ] I have reviewed my own code for clarity and correctness.
+- [ ] I have commented on particularly complex or non-obvious parts of the code.
+
+---
+
+## Additional Notes
+
+If your changes rely on external tools or third-party dependencies, please include details about:
+1. Why the tool/dependency is required.
+2. Links to relevant documentation or PRs in those third-party projects.
+
+---
+
+This PR template is designed to ensure contributions to the **bash_setup** project are clear, well-tested, and maintainable. Thank you for your contribution!
+

.github/workflows/main.yml

@@ -0,0 +1,115 @@
+name: Bash Project CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  lint:
+    name: Lint Bash Scripts with ShellCheck
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout code
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      # Install ShellCheck
+      - name: Install ShellCheck
+        run: |
+          sudo apt update
+          sudo apt install -y shellcheck
+
+      # Run ShellCheck on all scripts
+      - name: Run ShellCheck
+        run: |
+          set -eo pipefail
+          find . -name "*.sh" ! -path "./.git/*" -print0 | xargs -0 shellcheck --shell=bash --external-sources -x \
+          --severity=style \
+          --exclude=SC1090,SC1091,SC2034,SC2181
+
+  format:
+    name: Check Formatting with shfmt
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout code
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      # Install shfmt
+      - name: Install shfmt
+        run: |
+          sudo apt update
+          sudo apt install -y shfmt
+
+      # Run shfmt to check formatting
+      - name: Run shfmt
+        run: |
+          find . -type f -name "*.sh" -print0 | xargs -0 shfmt -i 4 -ci -bn -sr -kp -ln bash -d
+
+          # Explanation of flags:
+          # ---------------------
+          # -i 4       # Indent with 4 spaces (default is 2). Ensures consistent indentation style.
+          # -ci        # Indent `case` blocks (useful for readability within `case` statements).
+          # -bn        # Keep `do`, `then`, and similar keywords on the same line as the preceding command.
+          #            # Example: `if true; then` instead of splitting to `if true; \n then`.
+          # -kp        # Preserve padding in alignment for tables or comments (helps keep things visually aligned).
+          #            # Example:
+          #            # VAR1="value1"  # aligned comment
+          #            # VAR2="value2"
+          # -ln bash   # Specify the shell dialect as `bash` (default is `posix` for maximum portability).
+          #            # Ensures proper parsing for Bash-specific features.
+          # -d         # Diff mode: Show differences between the current script formatting and the `shfmt` output.
+          #            # This is useful in CI pipelines or for dry runs to check formatting issues without modifying files.
+
+          # Notes:
+          # - Remove the `-d` flag if you want shfmt to automatically apply formatting instead of displaying diffs.
+
+  validate_permissions:
+    name: Validate File Permissions and Shebangs
+    runs-on: ubuntu-latest
+
+    steps:
+      # Checkout code
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      # Ensure all shell scripts are executable
+      - name: Ensure Executable Permissions
+        run: |
+          find . -name "*.sh" -exec chmod +x {} \;
+
+      # Validate all scripts have a shebang
+      - name: Validate Shebangs
+        run: |
+          missing_shebangs=$(find . -name "*.sh" ! -path "./lib/common_core/*" ! -path "./dotfiles/bash-preexec.sh" ! -path "./another/ignored-file.sh" -exec sh -c 'head -n 1 "$1" | grep -q "^#!" || echo "Missing shebang: $1"' _ {} \;)
+          if [[ -n "$missing_shebangs" ]]; then
+            echo "The following files are missing a shebang:"
+            echo "$missing_shebangs"
+            exit 1
+          fi
+
+  # run_bats_unit_tests:
+  #   name: Run BATS Unit Tests
+  #   runs-on: ubuntu-latest
+
+  #   steps:
+  #   - name: Checkout Repository
+  #     uses: actions/checkout@v3
+
+  #   # Install BATS if not included as a submodule
+  #   - name: Install BATS
+  #     run: |
+  #       sudo apt-get update
+  #       sudo apt-get install -y bats
+
+  #   # Run the BATS Tests
+  #   - name: Run BATS Tests
+  #     run: |
+  #       bats tests/unit
+