Merge next-firebase-auth: 0.13.5-alpha.0

.eslintrc.js

@@ -19,6 +19,13 @@ module.exports = {
     ],
     'react-hooks/rules-of-hooks': 'error',
     'react-hooks/exhaustive-deps': 'error',
+    'react/function-component-definition': [
+      2,
+      {
+        namedComponents: 'arrow-function',
+        unnamedComponents: 'arrow-function',
+      },
+    ],
   },
   overrides: [
     // Set Jest rules only for test files.

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,11 +7,21 @@ assignees: ''
 
 ---
 
+**When filing a bug report, please confirm you've done the following:**
+
+1. Have you set `onVerifyTokenError` and `onTokenRefreshError` in your config and checked for any helpful errors?
+2. Have you set `debug: true` in your config and read through server-side and client-side debug logs for any helpful messages?
+3. Have you tried the [example app](https://github.com/gladly-team/next-firebase-auth/tree/main/example) with your own Firebase credentials?
+4. Have you read through the [troubleshooting](https://github.com/gladly-team/next-firebase-auth#troubleshooting) Q&A?
+
 **Describe the bug**
-A clear and concise description of what the bug is.
+A clear and concise description of the bug.
 
-**Version**
-What version of `next-firebase-auth` are you using?
+**Versions**
+
+`next-firebase-auth` version: 
+Firebase JS SDK: 
+Next.js: 
 
 **To Reproduce**
 Steps to reproduce the behavior:
@@ -23,5 +33,8 @@ Steps to reproduce the behavior:
 **Expected behavior**
 A clear and concise description of what you expected to happen.
 
+**Debug and error logs**
+Please provide debug logs or errors from `onVerifyTokenError` and `onTokenRefreshError`.
+
 **Additional context**
 Add any other context about the problem here.

.github/workflows/npm-publish.yml

@@ -16,6 +16,17 @@ jobs:
       - run: yarn install
       - run: yarn test
       - run: yarn run build
-      - run: npm publish
+      - run: echo ${{github.ref}}
+      - name: Release canary version
+        # The ref will be the tag name. Match against tags like
+        # "v1.0.0-canary.0".
+        if: ${{ contains(github.ref, '-canary.') }}
+        run: npm publish --tag canary
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+      - name: Release latest version
+        # Assume non-canary is latest.
+        if: ${{ !contains(github.ref, '-canary.') }}
+        run: npm publish
         env:
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

.prettierrc.json

@@ -1,6 +1,5 @@
 {
   "bracketSpacing": true,
-  "jsxBracketSameLine": false,
   "useTabs": false,
   "semi": false,
   "singleQuote": true,

CODE_OF_CONDUCT.md

@@ -0,0 +1,40 @@
+
+# Contributor Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others’ private information, such as a physical or email address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant, version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct/).

CONTRIBUTING.md

@@ -0,0 +1,55 @@
+# Contributing
+
+Welcome, and thanks for considering contributing to `next-firebase-auth`! We really appreciate your support.
+
+Here are some quick guidelines on how to contribute productively.
+
+### Open issues before working
+
+Before working on a new feature or bug fix, please open a detailed issue for discussion. This helps prevent wasted time (for example, if the feature is out of scope of this package) and gives other community members a chance for input.
+
+If you'll start work on an existing issue, please comment that you're working on it so other contributors don't duplicate efforts.
+
+### Use issue templates
+
+Please use the issue templates. Issues outside of the template guidelines may be closed.
+
+Use discussions for Q&A and for help on your app's specific implementation.
+
+If reporting a bug, especially a full-stack one (such as problems with cookies), please provide a full example or clear way to reproduce it.
+
+### Security disclosures
+
+If you find a security vulnerability, do **not** open an issue. Please email the maintainers at [[email protected]](mailto:[email protected]).
+
+### Making code contributions
+
+1. Before coding, please open a related issue (or comment on an existing issue to let us know you're working on it)
+2. Fork this repository
+3. Make code changes in your fork
+    * Add comments where it's potentially unclear what your code is doing
+    * Commit with descriptive messages
+    * Ensure complete code coverage for your changes
+    * Make sure all linting and tests succeed (`yarn run test`)
+4. Open a pull request pointing to the `main` branch in this repository
+    * Add a clear title
+    * In the description, link to the related issue, such as: `Closes #123.`
+
+### Developing with a local version of the package
+
+While developing, it can be helpful to use a local version of `next-firebase-auth` in another app. To do so:
+
+1. Install [yalc](https://www.npmjs.com/package/yalc): `yarn global add yalc`
+2. In `next-firebase-auth`, publish a local version: `yarn run dev:publish` -- this builds your local package code, then publishes it with Yalc
+3. In another local Next.js app, such as the example app in this repository: `yalc add next-firebase-auth`
+4. After you make changes to your local `next-firebase-auth`, use `yarn run dev:publish` again to use the latest local code in your app
+
+### We may be slow to respond
+
+At the moment, this repository is maintained by ~1 person in their spare time. We will be as responsive as possible, but we may be slow to respond to issues and PRs. Thanks for your patience!
+
+### Be a good community member
+
+Please respect our [Code of Conduct](./CODE_OF_CONDUCT.md) and contribute to a positive, constructive open source environment.
+
+We strive to support first-time contributors and beginners through guidance and constructive feedback.