breaking change(core): refactor installation scripts to use Makefile 🔧 (#66)

This pull request refactors the project's installation and setup process
by replacing the legacy bootstrap and install scripts with a more
structured
and powerful Makefile. This change simplifies the setup process,
improves maintainability, and adds support for different operating
systems.

- close #51 

### Main Changes:

- Replaced `bootstrap` and `install` scripts: All installation and setup
logic is now centralized in the Makefile.
- Added `.editorconfig`: An .editorconfig file has been added to ensure
consistent coding styles across different editors and IDEs.
- Modular `Makefile`: The Makefile is organized into modular targets,
allowing for the installation and configuration of specific components
like base_packages, git_config, zsh_config, asdf_config, tmux_config,
and nvim.
- Improved OS Detection: The Makefile now automatically detects the
operating system (macOS, Fedora, or Debian/Ubuntu) and uses the
appropriate package manager (brew, dnf, or apt) to install the necessary
dependencies.
- Idempotent Targets: The Makefile targets are designed to be
idempotent, meaning they can be run multiple times without causing
issues. This is achieved by using marker files to track whether a target
has already been executed.

### How to Use:

To set up the development environment, simply run the following command:

```bash
make bootstrap
```

This will install all the necessary packages and configure the dotfiles.
To see all available commands, run make help.

This refactoring makes the dotfiles project more robust, easier to
manage, and more user-friendly for new contributors.

---------

Co-authored-by: Paulo 'Patto' Santos <paulopatto@MacBookPro.bbrouter>

Author: paulopatto

.editorconfig

@@ -11,11 +11,17 @@ charset = utf-8
 end_of_line = lf
 indent_style = space
 indent_size = 2
-insert_final_newline = true
 trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.sh]
+indent_style = space
+indent_size = 2
+
+[Makefile]
+indent_style = tab
 
 # Markdown files
 [*.md]
 trim_trailing_whitespace = false
 
-

.github/workflows/CI.yaml

@@ -0,0 +1,91 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - '**.bash'
+      - '**.sh'
+      - '**.zsh'
+      - 'tests/**'
+      - '.github/workflows/bats.yml'
+      - 'package.json'
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # https://github.com/actions/runner-images?tab=readme-ov-file#available-images
+        os: [ubuntu-latest, macos-latest] #, windows-latest]
+        node-version: [20]
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix['node-version'] }}
+
+
+      # - name: Setup Bats and bats libs
+      #   id: setup-bats
+      #   uses: bats-core/bats-action@3.0.1
+
+      - name: Install bats and helpers
+        run: npm ci
+
+      - name: Run install script (bootstrap)
+        run: make bootstrap
+
+      - name: Add bats to PATH
+        run: echo "$(npm bin)" >> $GITHUB_PATH
+
+      - name: Run bats tests
+        shell: bash
+        env:
+          TERM: xterm # Set TERM to a value that supports colors
+        run: npm test
+
+  test-on-fedora-via-docker:
+    runs-on: ubuntu-latest
+    container:
+      image: fedora:latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Setup build essentials on fedora container
+        run: |
+          dnf install -y nodejs  @c-development @development-tools
+
+      - name: Install bats and helpers
+        run: npm ci
+
+      - name: Run install script (bootstrap)
+        run: make bootstrap
+
+      - name: Add bats to PATH
+        run: echo "$(npm bin)" >> $GITHUB_PATH
+
+      - name: Run bats tests
+        shell: bash
+        env:
+          TERM: xterm # Set TERM to a value that supports colors
+        run: npm test
+
+      # - name: Run tests in Fedora container
+      #   run: |
+      #     docker run --rm -v $PWD:/workspace -w /workspace fedora:latest bash -c "
+      #       dnf install -y nodejs &&
+      #       npm ci &&
+      #       echo "$(npm bin)" >> $GITHUB_PATH &&
+      #       make bootstrap &&
+      #       TERM=xterm npm test
+      #     "

.gitignore

@@ -2,3 +2,6 @@
 tmux/plugins/
 zsh/plugins/
 nvim/lazy-lock.json
+tmux/.config/tmux/plugins/tpm/
+.bootstrap
+node_modules/

.gitmodules

@@ -0,0 +1,4 @@
+--target=~/
+--dotfiles
+--restow
+--verbose

.stowrc

@@ -0,0 +1,49 @@
+# List of packages to manage with GNU Stow
+STOW_PACKAGES := asdf git mcphub nvim tmux vscode zsh
+
+# The stow command defaults to the parent of the current directory,
+# but we explicitly set it to HOME for clarity.
+STOW_TARGET := $(HOME)
+
+# Variaveis
+SHELL := /bin/bash
+XDG_CONFIG_HOME := $(shell echo ~)/.config
+DOTFILES_HOME := $(shell pwd)
+
+.PHONY: all base_packages git_config zsh_config asdf_config tmux_config nvim
+
+.PHONY: all link unlink test
+
+all: bootstrap link
+
+link:
+	@echo "Linking dotfiles to $(STOW_TARGET)..."
+	@stow --restow $(STOW_PACKAGES)
+
+unlink:
+	@echo "Unlinking dotfiles from $(STOW_TARGET)..."
+	@stow --delete $(STOW_PACKAGES)
+
+
+bootstrap:
+	@echo "Verificando a necessidade de bootstrap..."
+	@if [ ! -f .bootstrap ]; then \
+		echo "Executando bootstrap de dependências do sistema..."; \
+		./scripts/bootstrap.sh; \
+		echo "Bootstrap concluído."; \
+		touch .bootstrap; \
+	else \
+		echo "Bootstrap já realizado, arquivo .bootstrap encontrado."; \
+	fi
+# nvim:
+# 	@echo "--> Configuring neovim"
+# 	@if [ ! -L "$(XDG_CONFIG_HOME)/nvim" ]; then \
+# 		echo "Creating symlink for neovim config"; \
+# 		ln -s "$(DOTFILES_DIR)/nvim" "$(XDG_CONFIG_DIR)/nvim"; \
+# 		else \
+# 		echo "neovim config symlink already exists"; \
+# 		fi
+# 	@echo "Installing/updating neovim plugins..."
+# 	# @nvim --headless -c 'autocmd User PackerComplete quitall' -c 'PackerSync'
+# 	@nvim --headless "+Lazy! sync" +qa
+

Makefile

@@ -2,3 +2,4 @@ ruby 3.4.5
 lua 5.4.7
 python 3.13.2
 nodejs 23.7.0
+java temurin-21.0.6+7.0.LTS