Migration from pre-commit

RustyHook is designed to be a drop-in replacement for pre-commit, making migration as seamless as possible. This guide will help you transition from pre-commit to RustyHook.

Compatibility Mode

The easiest way to start using RustyHook is with compatibility mode, which allows RustyHook to use your existing .pre-commit-config.yaml file without any changes:

# Run hooks using your existing pre-commit configuration
rh compat

This command will:

Read your .pre-commit-config.yaml file
Set up the necessary environments
Run the hooks as defined in your pre-commit configuration

Converting Your Configuration

While compatibility mode works well, you'll get the best performance and features by converting to RustyHook's native configuration format:

# Convert pre-commit config to RustyHook config
rh convert --from-precommit > .rustyhook/config.yaml

This will create a new .rustyhook/config.yaml file based on your existing pre-commit configuration.

Configuration Differences

Here's how pre-commit and RustyHook configurations compare:

pre-commit Configuration

# .pre-commit-config.yaml
repos:
  - repo: https://github.com/charliermarsh/ruff-pre-commit
    rev: 'v0.0.262'
    hooks:
      - id: ruff
        args: [--fix]

  - repo: https://github.com/pre-commit/mirrors-eslint
    rev: v8.38.0
    hooks:
      - id: eslint
        files: \.(js|jsx|ts|tsx)$
        types: [file]
        additional_dependencies:
          - eslint@8.38.0
          - eslint-config-standard@17.0.0

Equivalent RustyHook Configuration

# .rustyhook/config.yaml
hooks:
  - id: ruff
    language: python
    version: "==0.0.262"
    entry: "ruff"
    args: ["--fix"]
    files: "\\.py$"

  - id: eslint
    language: node
    version: "^8.38.0"
    entry: "eslint"
    files: "\\.(js|jsx|ts|tsx)$"
    args: []
    dependencies:
      - "eslint-config-standard@17.0.0"

Key Differences

Repository References: RustyHook doesn't use the repos structure. Instead, it directly defines hooks with their language and version.
Version Specification:
- pre-commit uses Git revisions (rev)
- RustyHook uses package version specifiers (version)
Dependencies:
- pre-commit uses additional_dependencies
- RustyHook uses dependencies
Entry Point:
- pre-commit infers the entry point from the hook ID
- RustyHook requires an explicit entry field
File Patterns:
- Both use similar regex patterns, but RustyHook always requires the files field if you want to filter by file type

Migrating Git Hooks

If you've installed pre-commit as a Git hook, you'll need to uninstall it and install RustyHook instead:

# Uninstall pre-commit hooks
pre-commit uninstall

# Install RustyHook hooks
rh install

Handling Custom Hooks

If you have custom hooks defined in your pre-commit configuration, you'll need to adapt them for RustyHook:

pre-commit Custom Hook

repos:
  - repo: local
    hooks:
      - id: custom-script
        name: Custom Script
        entry: ./scripts/custom.sh
        language: script
        files: \.txt$

RustyHook Custom Hook

hooks:
  - id: custom-script
    language: system
    entry: "./scripts/custom.sh"
    files: "\\.txt$"

Missing Dependencies: If your pre-commit hooks had implicit dependencies, you might need to add them explicitly in RustyHook.
Path Differences: RustyHook executes hooks from the Git root by default. Use working_dir if you need to change this.
Hook Execution Order: RustyHook executes hooks in the order they're defined in the configuration file.

Debugging

If you encounter issues during migration, use the --verbose flag to get more information:

rh run --verbose

You can also use the doctor command to diagnose issues:

rh doctor

Next Steps

After migrating to RustyHook, you might want to:

Explore Configuration options to take advantage of RustyHook-specific features
Learn about CLI Usage to optimize your workflow
Set up Shell Completions for a better command-line experience

RustyHook Documentation