refactor(env): ♻️ remove unused environment files and add dotenv conf…

…iguration

- Add a new config/index.ts file for loading the environment variables from a .env file.
- Add validateEnvironment variables function that validates the required environment variables.
- Use validateEnvironment variables to ensure the required env variables are available at runtime.
- Update index.ts to utilize the validate environment variables function.
- Replace usage of consola library with console.log to output 1 + 2.

.env.example

@@ -1,2 +1,2 @@
-NODE_ENV="production"
-# API_URL=""
+# Environment variables
+NODE_ENV=production

.github/DEVELOPMENT.md

@@ -46,11 +46,10 @@ pairs in the following format:
 
 - **`NODE_ENV`** (required): The environment in which the project is running.
  This can be either `development` or `production`.
-- **`API_URL`** (optional): The URL of the API for the project.
 
-> Adding a new environmental variable requires a zod schema update in the
-> `src/env` folder and a new entry in the `schema.ts` file in the
-> `environmentSchema` variable.
+> Adding a new environmental variable requires aa addition in the
+> `src/config/validateEnvironment.ts` file and a new entry in the global type
+> `interface NodeJS.ProcessEnv`.
 
 ## Installing the dependencies
 

README.md

@@ -27,9 +27,7 @@ other amazing technologies mentioned below to build a modern web application.
 
 - [typeScript](https://www.typescriptlang.org/)
 - [ts-node](https:/TypeStrong/ts-node)
-- [zod](https:/colinhacks/zod)
 - [dotenv-cli](https:/entropitor/dotenv-cli)
-- [consola](https:/unjs/consola)
 - [pnpm](https://pnpm.io/)
 - [eslint](https://eslint.org/)
 - [prettier](https://prettier.io/)

package.json

@@ -73,8 +73,8 @@
  ]
  },
  "dependencies": {
- "consola": "^3.0.1",
- "zod": "^3.21.4"
+ "dotenv": "^16.0.3",
+ "envalid": "^7.3.1"
  },
  "devDependencies": {
  "@commitlint/cli": "17.5.1",

project-words.txt

@@ -1,5 +1,6 @@
 amannn
 contributorsrc
+envalid
 execa
 fbca
 gacp

src/config/index.ts

@@ -0,0 +1,18 @@
+import { config } from "dotenv";
+
+/**
+ * Loads environment variables from a .env file.
+ *
+ * @function
+ * @returns {void}
+ */
+export const loadEnvironmentVariables = (): void => {
+ config({ path: `.env.${process.env.NODE_ENV ?? "development"}` });
+};
+
+loadEnvironmentVariables();
+
+/**
+ * The environment the application is running in.
+ */
+export const NODE_ENV = process.env.NODE_ENV;

src/config/validateEnvironment.ts

@@ -0,0 +1,24 @@
+import { cleanEnv, str } from "envalid";
+
+/**
+ * Validates the environment variables needed for the application to run.
+ *
+ * @function
+ * @returns {void}
+ */
+export const validateEnvironmentVariables = (): void => {
+ cleanEnv(process.env, {
+ NODE_ENV: str(),
+ });
+};
+
+declare global {
+ // By default, we do not want any namespace in Start UI [web] as it is more
+ // error prone and not useful in front end applications.
+ namespace NodeJS {
+ // eslint-disable-next-line @typescript-eslint/consistent-type-definitions, unicorn/prevent-abbreviations
+ interface ProcessEnv {
+ NODE_ENV: "development" | "production" | "test";
+ }
+ }
+}

src/index.ts

@@ -1,5 +1,6 @@
-import { consola } from "consola";
+import { validateEnvironmentVariables } from "./config/validateEnvironment";
 
-await import("./env/environment");
+validateEnvironmentVariables();
 
-consola.log("add 1 + 2: ", 1 + 2);
+// eslint-disable-next-line no-console
+console.log("add 1 + 2: ", 1 + 2);