Skip to content

Disable prettier for the generated OpenAPI client#57

Open
jkachel wants to merge 2 commits intomainfrom
jkachel/dont-run-prettier-on-generated-files
Open

Disable prettier for the generated OpenAPI client#57
jkachel wants to merge 2 commits intomainfrom
jkachel/dont-run-prettier-on-generated-files

Conversation

@jkachel
Copy link

@jkachel jkachel commented Dec 17, 2025

What are the relevant tickets?

Related to #37

Description (What does it do?)

#37 came up in one of my Renovate Days - it was actually fine but prettier ran and it ended up with a merge conflict. The generated API client isn't something we usually bother with running through prettier, since it's all generated code and not really supposed to be edited. So, this adds a .prettierignore that should ignore it.

How can this be tested?

Automated tasks should pass. If you run prettier manually, it should leave the OpenAPI client alone.

@gemini-code-assist
Copy link

Summary of Changes

Hello @jkachel, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request aims to streamline the development workflow by excluding generated OpenAPI client code from Prettier's formatting process. This change addresses potential merge conflicts and unnecessary formatting changes in files that are not intended for manual editing, thereby improving efficiency and reducing friction for developers.

Highlights

  • Prettier Configuration: Introduced a .prettierignore file to prevent Prettier from formatting generated OpenAPI client files, specifically all .ts files within the src/ directory.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request aims to prevent Prettier from formatting the generated OpenAPI client by adding a .prettierignore file. This is a good idea to avoid unnecessary diffs and potential conflicts. However, the ignore pattern src/**/*.ts is too broad and could affect other non-generated TypeScript files in the future. I've suggested a more specific pattern to only ignore the directory containing the generated client, which is safer and more aligned with the PR's intent.

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.

1 participant