Skip to content

Conversation

@ycmjason
Copy link
Contributor

@ycmjason ycmjason commented Oct 29, 2025

Description

Removed the JSDoc comment for the schema property in FirebaseConfig.

Previously, the JSDoc comment caused typescript-json-schema to generate "format": "uri" for $schema, which prevented users from using relative paths in their JSON schema references.

By removing it, users can now safely reference a local schema file instead, such as:

"$schema": "./node_modules/firebase-tools/schema/firebase-config.json"

Removed JSDoc comment for schema property in FirebaseConfig.
Copilot AI review requested due to automatic review settings October 29, 2025 00:09
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @ycmjason, 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 refines the FirebaseConfig type definition by removing a specific JSDoc comment that was inadvertently forcing the $schema property to be interpreted as a URI. The modification enhances flexibility, allowing developers to utilize relative paths for their JSON schema references, which is particularly useful for pointing to local schema files and improving overall development workflow.

Highlights

  • JSDoc Comment Removal: Removed the @TJS-format uri JSDoc comment from the $schema property within the FirebaseConfig type definition.
  • Schema Path Flexibility: This change allows users to specify relative paths for the JSON schema, enabling references to local schema versions instead of enforcing URI formats.
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
Contributor

@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 correctly removes the JSDoc comment that was forcing the $schema property to be a URI. This is a good change to allow more flexible relative paths. However, the generated JSON schema file (schema/firebase-config.json) has not been updated to reflect this change. As a result, the validation will still enforce the uri format. Please run the schema generation script and commit the updated schema file to complete this change.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR removes a JSDoc annotation that enforces URI format validation for the $schema property in Firebase configuration files. The change allows users to specify relative paths to local JSON schema files instead of requiring absolute URIs.

  • Removed @TJS-format uri JSDoc comment from the $schema property in FirebaseConfig type

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@joehan joehan merged commit 82a895d into firebase:master Oct 29, 2025
11 of 13 checks passed
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.

2 participants