Skip to content

Conversation

@CatWithNineLives
Copy link

@CatWithNineLives CatWithNineLives commented Jan 9, 2026

Description

  • The analytics API wasn't mentioned in the reference docs. Fixed it by generating a type declaration file for analytics so that its documentation can be automatically added to https://rnfirebase.io/reference

  • While locally building the docs website, faced the following eslint related error :

Screenshot 2026-01-09 at 12 34 35 PM

This was happening due to a version mismatch between eslint-plugin-react and eslint

eslint-plugin-react v7.32.2 is the last version that supports ESLint 6. Version 7.33.0+ added generator functions that require ESLint 8's JavaScript engine.

- Updated `eslint` to `8.57.0` to support  `eslint-plugin-react` `v7.37.5`
- Updated the prettier and typescript packages to match ESLint 8
- Updated .eslintrc.js with root: `true` to isolate the website from the root `ESLint 9` config (which was interfering)

Release Summary

  • Added analytics to the reference API docs
  • Fixed eslint issues in the documentation website

Related Issues

Checklist

  • I read the Contributor Guide and followed the process outlined there for submitting PRs.
    • Yes
  • My change supports the following platforms;
    • Android
    • iOS
    • Other (macOS, web)
  • My change includes tests;
    • e2e tests added or updated in packages/\*\*/e2e
    • jest tests added or updated in packages/\*\*/__tests__
    • None, because I have made changes to the documentation website
  • I have updated TypeScript types that are affected by my change.
  • This is a breaking change;
    • Yes
    • No

Test Plan

  • Added analytics to reference API in the documentation website
BEFORE AFTER
No analytics section in https://rnfirebase.io/reference Analytics section was added to reference API
Before – RNFirebase reference without analytics section After – RNFirebase reference with analytics section
  • Things are running well on running the documentation website locally (as visible in the screenshots above too)

🔥

Think react-native-firebase is great? Please consider supporting the project with any of the below:

@vercel
Copy link

vercel bot commented Jan 9, 2026

@CatWithNineLives is attempting to deploy a commit to the Invertase Team on Vercel.

A member of the Team first needs to authorize it.

"eslint": "^6.8.0",
"eslint-config-prettier": "^6.15.0",
"eslint-plugin-prettier": "^3.4.1",
"@typescript-eslint/eslint-plugin": "^5.62.0",
Copy link
Author

Choose a reason for hiding this comment

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

Reviewers: Let me know if i should raise a separate PR for these issues, was facing these problems while building the website locally hence fixed them.

@mikehardy
Copy link
Collaborator

Thanks for this - it came in approximately the same time we suffered a regression on release and likely all related as I believe this was due to typescript migration

This will likely fix an issue I just logged for tracking that someone else noticed, as I'd forgotten you'd posted this PR in my struggle to fix #8829 😅

@mikehardy mikehardy added the Workflow: Needs Review Pending feedback or review from a maintainer. label Jan 24, 2026
@mikehardy
Copy link
Collaborator

Hmm - I looked into this pretty deeply this afternoon and unfortunately I think this as a solution won't be sufficient - it does fix analytics but it does so by requiring maintenance of a new types file when the point of moving to typescript is that types are just built in, no separate maintenance. So on that criteria alone it's unfortunately not a viable path

Secondarily, this fixes analytics but we've got 5 and counting modules in typescript and it doesn't handle the others, plus would need to be done for each

So sadly I'm going to close this PR but I really appreciate that you made it, it's a valiant attempt and our docs are broken, so thank you

I'll outline the sketch of what I think the solution is on the linked issue I created, and I'll start trying it to see if it will work shortly - we need those reference docs back

@mikehardy mikehardy closed this Jan 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Workflow: Needs Review Pending feedback or review from a maintainer.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[📚] The rnfirebase.io documentation site is not generating reference API docs for all modules

2 participants