thebushidocollective/han/ameba-integration

# Run Ameba on entire project
ameba
 
# Run on specific files
ameba src/models/user.cr
 
# Run on specific directories
ameba src/services/
 
# Run with specific configuration
ameba --config .ameba.custom.yml
 
# Generate default configuration
ameba --gen-config
 
# Auto-fix correctable issues
ameba --fix
 
# Only check specific rules
ameba --only Style/RedundantReturn
 
# Exclude specific rules
ameba --except Style/LargeNumbers
 
# Format output
ameba --format json
ameba --format junit
ameba --format flycheck
 
# Explain issues at specific location
ameba --explain src/models/user.cr:10:5
 
# Run with all output
ameba --all
 
# Fail silently on no issues
ameba --silent

# Default: Human-readable
ameba
# Output:
# src/user.cr:10:5: Style/RedundantReturn: Redundant return detected
 
# JSON format (for parsing)
ameba --format json
# Output: {"sources": [...], "summary": {...}}
 
# JUnit XML (for CI integration)
ameba --format junit > ameba-results.xml
 
# Flycheck format (for Emacs)
ameba --format flycheck

# Check only changed files (git)
git diff --name-only --diff-filter=ACM | grep '\.cr$' | xargs ameba
 
# Check only staged files
git diff --cached --name-only --diff-filter=ACM | grep '\.cr$' | xargs ameba
 
# Run with parallel processing (if available)
ameba --parallel
 
# Set exit code based on severity
ameba --fail-level error    # Only fail on errors
ameba --fail-level warning  # Fail on warnings and errors
ameba --fail-level convention  # Fail on everything
 
# Generate formatted report
ameba --format json | jq '.summary'

#!/bin/sh
# .git/hooks/pre-commit - Run Ameba on staged Crystal files
 
echo "Running Ameba on staged files..."
 
# Get staged Crystal files
STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '\.cr$')
 
if [ -z "$STAGED_FILES" ]; then
  echo "No Crystal files staged, skipping Ameba"
  exit 0
fi
 
# Run Ameba on staged files
echo "$STAGED_FILES" | xargs ameba
 
# Capture exit code
AMEBA_EXIT=$?
 
if [ $AMEBA_EXIT -ne 0 ]; then
  echo "❌ Ameba found issues. Please fix them before committing."
  echo "Run 'ameba --fix' to auto-correct some issues."
  exit 1
fi
 
echo "✅ Ameba checks passed"
exit 0

chmod +x .git/hooks/pre-commit

#!/bin/sh
# Advanced pre-commit hook with auto-fix option
 
echo "Running Ameba on staged files..."
 
STAGED_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep '\.cr$')
 
if [ -z "$STAGED_FILES" ]; then
  exit 0
fi
 
# Run Ameba
echo "$STAGED_FILES" | xargs ameba
AMEBA_EXIT=$?
 
if [ $AMEBA_EXIT -ne 0 ]; then
  echo ""
  echo "❌ Ameba found issues."
  echo ""
  read -p "Would you like to auto-fix correctable issues? (y/n) " -n 1 -r
  echo
 
  if [[ $REPLY =~ ^[Yy]$ ]]; then
    echo "Running ameba --fix..."
    echo "$STAGED_FILES" | xargs ameba --fix
 
    # Re-add fixed files
    echo "$STAGED_FILES" | xargs git add
 
    echo "✅ Auto-fixed issues and re-staged files"
    echo "⚠️  Please review the changes before committing again"
    exit 1  # Exit to allow review
  else
    echo "Please fix issues manually before committing"
    exit 1
  fi
fi
 
echo "✅ Ameba checks passed"
exit 0

# .pre-commit-config.yaml
repos:
  - repo: local
    hooks:
      - id: ameba
        name: Ameba (Crystal Linter)
        entry: ameba
        language: system
        files: \.cr$
        pass_filenames: true
 
  - repo: local
    hooks:
      - id: crystal-format
        name: Crystal Format
        entry: crystal tool format
        language: system
        files: \.cr$
        pass_filenames: true

# Install pre-commit
pip install pre-commit  # or brew install pre-commit
 
# Install hooks
pre-commit install
 
# Run manually
pre-commit run --all-files
 
# Run on specific files
pre-commit run --files src/user.cr

# .pre-commit-config.yaml with options
repos:
  - repo: local
    hooks:
      - id: ameba
        name: Ameba
        entry: ameba
        language: system
        files: \.cr$
        pass_filenames: true
 
      - id: ameba-strict
        name: Ameba (Strict)
        entry: ameba --fail-level convention
        language: system
        files: ^src/.*\.cr$  # Only src directory
        pass_filenames: true
 
      - id: ameba-autofix
        name: Ameba Auto-fix
        entry: ameba --fix
        language: system
        files: \.cr$
        pass_filenames: true

name: Ameba
user-invocable: false
 
on:
  push:
    branches: [ main, develop ]
  pull_request:
    branches: [ main, develop ]
 
jobs:
  lint:
    runs-on: ubuntu-latest
 
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
 
      - name: Install Crystal
        uses: crystal-lang/install-crystal@v1
        with:
          crystal: latest
 
      - name: Install dependencies
        run: shards install
 
      - name: Run Ameba
        uses: crystal-ameba/github-action@v0.12.0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

