scenv 0.5.0 → 0.5.1
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 +14 -14
- package/package.json +15 -4
package/README.md
CHANGED
|
@@ -28,9 +28,9 @@ const apiUrl = scenv("API URL", {
|
|
|
28
28
|
default: "http://localhost:4000",
|
|
29
29
|
});
|
|
30
30
|
|
|
31
|
-
const url = await apiUrl.get();
|
|
32
|
-
const result = await apiUrl.safeGet();
|
|
33
|
-
await apiUrl.save();
|
|
31
|
+
const url = await apiUrl.get(); // throws if missing or invalid
|
|
32
|
+
const result = await apiUrl.safeGet(); // { success, value? } | { success: false, error? }
|
|
33
|
+
await apiUrl.save(); // write current value to a context file
|
|
34
34
|
```
|
|
35
35
|
|
|
36
36
|
## Resolution order
|
|
@@ -46,21 +46,21 @@ Prompting (when to ask the user) is controlled by config `prompt`: `always` | `n
|
|
|
46
46
|
|
|
47
47
|
## Optional integrations
|
|
48
48
|
|
|
49
|
-
| Package
|
|
50
|
-
|
|
51
|
-
| [scenv-zod](https://www.npmjs.com/package/scenv-zod)
|
|
52
|
-
| [scenv-inquirer](https://www.npmjs.com/package/scenv-inquirer) | `prompt()` and callbacks for interactive prompts.
|
|
49
|
+
| Package | Purpose |
|
|
50
|
+
| -------------------------------------------------------------- | ------------------------------------------------------------- |
|
|
51
|
+
| [scenv-zod](https://www.npmjs.com/package/scenv-zod) | `validator(zodSchema)` for type-safe validation and coercion. |
|
|
52
|
+
| [scenv-inquirer](https://www.npmjs.com/package/scenv-inquirer) | `prompt()` and callbacks for interactive prompts. |
|
|
53
53
|
|
|
54
54
|
## Documentation
|
|
55
55
|
|
|
56
|
-
Full docs (config, contexts, resolution, saving, API) live in the [monorepo](https://github.com/PKWadsy/
|
|
56
|
+
Full docs (config, contexts, resolution, saving, API) live in the [monorepo](https://github.com/PKWadsy/scenv):
|
|
57
57
|
|
|
58
|
-
- [Configuration](https://github.com/PKWadsy/
|
|
59
|
-
- [Contexts](https://github.com/PKWadsy/
|
|
60
|
-
- [Resolution](https://github.com/PKWadsy/
|
|
61
|
-
- [Saving](https://github.com/PKWadsy/
|
|
62
|
-
- [API reference](https://github.com/PKWadsy/
|
|
63
|
-
- [Integration (scenv-zod, scenv-inquirer)](https://github.com/PKWadsy/
|
|
58
|
+
- [Configuration](https://github.com/PKWadsy/scenv/blob/main/docs/CONFIGURATION.md)
|
|
59
|
+
- [Contexts](https://github.com/PKWadsy/scenv/blob/main/docs/CONTEXTS.md)
|
|
60
|
+
- [Resolution](https://github.com/PKWadsy/scenv/blob/main/docs/RESOLUTION.md)
|
|
61
|
+
- [Saving](https://github.com/PKWadsy/scenv/blob/main/docs/SAVING.md)
|
|
62
|
+
- [API reference](https://github.com/PKWadsy/scenv/blob/main/docs/API.md)
|
|
63
|
+
- [Integration (scenv-zod, scenv-inquirer)](https://github.com/PKWadsy/scenv/blob/main/docs/INTEGRATION.md)
|
|
64
64
|
|
|
65
65
|
## License
|
|
66
66
|
|
package/package.json
CHANGED
|
@@ -1,10 +1,21 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "scenv",
|
|
3
|
-
"version": "0.5.
|
|
3
|
+
"version": "0.5.1",
|
|
4
4
|
"description": "Environment and context variables with runtime-configurable resolution",
|
|
5
|
-
"repository": {
|
|
6
|
-
|
|
7
|
-
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "https://github.com/PKWadsy/scenv"
|
|
8
|
+
},
|
|
9
|
+
"publishConfig": {
|
|
10
|
+
"access": "public",
|
|
11
|
+
"provenance": true
|
|
12
|
+
},
|
|
13
|
+
"keywords": [
|
|
14
|
+
"env",
|
|
15
|
+
"config",
|
|
16
|
+
"context",
|
|
17
|
+
"variables"
|
|
18
|
+
],
|
|
8
19
|
"type": "module",
|
|
9
20
|
"main": "dist/index.cjs",
|
|
10
21
|
"module": "dist/index.js",
|