Disable prettier for the generated OpenAPI client#57
Conversation
Summary of ChangesHello @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
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
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.
for more information, see https://pre-commit.ci
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
prettierran and it ended up with a merge conflict. The generated API client isn't something we usually bother with running throughprettier, since it's all generated code and not really supposed to be edited. So, this adds a.prettierignorethat should ignore it.How can this be tested?
Automated tasks should pass. If you run prettier manually, it should leave the OpenAPI client alone.