Adopt-Ruff

Adopt Ruff⚡ in your repo faster 😎

A tool for finding Ruff rules that are not yet configured, and can be added to your repository easily:

• Rules your code already follows 👏
• Rules that can be automatically fixed by Ruff 🪄
• Rules violated in the repository, sorted by ascending violation count 🔎

The output is a markdown report, easy to check as a Github action summary and CSV files with relevant Rule information per category.

See example at the bottom of this page

Configurations

To decide whether to consider a rule, adopt-ruff uses arguments. See below on how to configure them.

• Ruff considers some new or experimental rules in preview. These should be used with caution. You can choose whether adopt-ruff considers them or not. Read more about Ruff's preview here.
• Ruff supports many autofixable rules - some are always autofixable, and some can only be autofixed by Ruff in specific cases. It's up to you whether to consider "sometimes-autofixable" as autofixable.

Usage

As a Github action (recommended)

Create a yaml file under .github/workspaces in your repo, with the following content:

name: Adopt Ruff
on: workflow_dispatch

jobs:
  adopt-ruff:
    runs-on: ubuntu-latest
    steps:
      - name: Check out repository code
        uses: actions/checkout@v4
      
      - name: Set up python
        id: setup-python
        uses: actions/setup-python@v5
        with: 
          python-version: 3.x
  
      - name: Install ruff 
        run: pip install ruff

      - name: Run the adopt-ruff action
        uses: ScDor/adopt-ruff@master
         

Now, manually trigger the workflow from the Actions panel of your repository.
Learn more about manually triggering a workflow here.

When the action is done running, head to the job summary to watch the report.

The output tables are also availalbe as CSV files, under Artifacts.

Re-run this action to get insights about applicable rules when Ruff updates with more exciting rules ⚡

Notes:

• This flow always installs Ruff's latest version. If your project already has Ruff as a dependency (i.e. in pyproject.toml or requirements.txt), replace the Install ruff step with an appropriate command.

• adopt-ruff calls Ruff, assuming it's installed in the environment. adopt-ruff will fail if ruff is not found.

Arguments

To pass arguments different than the default, use the with key. The values mentioned below are the default. Omit any argument to use the default.

      - name: Run the adopt-ruff action
        uses: ScDor/adopt-ruff@master
        with:
            path: "."
            repo-name: "" # won't show in report if blank
            config-file-path: "" # will be searched in `path` if empty
            include-preview: True
            include-sometimes-fixable: False

Locally

Install by running pip install git+https://github.com/ScDor/adopt-ruff.
Run adopt-ruff --help for more information.\

Arguments

• --path: directory adopt-ruff will search for ruff violations.
• --ruff-conf-path: Path to the pyproject.toml ,ruff.toml or .ruff.toml. When not provided, adopt-ruff will attempt to seach one of those under path.
• --sometimes-fixable: whether to consider sometimes-fixable rules as fixable.
• --preview/--no-preview: whether to include preview rules.
• --repo-name: Will be shown in the output. When not provided, won't be shown.

Report Example

adopt-ruff report for ScDor/my-dummy-repo (ruff 0.1.13)

Respected Ruff rules

374 Ruff rules are already respected in the repo - they can be added right away 🚀

Autofixable Ruff rules

65 Ruff rules are violated in the repo, but can be auto-fixed 🪄

Applicable Rules

194 other Ruff rules are not yet configured in the repository