docs(changeset): add an Expo config plugin to simplify enabling Next …

…Storage Fixes react-native-async-storage#750 Co-Authored-By: Bill Spooner <[email protected]>
twodoorsdev · Sep 15, 2024 · 01a758d · 01a758d
1 parent 471a1b8
commit 01a758d
Show file tree

Hide file tree

Showing 8 changed files with 3,180 additions and 48 deletions.
diff --git a/.changeset/shaggy-eggs-grin.md b/.changeset/shaggy-eggs-grin.md
@@ -0,0 +1,5 @@
+---
+"@react-native-async-storage/async-storage": minor
+---
+
+Add an Expo config plugin to simplify enabling Next Storage
diff --git a/packages/default-storage/app.plugin.js b/packages/default-storage/app.plugin.js
@@ -0,0 +1 @@
+module.exports = require('./plugin/build');
diff --git a/packages/default-storage/package.json b/packages/default-storage/package.json
@@ -52,7 +52,11 @@
     "bundle:android": "scripts/android_e2e.sh 'bundle'",
     "bundle:ios": "scripts/ios_e2e.sh 'bundle'",
     "bundle:macos": "react-native bundle --entry-file index.ts --platform macos --dev false --bundle-output example/index.macos.jsbundle",
-    "test": "concurrently -n lint,ts yarn:test:lint yarn:test:ts",
+    "plugin:build": "expo-module build plugin",
+    "plugin:clean": "expo-module clean plugin",
+    "plugin:lint": "expo-module lint plugin",
+    "plugin:test": "expo-module test plugin",
+    "test": "concurrently -n lint,ts,plugin-lint yarn:test:lint yarn:test:ts yarn:plugin:lint",
     "test:lint": "eslint $(git ls-files '*.js' '*.ts' '*.tsx')",
     "test:ts": "tsc",
     "test:e2e:android": "scripts/android_e2e.sh 'test'",
@@ -71,6 +75,7 @@
   "devDependencies": {
     "@babel/core": "^7.20.0",
     "@babel/preset-env": "^7.20.0",
+    "@expo/config-plugins": "^8.0.8",
     "@react-native/babel-preset": "^0.73.19",
     "@react-native/metro-config": "^0.73.3",
     "@rnx-kit/metro-config": "^1.3.15",
@@ -88,6 +93,7 @@
     "concurrently": "^8.2.2",
     "eslint": "^8.54.0",
     "expo": "^48.0.0",
+    "expo-module-scripts": "^3.5.2",
     "lodash": "^4.17.21",
     "prettier": "2.8.8",
     "react": "18.2.0",

diff --git a/packages/default-storage/plugin/.eslintrc.js b/packages/default-storage/plugin/.eslintrc.js
@@ -0,0 +1,2 @@
+// @generated by expo-module-scripts
+module.exports = require('expo-module-scripts/eslintrc.base.js');
diff --git a/packages/default-storage/plugin/jest.config.ts b/packages/default-storage/plugin/jest.config.ts
@@ -0,0 +1 @@
+module.exports = require('expo-module-scripts/jest-preset-plugin');
diff --git a/packages/default-storage/plugin/src/index.ts b/packages/default-storage/plugin/src/index.ts
@@ -0,0 +1,34 @@
+import type { ConfigPlugin} from '@expo/config-plugins';
+import { withGradleProperties } from '@expo/config-plugins';
+
+export type AsyncStorageOptions = {
+  useNextStorage?: boolean;
+}
+
+const withUseNextStorage: ConfigPlugin<AsyncStorageOptions> = (config, { useNextStorage = false }) => {
+  if (!useNextStorage) {
+    return config;
+  }
+
+  return withGradleProperties(config, (config) => {
+    config.modResults.push({
+      key: 'AsyncStorage_useNextStorage',
+      value: 'true',
+      type: 'property',
+    });
+
+    return config;
+  });
+};
+
+const DEFAULT_OPTS: AsyncStorageOptions = {
+  useNextStorage: false,
+}
+
+const withAsyncStorage: ConfigPlugin<AsyncStorageOptions> = (config, props) => {
+  const normalizedProps = { ...DEFAULT_OPTS, ...props };
+  config = withUseNextStorage(config, normalizedProps);
+  return config;
+};
+
+export default withAsyncStorage;
diff --git a/packages/default-storage/plugin/tsconfig.json b/packages/default-storage/plugin/tsconfig.json
@@ -0,0 +1,9 @@
+{
+  "extends": "expo-module-scripts/tsconfig.plugin",
+  "compilerOptions": {
+    "outDir": "build",
+    "rootDir": "src"
+  },
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*"]
+}
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		// @generated by expo-module-scripts
		module.exports = require('expo-module-scripts/eslintrc.base.js');
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		module.exports = require('expo-module-scripts/jest-preset-plugin');