{"id":29089255,"url":"https://github.com/criting/nuxt-required-env","last_synced_at":"2025-06-28T04:02:19.832Z","repository":{"id":299218155,"uuid":"1002403163","full_name":"criting/nuxt-required-env","owner":"criting","description":"Ensure that all required environment variables exist.","archived":false,"fork":false,"pushed_at":"2025-06-27T12:43:08.000Z","size":194,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-06-27T12:58:06.488Z","etag":null,"topics":["build","deployment","env","environment-variables","nuxt","nuxt3","nuxtjs"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/nuxt-required-env","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/criting.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-06-15T12:00:06.000Z","updated_at":"2025-06-27T12:43:11.000Z","dependencies_parsed_at":"2025-06-15T12:30:06.546Z","dependency_job_id":null,"html_url":"https://github.com/criting/nuxt-required-env","commit_stats":null,"previous_names":["criting/nuxt-required-env"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/criting/nuxt-required-env","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criting%2Fnuxt-required-env","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criting%2Fnuxt-required-env/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criting%2Fnuxt-required-env/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criting%2Fnuxt-required-env/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/criting","download_url":"https://codeload.github.com/criting/nuxt-required-env/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/criting%2Fnuxt-required-env/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":262371662,"owners_count":23300591,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["build","deployment","env","environment-variables","nuxt","nuxt3","nuxtjs"],"created_at":"2025-06-28T04:01:28.854Z","updated_at":"2025-06-28T04:02:19.827Z","avatar_url":"https://github.com/criting.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"\u003c!--\nGet your module up and running quickly.\n\nFind and replace all on all files (CMD+SHIFT+F):\n- Name: nuxt-required-env\n- Package name: nuxt-required-env\n- Description: nuxt-required-env\n--\u003e\n\n# nuxt-required-env\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n[![License][license-src]][license-href]\n[![Nuxt][nuxt-src]][nuxt-href]\n\nEnsure that all required environment variables exist.\n\n## Features\n\n\u003c!-- Highlight some of the features your module provide here --\u003e\n- ✅ Define required environment variables\n- 🔒 Fails fast in dev or build if any are missing\n- ⚙️ Checks both .env and runtimeConfig\n- 🛠 Improves deployment safety and DX\n\n## Quick Setup\n\nInstall the module to your Nuxt application with one command:\n\n```bash\nnpx nuxi module add nuxt-required-env\n```\nCreate a file called env-schema.ts in your project root:\n```\nimport { z } from 'zod'\n\nexport const EnvSchema = z.object({\n  NUXT_PUBLIC_SITE_URL: z.string().url(),\n  STRIPE_KEY: z.string(),\n  SUPABASE_URL: z.string().url(),\n  MY_SECRET: z.string().min(10),\n})\n```\n\nIf your schema is in a different path, set it via module options:\n```\nexport default defineNuxtConfig({\n  modules: ['nuxt-required-env'],\n  requiredEnv: {\n    schemaPath: 'config/env-schema', // path relative to project root, without extension\n  },\n})\n```\nThat's it! You can now use nuxt-required-envin your Nuxt app ✨\n\n\n## Contribution\n\n\u003cdetails\u003e\n  \u003csummary\u003eLocal development\u003c/summary\u003e\n  \n  ```bash\n  # Install dependencies\n  npm install\n  \n  # Generate type stubs\n  npm run dev:prepare\n  \n  # Develop with the playground\n  npm run dev\n  \n  # Build the playground\n  npm run dev:build\n  \n  # Run ESLint\n  npm run lint\n  \n  # Run Vitest\n  npm run test\n  npm run test:watch\n  \n  # Release new version\n  npm run release\n  ```\n\n\u003c/details\u003e\n\n\n\u003c!-- Badges --\u003e\n[npm-version-src]: https://img.shields.io/npm/v/nuxt-required-env/latest.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[npm-version-href]: https://npmjs.com/package/nuxt-required-env\n\n[npm-downloads-src]: https://img.shields.io/npm/dm/nuxt-required-env.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[npm-downloads-href]: https://npm.chart.dev/nuxt-required-env\n\n[license-src]: https://img.shields.io/npm/l/nuxt-required-env.svg?style=flat\u0026colorA=020420\u0026colorB=00DC82\n[license-href]: https://npmjs.com/package/nuxt-required-env\n\n[nuxt-src]: https://img.shields.io/badge/Nuxt-020420?logo=nuxt.js\n[nuxt-href]: https://nuxt.com\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcriting%2Fnuxt-required-env","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcriting%2Fnuxt-required-env","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcriting%2Fnuxt-required-env/lists"}