name: Code Quality
user-invocable: false
 
on:
  push:
    branches: [ main ]
  pull_request:
    types: [ opened, synchronize, reopened ]
 
jobs:
  ameba:
    name: Ameba Linting
    runs-on: ubuntu-latest
 
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0  # Full history for better analysis
 
      - name: Install Crystal
        uses: crystal-lang/install-crystal@v1
        with:
          crystal: 1.11.0  # Pin version for consistency
 
      - name: Cache shards
        uses: actions/cache@v3
        with:
          path: lib
          key: ${{ runner.os }}-shards-${{ hashFiles('shard.lock') }}
          restore-keys: |
            ${{ runner.os }}-shards-
 
      - name: Install dependencies
        run: shards install
 
      - name: Run Ameba
        uses: crystal-ameba/github-action@v0.12.0
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
      - name: Upload Ameba results
        if: always()
        uses: actions/upload-artifact@v3
        with:
          name: ameba-results
          path: ameba-results.json

name: Quality Across Versions
user-invocable: false
 
on: [push, pull_request]
 
jobs:
  ameba:
    strategy:
      matrix:
        crystal: [1.10.0, 1.11.0, latest]
        os: [ubuntu-latest, macos-latest]
 
    runs-on: ${{ matrix.os }}
 
    steps:
      - uses: actions/checkout@v4
 
      - name: Install Crystal ${{ matrix.crystal }}
        uses: crystal-lang/install-crystal@v1
        with:
          crystal: ${{ matrix.crystal }}
 
      - name: Install dependencies
        run: shards install
 
      - name: Run Ameba
        run: |
          crystal run bin/ameba.cr -- --format json > ameba-results.json
 
      - name: Check results
        run: |
          if [ $(jq '.summary.issues_count' ameba-results.json) -gt 0 ]; then
            echo "❌ Found issues"
            jq '.summary' ameba-results.json
            exit 1
          fi

name: PR Code Review
user-invocable: false
 
on:
  pull_request:
    types: [ opened, synchronize ]
 
jobs:
  review:
    runs-on: ubuntu-latest
 
    permissions:
      contents: read
      pull-requests: write
 
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
 
      - name: Install Crystal
        uses: crystal-lang/install-crystal@v1
 
      - name: Install dependencies
        run: shards install
 
      - name: Get changed files
        id: changed-files
        uses: tj-actions/changed-files@v40
        with:
          files: |
            **/*.cr
 
      - name: Run Ameba on changed files
        if: steps.changed-files.outputs.any_changed == 'true'
        run: |
          echo "${{ steps.changed-files.outputs.all_changed_files }}" | \
            xargs ameba --format json > ameba-results.json
 
      - name: Comment PR
        if: steps.changed-files.outputs.any_changed == 'true'
        uses: actions/github-script@v7
        with:
          script: |
            const fs = require('fs');
            const results = JSON.parse(fs.readFileSync('ameba-results.json', 'utf8'));
 
            if (results.summary.issues_count > 0) {
              const body = `## Ameba Report
 
              Found ${results.summary.issues_count} issue(s):
 
              ${results.sources.flatMap(s =>
                s.issues.map(i =>
                  \`- \${s.path}:\${i.location.line}:\${i.location.column} - \${i.rule.name}: \${i.message}\`
                )
              ).join('\\n')}`;
 
              await github.rest.issues.createComment({
                owner: context.repo.owner,
                repo: context.repo.repo,
                issue_number: context.issue.number,
                body: body
              });
            }

# .gitlab-ci.yml
stages:
  - quality
  - test
  - build
 
ameba:
  stage: quality
  image: crystallang/crystal:latest
 
  before_script:
    - shards install
 
  script:
    - crystal run bin/ameba.cr -- --format junit > ameba-results.xml
 
  artifacts:
    reports:
      junit: ameba-results.xml
    paths:
      - ameba-results.xml
    when: always
    expire_in: 1 week
 
  rules:
    - if: '$CI_PIPELINE_SOURCE == "merge_request_event"'
    - if: '$CI_COMMIT_BRANCH == "main"'
 
ameba-strict:
  extends: ameba
  script:
    - crystal run bin/ameba.cr -- --fail-level convention
  only:
    - main

# .circleci/config.yml
version: 2.1
 
orbs:
  crystal: manastech/crystal@1.0
 
jobs:
  ameba:
    executor:
      name: crystal/default
      tag: "1.11"
 
    steps:
      - checkout
 
      - restore_cache:
          keys:
            - shards-v1-{{ checksum "shard.lock" }}
            - shards-v1-
 
      - run:
          name: Install dependencies
          command: shards install
 
      - save_cache:
          key: shards-v1-{{ checksum "shard.lock" }}
          paths:
            - lib
 
      - run:
          name: Run Ameba
          command: |
            crystal run bin/ameba.cr -- --format junit > ameba-results.xml
 
      - store_test_results:
          path: ameba-results.xml
 
      - store_artifacts:
          path: ameba-results.xml
 
workflows:
  version: 2
  quality:
    jobs:
      - ameba

// Jenkinsfile
pipeline {
    agent {
        docker {
            image 'crystallang/crystal:latest'
        }
    }
 
    stages {
        stage('Setup') {
            steps {
                sh 'shards install'
            }
        }