Skip to content

Add new page documenting integration with other tools - #12

Open
dunossauro wants to merge 3 commits into
zubanls:masterfrom
dunossauro:precommit/prek
Open

Add new page documenting integration with other tools#12
dunossauro wants to merge 3 commits into
zubanls:masterfrom
dunossauro:precommit/prek

Conversation

@dunossauro

Copy link
Copy Markdown
Contributor

Includes examples for pre-commit and prek hooks.

related #9

Includes examples for pre-commit and prek hooks.

@davidhalter davidhalter left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I would personally like to have this as part of the installation instructions (installation.md). Do you think that makes sense? I just feel like I want one place where people can read about setting up Zuban.

Otherwise this change looks pretty good.

Comment thread integrations.md Outdated

### pre-commit

Zuban can be integrated into a `pre-commit` workflow as a local hook. This is

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You should probably use [pre-commit](some-url) here and below for prek as well, since a lot of people have no specific knowledge about these tools.

@davidhalter

Copy link
Copy Markdown
Member

I like the changes, thanks! What do you think about moving to installation.md (like I mentioned above?)

@dunossauro

Copy link
Copy Markdown
Contributor Author

Sorry for the delay. I pushed an update, but I was a bit short on time yesterday.

I don’t oppose moving everything into installation.md. That makes sense from a discoverability perspective.

My only concern is that we might eventually want to add more integration examples there (e.g. CI usage, combining it with a traditional linter, other tooling, etc.). I'm worried that the installation page could grow quite large and make specific things harder to find.

But maybe I'm overthinking the future a bit 😄

I can move it if you prefer keeping everything in one place.

@davidhalter

davidhalter commented Feb 12, 2026

Copy link
Copy Markdown
Member

I would prefer it there. Thanks! And feel free to mark this ready, I'm happy to merge.

@dunossauro
dunossauro marked this pull request as ready for review February 16, 2026 03:33
@dunossauro

Copy link
Copy Markdown
Contributor Author

Ok, thanks again 💖

@davidhalter

Copy link
Copy Markdown
Member

Can you still move it to installation.md? That's still missing.

Also on an unrelated note, because you asked for it before, I released Zuban 0.6.0 and it includes support for pytest fixtures. (completions, goto and type checking)

Comment thread integrations.md

```yaml
repos:
- repo: local

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

My preference is to have an 'official' repo for this; using local feels a bit like a workaround

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants