Add common function to update .gitignore. #375
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @annajowang, 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 introduces a new, reusable utility function within the @apphosting/common package. Its primary purpose is to standardize and simplify the process of adding entries to or creating .gitignore files, ensuring that necessary paths are consistently ignored across projects. This change enhances the package's utility by providing a common, tested method for managing Git ignore rules.
Highlights
- New Utility Function: I've added a new
UpdateOrCreateGitignorefunction topackages/@apphosting/common/src/index.ts. This function provides a common way to manage.gitignorefiles programmatically. - Robust
.gitignoreManagement: TheUpdateOrCreateGitignorefunction is designed to handle two main scenarios: creating a.gitignorefile if it doesn't exist, and appending new, unique entries to an existing one, preventing duplicate entries. - Comprehensive Testing: To ensure the reliability of the new utility, I've introduced a new test file,
packages/@apphosting/common/src/index.spec.ts, which includes dedicated unit tests for theUpdateOrCreateGitignorefunction, covering both file creation and content update scenarios. - Test Script Addition: A
testscript has been added topackages/@apphosting/common/package.jsonto easily run the newly added tests usingts-mocha.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 or fill out our survey to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request introduces a new utility function, UpdateOrCreateGitignore, to manage .gitignore files. The review focuses on improving the robustness and maintainability of this function and its associated tests. Identified issues include a critical dependency on fs-extra instead of the native fs module, a correctness bug in the file update logic related to partial matches, and the naming convention of the function. Additionally, suggestions were made to improve the test suite by importing directly from the source file and adding a cleanup step for temporary directories.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Needed by both angular and nextjs adapters to gitignore .apphosting/