docs: update null-safety documentation & versions

jyardin · Feb 3, 2021 · 4496159 · 4496159
1 parent c3bcadd
commit 4496159
Show file tree

Hide file tree

Showing 8 changed files with 1,626 additions and 1,603 deletions.
diff --git a/docs/null-safety.mdx b/docs/null-safety.mdx
@@ -1,21 +1,36 @@
 ---
-id: nullsafety
+id: null-safety
 title: Null Safety
 ---
 
-Dart [Sound null safety](https://dart.dev/null-safety) is currently in beta. Some FlutterFire packages
-have preview versions of null safety implementations available to use. Please note, not all
-packages have been converted - we are working through them as quickly as possible.
+Dart [sound null safety](https://dart.dev/null-safety) is currently in beta, however; some FlutterFire packages
+have preview versions of null-safety implementations that are available to use.
 
-> At this time it is not possible to mix non-null safe and null safe versions of FlutterFire.
+The below table outlines the latest null-safe plugin versions:
 
-View the [GitHub discussion](https://github.com/FirebaseExtended/flutterfire/discussions/4182) for more information.
-
-The below table outlines the currently published and available null safe plugin versions:
 
 |                 Plugin |                                  Version |
 | ---------------------: | ---------------------------------------: |
-|        `firebase_core` |        `^{{ plugins.firebase_core_ns }}` |
+|      `cloud_firestore` |      `^{{ plugins.cloud_firestore_ns }}` |
 |        `firebase_auth` |        `^{{ plugins.firebase_auth_ns }}` |
-|      `cloud_functions` |       `^{{ plugins.cloud_functions_ns }}` |
-| `firebase_crashlytics` | `^{{ plugins.firebase_crashlytics_ns }}` |
+|        `firebase_core` |        `^{{ plugins.firebase_core_ns }}` |
+| `firebase_crashlytics` | `^{{ plugins.firebase_crashlytics_ns }}` |
+|   `firebase_messaging` |   `^{{ plugins.firebase_messaging_ns }}` |
+|      `cloud_functions` |      `^{{ plugins.cloud_functions_ns }}` |
+
+---
+
+### Using with other non-null-safe FlutterFire packages
+
+:::caution
+Mixing currently **published** null-safety FlutterFire packages alongside **published** non-nullsafety packages is not supported.
+:::
+
+Not all FlutterFire packages have null-safety versions available yet. If you need to use the null-safe packages alongside
+the non-null-safe packages then it's recommended you switch to sourcing your FlutterFire packages directly from the [main
+FlutterFire repository](https://github.com/FirebaseExtended/flutterfire) (rather than pub.dev) where the packages have
+compatible version constraints.
+
+---
+
+To provide feedback on these versions or to see progress updates: see [this GitHub discussion](https://github.com/FirebaseExtended/flutterfire/discussions/4182).
diff --git a/docs/sidebars.js b/docs/sidebars.js
@@ -15,7 +15,7 @@ module.exports = {
       "installation/macos",
       "installation/web",
       "migration",
-      "nullsafety",
+      "null-safety",
     ],
     // AdMob: ["admob/usage", toReferenceAPI("firebase_admob")],
     Analytics: ["analytics/overview", toReferenceAPI("firebase_analytics")],

diff --git a/website/api.js b/website/api.js
@@ -1,5 +1,11 @@
 const axios = require('axios');
 
+const MANUAL_NS_IGNORES = {
+  firebase_auth: ['0.21.0-nullsafety.0'],
+  firebase_core: ['0.8.0-nullsafety.0', '0.8.0-nullsafety.1'],
+  cloud_functions: ['0.9.1-nullsafety.0', '0.9.1-nullsafety.1'],
+};
+
 // Fetch the plugins latest version from the pub API
 async function fetchPluginVersions(plugin) {
   try {
@@ -14,7 +20,13 @@ async function fetchPluginVersions(plugin) {
     const nsList = versions
       .filter(v => v.includes('nullsafety'))
       // Skip an invalid version which shouldn't be used
-      .filter(v => v !== '0.21.0-nullsafety.0');
+      .filter(v => {
+        if (MANUAL_NS_IGNORES[plugin]) {
+          return !MANUAL_NS_IGNORES[plugin].includes(v);
+        }
+
+        return true;
+      });
 
     return [nnsList[nnsList.length - 1], nsList[nsList.length - 1]];
   } catch (e) {

diff --git a/website/docusaurus-plugins/favicon-tags.js b/website/docusaurus-plugins/favicon-tags.js
@@ -42,7 +42,7 @@ module.exports = function generateFaviconTags() {
             attributes: {
               rel: 'mask-icon',
               href: '/favicon/safari-pinned-tab.svg',
-              color: '#5bbad5'
+              color: '#5bbad5',
             },
           },
           {

diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js
@@ -10,9 +10,9 @@ module.exports = {
   projectName: 'flutterfire',
   themeConfig: {
     announcementBar: {
-      id: 'wip',
+      id: 'wip-nullsafety',
       content:
-        'The FlutterFire documentation hub is currently a work in progress. <a rel="noopener" target="_blank" href="https://github.com/FirebaseExtended/flutterfire/issues/2582"><b>Check out the roadmap to learn more.</b></a>.',
+        '📣 <a rel="noopener" href="https://firebase.flutter.dev/docs/null-safety"><b>Null-safety versions</b></a> are now available. This FlutterFire documentation hub is currently a work in progress - <a rel="noopener" target="_blank" href="https://github.com/FirebaseExtended/flutterfire/issues/2582"><b>check out the roadmap to learn more.</b></a>.',
       backgroundColor: '#13B9FD',
       textColor: '#fff',
     },

diff --git a/website/firebase.json b/website/firebase.json
@@ -1,11 +1,7 @@
 {
   "hosting": {
     "public": "build",
-    "ignore": [
-      "firebase.json",
-      "**/.*",
-      "**/node_modules/**"
-    ],
+    "ignore": ["firebase.json", "**/.*", "**/node_modules/**"],
     "rewrites": [
       {
         "source": "**",

diff --git a/website/package.json b/website/package.json
@@ -12,8 +12,8 @@
   "dependencies": {
     "@docusaurus/core": "^2.0.0-alpha.66",
     "@docusaurus/module-type-aliases": "^2.0.0-alpha.66",
-    "@docusaurus/preset-classic": "^2.0.0-alpha.66",
     "@docusaurus/plugin-google-gtag": "^2.0.0-alpha.66",
+    "@docusaurus/preset-classic": "^2.0.0-alpha.66",
     "@types/classnames": "^2.2.10",
     "@types/lodash.get": "^4.4.6",
     "@types/react": "^16.9.55",