Skip to content

build: consolidate linting/formatting configuration #264

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
cesarcoatl merged 1 commit into from
Jul 28, 2025
Merged

build: consolidate linting/formatting configuration #264

cesarcoatl merged 1 commit into from
Jul 28, 2025

Conversation

@cesarcoatl
Copy link
Member

@cesarcoatl cesarcoatl commented Jul 28, 2025 •
edited by sourcery-ai bot
Loading

  • use tox.ini for most of the tools
  • relocate devcontainer setup and streamline development tooling

Summary by Sourcery

Consolidate all linting and formatting configurations into the project’s tox.ini files and streamline the development container setup

Build:

  • Move docformatter, flake8, isort, and pydocstyle settings into tox.ini for both the main code and stubs
  • Remove standalone style configuration files and deprecated testenv:style sections
  • Relocate devcontainer setup by moving devcontainer.json and removing the Dockerfile

CI:

  • Update pre-commit hooks for isort, flake8, docformatter, pydocstyle, and pydoclint to reference the consolidated tox.ini settings

@cesarcoatl
build: consolidate linting/formatting configuration
0cec410 
- use tox.ini for most of the tools
- relocate devcontainer setup and streamline development tooling
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 28, 2025 •
edited
Loading

Reviewer's Guide

Centralize all linting and formatting configurations into the main and stubs tox.ini files, update pre-commit hooks to reference these unified settings, and remove deprecated standalone config files and the outdated devcontainer Dockerfile.

Flow diagram for pre-commit hook configuration after consolidation

flowchart TD
    PreCommit[".pre-commit-config.yaml"]
    ToxINI["tox.ini (main)"]
    ToxINIStubs["tox.ini (stubs)"]
    Hook1["isort-incendium"]
    Hook2["isort-stubs"]
    Hook3["docformatter"]
    Hook4["flake8-incendium"]
    Hook5["flake8-stubs"]
    Hook6["pydocstyle"]
    Hook7["pydoclint-flake8"]

    PreCommit --> Hook1
    PreCommit --> Hook2
    PreCommit --> Hook3
    PreCommit --> Hook4
    PreCommit --> Hook5
    PreCommit --> Hook6
    PreCommit --> Hook7
    Hook1 -->|--settings-file| ToxINI
    Hook2 -->|--settings-file| ToxINIStubs
    Hook3 -->|--config| ToxINI
    Hook4 -->|--config| ToxINI
    Hook5 -->|--config| ToxINIStubs
    Hook6 -->|--config| ToxINI
    Hook7 -->|--config| ToxINI
Loading

File-Level Changes

Change Details Files
Merged main project lint/format settings into incendiumm/tox.ini
  • Removed custom testenv:style environment
  • Added docformatter section with in-place and wrapping options
  • Added flake8 section with ignore rules and length limits
  • Added isort section for black profile and standard library extras
  • Added pydocstyle section with selected rules
 incendium/tox.ini
Consolidated stubs lint/format settings into incendiumm-stubs/tox.ini
  • Removed custom testenv:style environment
  • Added flake8 section with ignore rules and line-length
  • Added isort section mirroring main project settings
 incendium-stubs/tox.ini
Updated pre-commit configuration to use consolidated tox.ini settings
  • Pointed isort hooks to project and stubs tox.ini
  • Configured docformatter, flake8, pydocstyle, and pydoclint hooks to use main tox.ini
  • Removed references to standalone config files in args
 .pre-commit-config.yaml
Removed obsolete config files and devcontainer Dockerfile
  • Deleted .devcontainer/Dockerfile
  • Deleted per-tool config files (.flake8, .isort.cfg, .pydoclint, .pydocstyle) from both packages
  • Removed .mailmap from stubs
 .devcontainer/Dockerfile
incendium/.flake8
incendium/.isort.cfg
incendium/.pydoclint
incendium/.pydocstyle
incendium-stubs/.flake8
incendium-stubs/.isort.cfg
incendium-stubs/.mailmap
Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

sourcery-ai[bot]
sourcery-ai bot reviewed Jul 28, 2025
View reviewed changes
Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @cesarcoatl - I've reviewed your changes and they look great!

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@cesarcoatl cesarcoatl merged commit addf9ed into main Jul 28, 2025
8 checks passed
@cesarcoatl cesarcoatl deleted the build/pre-commit-tox-ini branch July 28, 2025 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@cesarcoatl