@arkenv/core 1.0.0-alpha.3 → 1.0.0-alpha.5

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.
Files changed (10) hide show
  1. package/LICENSE +3 -0
  2. package/README.md +19 -10
  3. package/dist/index.cjs +438 -196
  4. package/dist/index.d.cts +191 -83
  5. package/dist/index.d.cts.map +1 -1
  6. package/dist/index.d.mts +191 -83
  7. package/dist/index.d.mts.map +1 -1
  8. package/dist/index.mjs +436 -194
  9. package/dist/index.mjs.map +1 -1
  10. package/package.json +10 -6
package/LICENSE CHANGED
@@ -19,3 +19,6 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
19
  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
20
  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
21
  SOFTWARE.
22
+
23
+ The `apps/dash` maintainer dashboard is licensed separately under
24
+ AGPL-3.0-or-later. See `apps/dash/LICENSE`.
package/README.md CHANGED
@@ -3,7 +3,7 @@
3
3
  <h1 align="center">ArkEnv</h1>
4
4
  <div align="center">
5
5
  <p align="center">
6
- Environment variable validation from editor to runtime<br/> for <a href="https://nextjs.org/">Next.js</a>, <a href="https://nuxt.com/">Nuxt</a>, <a href="https://nodejs.org/">Node.js</a>, <a href="https://vite.dev/">Vite</a>, and <a href="https://bun.com/">Bun</a>
6
+ Validate environment variables with your favorite validator <br/> on <a href="https://nextjs.org/">Next.js</a>, <a href="https://nuxt.com/">Nuxt</a>, <a href="https://nodejs.org/">Node.js</a>, <a href="https://vite.dev/">Vite</a>, and <a href="https://bun.com/">Bun</a>
7
7
  </p>
8
8
  <a href="https://github.com/yamcodes/arkenv/actions/workflows/test.yml?query=branch%3Amain"><img alt="Test Status" src="https://github.com/yamcodes/arkenv/actions/workflows/tests-badge.yml/badge.svg?branch=main"></a>
9
9
  <a href="https://bundlephobia.com/package/arkenv"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/arkenv"></a>
@@ -13,10 +13,10 @@
13
13
  </p>
14
14
 
15
15
  <div align="center">
16
- <a href="https://arkenv.js.org/docs/arkenv">Docs</a>
17
- <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
18
- <a href="https://arkenv.js.org/docs/arkenv/faq">FAQ</a>
19
- <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
16
+ <a href="https://arkenv.js.org/docs">Docs</a>
17
+ <span>&nbsp;&nbsp;⛯&nbsp;&nbsp;</span>
18
+ <a href="https://arkenv.js.org/docs/faq">FAQ</a>
19
+ <span>&nbsp;&nbsp;⛯&nbsp;&nbsp;</span>
20
20
  <a href="https://stackblitz.com/github/yamcodes/arkenv/tree/main/examples/stackblitz?file=index.ts">Try on StackBlitz</a>
21
21
  <br />
22
22
  </div>
@@ -24,6 +24,14 @@
24
24
  <br />
25
25
  <br />
26
26
 
27
+
28
+ <h3 align="center">
29
+ Bring your own validator: <a href="https://arktype.io/">ArkType</a>, <a href="https://zod.dev/">Zod</a>, <a href="https://valibot.dev/">Valibot</a>, or <a href="https://arkenv.js.org/docs/core-concepts/standard-schema">any Standard Schema validator</a>
30
+ </h3>
31
+
32
+ <br />
33
+ <br />
34
+
27
35
  <p align="center">
28
36
  <img alt="ArkEnv Demo" src="https://arkenv.js.org/assets/demo.gif" />
29
37
  </p>
@@ -70,7 +78,7 @@ bunx arkenv@latest init
70
78
 
71
79
  <br />
72
80
 
73
- ### [Read the docs →](https://arkenv.js.org/docs/ArkEnv/quickstart)
81
+ ### [Read the docs →](https://arkenv.js.org/docs/getting-started)
74
82
 
75
83
  <br />
76
84
 
