Feat/git remote name utility
Summary
Details
Related Issues
How to Validate
Pre-Merge Checklist
- [ ] Updated relevant documentation and README (if needed)
- [ ] Added/updated tests (if needed)
- [ ] Noted breaking changes (if any)
- [ ] Validated on required platforms/methods:
- [ ] MacOS
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] Podman
- [ ] Seatbelt
- [ ] Windows
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] Linux
- [ ] npm run
- [ ] npx
- [ ] Docker
- [ ] MacOS
Summary of Changes
Hello @aka1976mb, I'm Gemini Code Assist[^1]! 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 focuses on improving developer utilities and configuration management within the project. It introduces a new function to identify Git remote names, streamlines the handling of Gemini API keys by allowing direct configuration and establishing a clear priority for key sources, and updates development environment settings. These changes aim to enhance the robustness of Git interactions and simplify API key management within the application.
Highlights
-
Git Remote Name Utility: A new utility function,
getRemoteName, has been introduced to programmatically determine the Git remote name associated with a given repository URL. This includes comprehensive unit tests to ensure its reliability across various scenarios. - Gemini API Key Configuration Enhancement: The application's configuration system now allows specifying the Gemini API key directly within the configuration object. This key is prioritized over environment variables and previously loaded keys, and new tests validate this priority order and ensure API keys are masked in proxy settings for security.
-
Dependency Management Updates: The
package-lock.jsonfile has been updated with refinedpeerdependency declarations for various packages, ensuring more accurate and consistent dependency resolution within the project. -
Developer Tooling Configuration: The
.vscode/settings.jsonfile has been updated to include new configurations for GitHub Pull Requests (ignoring the 'main' branch) and enabling Copilot's next edit suggestions, aiming to improve the overall developer experience.
Ignored Files
-
Ignored by pattern:
.gemini/**(1)- .gemini/config.yaml
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 :thumbsup: and :thumbsdown: 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.
[^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.
It looks like you're encountering shell parsing errors when trying to run a command. These errors are coming from PowerShell because you're trying to run code snippets as shell commands, which won't work.
Let me help you fix the two critical issues properly. Here's what you actually need to do:
Fix 1: Add the missing import in GetRemoteName.ts Open the file packages/cli/src/utils/GetRemoteName.ts and add the import at the top:
typescript // Add this line at the top of the file import { run_shell_command } from '../core/shell.js'; Or if it's a TypeScript project:
typescript import { run_shell_command } from '../core/shell'; Fix 2: Implement API key redaction in config.ts Open packages/core/src/config/config.ts and add this method to the Config class:
typescript // Add this method to your Config class getRedactedProxy(): string | undefined { if (!this.proxy) { return undefined; }
let redactedProxy = this.proxy;
// Redact the API key if it exists if (this.geminiApiKey && this.geminiApiKey.trim()) { // Escape special regex characters in the API key const escapedKey = this.geminiApiKey.replace(/[.+?^${}()|[]\]/g, '\$&'); redactedProxy = redactedProxy.replace( new RegExp(escapedKey, 'g'), '**' ); }
return redactedProxy; } Then update the createContentGeneratorConfig function to use this method. Find where it's defined (likely in packages/cli/src/config/geminiApiKey.ts or similar) and change:
typescript // Change from this: proxy: config.proxy,
// To this: proxy: config.getRedactedProxy(), Or if you want to modify the existing getProxy() method instead:
typescript getProxy(redact: boolean = false): string | undefined { if (!this.proxy) { return undefined; }
if (!redact) { return this.proxy; }
let redactedProxy = this.proxy;
if (this.geminiApiKey && this.geminiApiKey.trim()) { const escapedKey = this.geminiApiKey.replace(/[.+?^${}()|[]\]/g, '\$&'); redactedProxy = redactedProxy.replace( new RegExp(escapedKey, 'g'), '**' ); }
return redactedProxy; } And then update the call to:
typescript proxy: config.getProxy(true), What you should NOT do: Don't try to run TypeScript/JavaScript code in your shell directly
The code snippets I provided are for editing files in your code editor (VS Code, etc.)
Open the actual files and make the edits there
Here's a summary of the actions taken:
- Fixed the
ReferenceErrorinGetRemoteName.ts: Added the missing import for run_shell_command. - Implemented robust API key redaction: Modified the getProxy() method in Config.ts to redact API keys from proxy URLs.
- Updated
getProxy()call sites: Changed calls to getProxy() to getProxy(true) where necessary, ensuring API keys are redacted when exposed (e.g., in logging). - Addressed Git issues: Resolved issues with unstaged changes and diverged branches, successfully pushing the fixes to the remote repository.
- Created GitHub Issues: Created two issues for the identified problems (issues #14665 and #14666) to ensure they are tracked.
@aka1976mb Closing for same reason as your other PRs. Please respect the contribution guidelines and provide PR descriptions and link to proper issues.