Merge pull request #231 from crytic/feature/code-quality-phase1

feat: implement code quality improvements

Author: elopez

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,48 +1,48 @@
---- 
-body: 
-  - 
-    attributes: 
+---
+body:
+  -
+    attributes:
       value: |
           Please check the issues tab to avoid duplicates.
           Thanks for taking the time to fill out this bug report!
     type: markdown
-  - 
-    attributes: 
+  -
+    attributes:
       label: "Describe the issue:"
     id: what-happened
     type: textarea
-    validations: 
+    validations:
       required: true
-  - 
-    attributes: 
+  -
+    attributes:
       description: "It can be a github repo, etherscan link, or code snippet."
       label: "Code example to reproduce the issue:"
       placeholder: "`contract A {}`\n"
     id: reproduce
     type: textarea
-    validations: 
+    validations:
       required: true
-  - 
-    attributes: 
+  -
+    attributes:
       description: |
-          What version of solc-select are you running? 
+          What version of solc-select are you running?
           Run `solc-select--version`
       label: "Version:"
     id: version
     type: textarea
-    validations: 
+    validations:
       required: true
-  - 
-    attributes: 
+  -
+    attributes:
       description: |
-          Please copy and paste any relevant log output. This 
+          Please copy and paste any relevant log output. This
           will be automatically formatted into code, so no need for backticks.
       render: shell
       label: "Relevant log output:"
     id: logs
     type: textarea
 description: "File a bug report"
-labels: 
+labels:
   - bug-candidate
 name: "Bug Report"
 title: "[Bug-Candidate]: "

.github/dependabot.yml

@@ -5,3 +5,12 @@ updates:
     directory: /
     schedule:
       interval: daily
+
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+    reviewers:
+      - "elopez"
+      - "montyly"

.github/workflows/ci.yml

@@ -14,35 +14,25 @@ concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
   cancel-in-progress: true
 
+permissions:
+  contents: read
+
 jobs:
   tests:
-    name: CI (Python ${{ matrix.python }} on ${{ matrix.os }}, ${{ matrix.type }} test)
+    name: CI (Python ${{ matrix.python }} on ${{ matrix.os }})
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
         python: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
         os: ["ubuntu-latest", "macos-latest", "windows-2022"]
-        type: ["solc", "solc_upgrade", "os_specific"]
     steps:
     - uses: actions/checkout@v5
-    - uses: actions/setup-python@v6
-      id: python
+    - uses: astral-sh/setup-uv@v4
       with:
         python-version: ${{ matrix.python }}
-    - name: Create Python virtual environment
-      run: |
-        ${{ steps.python.outputs.python-path }} -m venv test-venv
-    - name: Install solc-select
-      shell: bash
+    - name: Install solc-select and test dependencies
       run: |
-        source test-venv/${{ (runner.os == 'Windows' && 'Scripts') || 'bin' }}/activate
-        python -m pip install --upgrade pip
-        pip3 install .
+        uv sync --extra dev
     - name: Run Tests
-      shell: bash
-      env:
-        TEST_TYPE: ${{ (matrix.type != 'os_specific' && matrix.type) || runner.os }}
       run: |
-        source test-venv/${{ (runner.os == 'Windows' && 'Scripts') || 'bin' }}/activate
-        TEST_TYPE="$(echo "$TEST_TYPE" | tr '[:upper:]' '[:lower:]')"
-        bash scripts/test_${TEST_TYPE}.sh
+        uv run python -m pytest tests/ -v --tb=short -n auto

.github/workflows/lint.yml

@@ -1,11 +1,6 @@
 ---
 name: Lint Code Base
 
-defaults:
-  run:
-    # To load bashrc
-    shell: bash -ieo pipefail {0}
-
 on:
   pull_request:
     branches: [master, dev]
@@ -19,78 +14,22 @@ concurrency:
 
 permissions:
   contents: read
-  packages: read
-  # To report GitHub Actions status checks
-  statuses: write
 
 jobs:
-  pylint:
-    name: Lint Code Base (pylint)
+  lint:
+    name: Lint Code Base
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout Code
-        uses: actions/checkout@v5
-        with:
-          # super-linter needs the full git history to get the
-          # list of files that changed across commits
-          fetch-depth: 0
-
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v6
-        with:
-          python-version: 3.8
-
-      - name: Install dependencies
-        run: |
-          mkdir -p .github/linters
-          cp pyproject.toml .github/linters
-
-      - name: Pylint
-        uses: super-linter/super-linter/[email protected]
-        if: always()
-        env:
-          # run linter on everything to catch preexisting problems
-          VALIDATE_ALL_CODEBASE: true
-          DEFAULT_BRANCH: master
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # Run only pylint
-          VALIDATE_PYTHON: true
-          VALIDATE_PYTHON_PYLINT: true
-          PYTHON_PYLINT_CONFIG_FILE: pyproject.toml
-          FILTER_REGEX_EXCLUDE: .*tests/.*.(json|zip|sol)
+      - uses: actions/checkout@v5
 
-  black:
-    name: Lint Code Base (black)
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v5
-        with:
-          # super-linter needs the full git history to get the
-          # list of files that changed across commits
-          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v4
 
-      - name: Set up Python 3.8
-        uses: actions/setup-python@v6
-        with:
-          python-version: 3.8
+      - name: Install solc-select and test dependencies
+        run: uv sync --extra dev
 