@@ -86,12 +94,13 @@ You are also welcome to [contribute to the project](https://github.com/yamcodes/
86
94
  <table>
87
95
  <tbody>
88
96
  <tr>
89
- <td align="center" valign="top" width="14.28%"><a href="https://yam.codes"><img src="https://avatars.githubusercontent.com/u/2014360?v=4?s=100" width="100px;" alt="Yam C Borodetsky"/><br /><sub><b>Yam C Borodetsky</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=yamcodes" title="Code">💻</a> <a href="#question-yamcodes" title="Answering Questions">💬</a> <a href="#ideas-yamcodes" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-yamcodes" title="Design">🎨</a> <a href="https://github.com/yamcodes/arkenv/commits?author=yamcodes" title="Documentation">📖</a> <a href="https://github.com/yamcodes/arkenv/issues?q=author%3Ayamcodes" title="Bug reports">🐛</a> <a href="#example-yamcodes" title="Examples">💡</a> <a href="#infra-yamcodes" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/yamcodes/arkenv/commits?author=yamcodes" title="Tests">⚠️</a></td>
97
+ <td align="center" valign="top" width="14.28%"><a href="https://yam.codes"><img src="https://avatars.githubusercontent.com/u/2014360?v=4?s=100" width="100px;" alt="Yam C Borodetsky"/><br /><sub><b>Yam C Borodetsky</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=yamcodes" title="Code">💻</a> <a href="#question-yamcodes" title="Answering Questions">💬</a> <a href="#ideas-yamcodes" title="Ideas, Planning, & Feedback">🤔</a> <a href="#design-yamcodes" title="Design">🎨</a> <a href="https://github.com/yamcodes/arkenv/commits?author=yamcodes" title="Documentation">📖</a> <a href="https://github.com/yamcodes/arkenv/issues?q=author%3Ayamcodes" title="Bug reports">🐛</a> <a href="#example-yamcodes" title="Examples">💡</a> <a href="#infra-yamcodes" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#plugin-yamcodes" title="Plugin/utility libraries">🔌</a> <a href="#tool-yamcodes" title="Tools">🔧</a> <a href="https://github.com/yamcodes/arkenv/commits?author=yamcodes" title="Tests">⚠️</a></td>
90
98
  <td align="center" valign="top" width="14.28%"><a href="https://github.com/aruaycodes"><img src="https://avatars.githubusercontent.com/u/57131628?v=4?s=100" width="100px;" alt="Aruay Berdikulova"/><br /><sub><b>Aruay Berdikulova</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=aruaycodes" title="Code">💻</a> <a href="#ideas-aruaycodes" title="Ideas, Planning, & Feedback">🤔</a></td>
91
99
  <td align="center" valign="top" width="14.28%"><a href="https://arktype.io"><img src="https://avatars.githubusercontent.com/u/10645823?v=4?s=100" width="100px;" alt="David Blass"/><br /><sub><b>David Blass</b></sub></a><br /><a href="#ideas-ssalbdivad" title="Ideas, Planning, & Feedback">🤔</a> <a href="#mentoring-ssalbdivad" title="Mentoring">🧑‍🏫</a> <a href="#question-ssalbdivad" title="Answering Questions">💬</a></td>
92
- <td align="center" valign="top" width="14.28%"><a href="https://github.com/danciudev"><img src="https://avatars.githubusercontent.com/u/44430251?v=4?s=100" width="100px;" alt="Andrei Danciu"/><br /><sub><b>Andrei Danciu</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=danciudev" title="Code">💻</a></td>
93
- <td align="center" valign="top" width="14.28%"><a href="https://joakim.beng.se"><img src="https://avatars.githubusercontent.com/u/1427383?v=4?s=100" width="100px;" alt="Joakim Carlstein"/><br /><sub><b>Joakim Carlstein</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=joakimbeng" title="Code">💻</a> <a href="https://github.com/yamcodes/arkenv/commits?author=joakimbeng" title="Documentation">📖</a></td>
94
- <td align="center" valign="top" width="14.28%"><a href="https://fresh-accordion-06a.notion.site/Jiayi-Du-1817075e92978076b95cf9d90fb5eceb"><img src="https://avatars.githubusercontent.com/u/166608075?v=4?s=100" width="100px;" alt="RoomWithOutRoof"/><br /><sub><b>RoomWithOutRoof</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=Jah-yee" title="Documentation">📖</a></td>
100
+ <td align="center" valign="top" width="14.28%"><a href="https://github.com/danciudev"><img src="https://avatars.githubusercontent.com/u/44430251?v=4?s=100" width="100px;" alt="Andrei Danciu"/><br /><sub><b>Andrei Danciu</b></sub></a><br /><a href="#plugin-danciudev" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/yamcodes/arkenv/commits?author=danciudev" title="Code">💻</a></td>
101
+ <td align="center" valign="top" width="14.28%"><a href="https://joakim.beng.se"><img src="https://avatars.githubusercontent.com/u/1427383?v=4?s=100" width="100px;" alt="Joakim Carlstein"/><br /><sub><b>Joakim Carlstein</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=joakimbeng" title="Code">💻</a> <a href="#plugin-joakimbeng" title="Plugin/utility libraries">🔌</a> <a href="https://github.com/yamcodes/arkenv/commits?author=joakimbeng" title="Documentation">📖</a></td>
102
+ <td align="center" valign="top" width="14.28%"><a href="https://fresh-accordion-06a.notion.site/Jiayi-Du-1817075e92978076b95cf9d90fb5eceb"><img src="https://avatars.githubusercontent.com/u/166608075?v=4?s=100" width="100px;" alt="RoomWithOutRoof"/><br /><sub><b>RoomWithOutRoof</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=Jah-yee" title="Documentation">📖</a> <a href="#tool-Jah-yee" title="Tools">🔧</a></td>
103
+ <td align="center" valign="top" width="14.28%"><a href="https://abhimanyutiwaribot.vercel.app"><img src="https://avatars.githubusercontent.com/u/181746977?v=4?s=100" width="100px;" alt="Abhimanyu Tiwari"/><br /><sub><b>Abhimanyu Tiwari</b></sub></a><br /><a href="https://github.com/yamcodes/arkenv/commits?author=abhimanyutiwaribot" title="Code">💻</a> <a href="https://github.com/yamcodes/arkenv/commits?author=abhimanyutiwaribot" title="Documentation">📖</a> <a href="#example-abhimanyutiwaribot" title="Examples">💡</a> <a href="https://github.com/yamcodes/arkenv/commits?author=abhimanyutiwaribot" title="Tests">⚠️</a> <a href="#tool-abhimanyutiwaribot" title="Tools">🔧</a></td>
95
104
  </tr>
96
105
  </tbody>
97
106
  </table>