@buoy-gg/env 7.0.36 → 7.0.38
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +32 -7
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/@buoy-gg/env) [](https://www.npmjs.com/package/@buoy-gg/env)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Inspect the environment values available to your app at runtime and check required variables against expected types and values.
|
|
6
6
|
|
|
7
|
-
Part of [Buoy](https://github.com/Buoy-gg/buoy)
|
|
7
|
+
Part of [Buoy](https://github.com/Buoy-gg/buoy). Install the package, complete account setup, and follow the integration steps below.
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
@@ -14,9 +14,27 @@ Part of [Buoy](https://github.com/Buoy-gg/buoy) — devtools that live inside yo
|
|
|
14
14
|
npm install @buoy-gg/core @buoy-gg/env
|
|
15
15
|
```
|
|
16
16
|
|
|
17
|
+
## Before you start
|
|
18
|
+
|
|
19
|
+
Use a development build with `@buoy-gg/core` and a Free or Pro Buoy account key. From your app’s directory, sign in:
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
npx --package=@buoy-gg/core buoy login
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
For Expo, initialize Buoy before rendering the menu:
|
|
26
|
+
|
|
27
|
+
```tsx
|
|
28
|
+
import { Buoy } from "@buoy-gg/core";
|
|
29
|
+
|
|
30
|
+
Buoy.init({ licenseKey: process.env.EXPO_PUBLIC_BUOY_KEY });
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
The login command writes the Expo key to `.env.local`. For React Native CLI, pass the key from your app’s environment configuration; React Native does not load `.env.local` automatically. Mount `FloatingDevTools` inside the same providers as your screens and restart the development server after installation. The [Quick Start](https://buoy.gg/buoy/latest/docs/quick-start) shows the complete root component setup.
|
|
34
|
+
|
|
17
35
|
## Quick start
|
|
18
36
|
|
|
19
|
-
|
|
37
|
+
After initialization, render the menu in your app root:
|
|
20
38
|
|
|
21
39
|
```tsx
|
|
22
40
|
import { FloatingDevTools } from "@buoy-gg/core";
|
|
@@ -47,11 +65,18 @@ const envTool = createEnvTool({
|
|
|
47
65
|
.build(),
|
|
48
66
|
],
|
|
49
67
|
});
|
|
68
|
+
|
|
69
|
+
// Render this menu inside your existing app root.
|
|
70
|
+
<FloatingDevTools apps={[envTool]} />;
|
|
50
71
|
```
|
|
51
72
|
|
|
73
|
+
## Check the integration
|
|
74
|
+
|
|
75
|
+
Open Env and check one known variable and one deliberately missing required variable. Expo statically replaces direct `process.env.EXPO_PUBLIC_NAME` references; enumerating `process.env` does not guarantee that those values are available. An empty list does not prove your app has no environment configuration.
|
|
76
|
+
|
|
52
77
|
## What you get
|
|
53
78
|
|
|
54
|
-
- **
|
|
79
|
+
- **Runtime discovery** — collects enumerable `EXPO_PUBLIC_` values available at runtime. Expo’s static inlining limits what enumeration can see.
|
|
55
80
|
- **Required-variable validation** — declare which vars must exist, with expected values or types: `string`, `number`, `boolean`, `array`, `object`, `url`.
|
|
56
81
|
- **Type detection** — values are auto-classified (string, number, boolean, array, object, url, json).
|
|
57
82
|
- **Health score** — a 0-100% health percentage with HEALTHY / WARNING / ERROR / CRITICAL states, plus counts for total, required, missing, and wrong value/type.
|
|
@@ -61,11 +86,11 @@ const envTool = createEnvTool({
|
|
|
61
86
|
|
|
62
87
|
## Desktop & AI
|
|
63
88
|
|
|
64
|
-
|
|
89
|
+
To connect a React Native app to [Buoy Desktop](https://github.com/Buoy-gg/Buoy-Desktop) or MCP, install `@buoy-gg/external-sync` and follow the [Desktop connection guide](https://buoy.gg/buoy/latest/docs/desktop). Sign in to Desktop separately. [MCP setup](https://buoy.gg/buoy/latest/docs/mcp) also requires a process account and Pro access. Available remote actions depend on the tool and app integration.
|
|
65
90
|
|
|
66
|
-
##
|
|
91
|
+
## Account and plan requirements
|
|
67
92
|
|
|
68
|
-
|
|
93
|
+
Use a Free or Pro Buoy account. History limits and paid features vary by tool; see [pricing](https://buoy.gg/pricing). Production access requires Pro where supported. Development-only hooks and actions remain unavailable in release builds.
|
|
69
94
|
|
|
70
95
|
---
|
|
71
96
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@buoy-gg/env",
|
|
3
|
-
"version": "7.0.
|
|
4
|
-
"description": "Environment variable
|
|
3
|
+
"version": "7.0.38",
|
|
4
|
+
"description": "Environment variable inspector for React Native with runtime-visible values, required-variable checks, and type validation.",
|
|
5
5
|
"main": "lib/commonjs/index.js",
|
|
6
6
|
"module": "lib/module/index.js",
|
|
7
7
|
"types": "lib/typescript/index.d.ts",
|
|
@@ -26,8 +26,8 @@
|
|
|
26
26
|
],
|
|
27
27
|
"sideEffects": false,
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@buoy-gg/floating-tools-core": "^7.0.
|
|
30
|
-
"@buoy-gg/shared-ui": "^7.0.
|
|
29
|
+
"@buoy-gg/floating-tools-core": "^7.0.38",
|
|
30
|
+
"@buoy-gg/shared-ui": "^7.0.38"
|
|
31
31
|
},
|
|
32
32
|
"peerDependencies": {
|
|
33
33
|
"react": "*",
|