-      - name: Install dependencies
-        run: |
-          mkdir -p .github/linters
-          cp pyproject.toml .github/linters
+      - name: Run ruff check
+        run: uv run ruff check .
 
-      - name: Black
-        uses: super-linter/super-linter/[email protected]
-        if: always()
-        env:
-          # run linter on everything to catch preexisting problems
-          VALIDATE_ALL_CODEBASE: true
-          DEFAULT_BRANCH: master
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          # Run only black
-          VALIDATE_PYTHON_BLACK: true
-          PYTHON_BLACK_CONFIG_FILE: pyproject.toml
-          FILTER_REGEX_EXCLUDE: .*tests/.*.(json|zip|sol)
+      - name: Run ruff format check
+        run: uv run ruff format --check .

.github/workflows/pip-audit.yml

@@ -33,9 +33,7 @@ jobs:
           python -m pip install --upgrade pip setuptools wheel
           python -m pip install .
 
-
       - name: Run pip-audit
         uses: pypa/[email protected]
         with:
           virtual-environment: /tmp/pip-audit-env
-

.github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Build distributions
         run: |
           python -m pip install --upgrade pip
-          python -m pip install build
+          python -m pip install --upgrade build
           python -m build
 
       - name: Upload distributions

.gitignore

@@ -8,4 +8,4 @@ global-version
 build/
 dist/
 *.egg
-*.egg-info/
+*.egg-info/

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+# Pre-commit hooks for code quality
+# See https://pre-commit.com for more information
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version - using latest stable
+    rev: v0.12.10
+    hooks:
+      # Run the linter
+      - id: ruff
+        args: ["--fix"]
+      # Run the formatter
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+        args: ["--maxkb=1000"]
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: debug-statements

CONTRIBUTING.md

@@ -1,15 +1,15 @@
-# Contribuing to solc-select 
+# Contributing to solc-select
 
-Hi! Welcome to solc-select. 
+Hi! Welcome to solc-select.
 
-## Bug Reports and Feature Suggestions 
+## Bug Reports and Feature Suggestions
 
 Bug reports and feature suggestions can be submitted to our issue tracker. For bug reports, attaching the contract that caused the bug will help us in debugging and resolving the issue quickly. If you find a security vulnerability, do not open an issue; email [email protected] instead.
 
 ## Questions
 Questions can be submitted to the issue tracker, but you may get a faster response if you ask in our [chat room](https://slack.empirehacking.nyc/) (in the #ethereum channel).
 
-## Code 
+## Code
 solc-select uses the pull request contribution model. Please make an account on Github, fork this repo, and submit code contributions via pull request. For more documentation, look [here](https://guides.github.com/activities/forking/).
 
 Some pull request guidelines:
@@ -20,31 +20,87 @@ Some pull request guidelines:
 - Fill out the pull request description with a summary of what your patch does, key changes that have been made, and any further points of discussion, if applicable.
 - Title your pull request with a brief description of what it's changing. "Fixes #123" is a good comment to add to the description, but makes for an unclear title on its own.
 
-## Linters
+## Development Setup
 
-Several linters and security checkers are run on the PRs.
+### Setting up the Development Environment
 
-To run them locally in the root dir of the repository:
+#### Using uv (recommended - fastest)
 
-- `pylint solc_select --rcfile pyproject.toml`
-- `black . --config pyproject.toml`
-
-We use pylint `2.8.2` black `20.8b1`.
-
-## Running Tests
-
-These tests can be run locally by using the  `bash test_{linux | macos | windows}.sh` respective scripts. 
+```bash
+git clone https://github.com/crytic/solc-select.git
+cd solc-select
+uv venv
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install -e ".[dev]"
+pre-commit install  # Set up automatic linting on commit
+```
 
-These will also run in a github workflow on each platform.
+#### Using pip
 
-## Developer Environment
+```bash
+git clone https://github.com/crytic/solc-select.git
+cd solc-select
+python3 -m venv venv
+source venv/bin/activate  # On Windows: venv\Scripts\activate
+pip install -e ".[dev]"
+pre-commit install  # Set up automatic linting on commit
+```
 
-Run `make dev` to create your own development environment. 
+#### Using make
 
 ```bash
 git clone https://github.com/crytic/solc-select.git
 cd solc-select
 make dev
 ```
 
-Update `solc-select` by running `git pull` from the `solc-select/` directory.
+### Code Quality
+
+We use automated tools to maintain code quality. Several linters and security checkers are run on all PRs.
+
+To run them locally:
+
+```bash
+# Code formatting and linting
+ruff check .           # Check for linting issues
+ruff format --check .  # Check formatting
+ruff format .          # Auto-format code
+
+# Type checking (optional but recommended)
+pip install pylint
+pylint solc_select --rcfile pyproject.toml
+```
+
+## Running Tests
+
+Tests use pytest and can be run locally:
+
+```bash
+# Install development dependencies (includes pytest)
+pip install -e ".[dev]"
+
+# Run all tests
+pytest tests/
+
+# Run specific test file
+pytest tests/test_compiler_versions.py
+
+# Run tests with verbose output
+pytest tests/ -v
+
+# Skip slow tests (upgrade test) and platform boundary tests
+pytest tests/ -k "not version_boundaries" -m "not slow"
+
+# Tests also run automatically in GitHub Actions on all platforms
+```
+
+## Updating Your Fork
+
+To keep your fork up to date with the latest changes:
+
+```bash
+git remote add upstream https://github.com/crytic/solc-select.git
+git fetch upstream
+git checkout dev
+git merge upstream/dev
+```