112 change env reader to dotenvx (#115)

* feat: use dotenvx instead of dotenv

* build: update how env files are added to docker-compose flow & adapt docs

* build(docker-compose): use nextjs convention to load .env files

Author: HunteRoi

#.env

@@ -1,8 +1,3 @@
-DISCORD_TOKEN=
+NODE_ENV=development
 POSTGRES_DB=
 POSTGRES_USER=
-POSTGRES_PASSWORD=
-DATABASE_PORT=5432
-DATABASE_HOST=localhost
-NODE_ENV=development
-SENDGRID_API_KEY=

#.env.development

@@ -0,0 +1,6 @@
+DISCORD_TOKEN=
+POSTGRES_PASSWORD=
+DATABASE_PORT=5432
+DATABASE_HOST=localhost
+DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${POSTGRES_DB}?schema=public
+SENDGRID_API_KEY=

.dockerignore

@@ -0,0 +1 @@
+.env.keys

Dockerfile

@@ -3,5 +3,8 @@ FROM node:lts-alpine
 WORKDIR /app
 
 COPY . .
-RUN yarn install --frozen-lockfile \
-    && yarn env-gen
+
+RUN apk --no-cache add curl \
+    && yarn install --frozen-lockfile \
+    && yarn env-gen \
+    && curl -fsS https://dotenvx.sh/install.sh | sh

README.md

@@ -3,26 +3,32 @@
 
 Discord bot built with Discord.JS for Section IODA guild.
 
+This application uses environment variables to build and run properly.
 The following environment variables must be filled in a `.env` file.
-This file is used when building the container to generate a production-ready .env file.
 ```dotenv
-DISCORD_TOKEN=
+NODE_ENV=development
 POSTGRES_DB=
 POSTGRES_USER=
+```
+An empty copy of this file is available as [#.env](./#.env).
+
+The following environment ones in `.env.<NODE_ENV>` file.
+```dotenv
+DISCORD_TOKEN=
 POSTGRES_PASSWORD=
 DATABASE_PORT=5432
 DATABASE_HOST=localhost
-NODE_ENV=development
+DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${DATABASE_HOST}:${DATABASE_PORT}/${POSTGRES_DB}?schema=public
 SENDGRID_API_KEY=
 ```
-An empty copy of this file is available as [#.env](./#.env).
+An empty copy of this file is available as [#.env.development](./#.env.development).
 
 ## Deployment
 As the app is dockerized, you can deploy it on your server or locally on your machine.
 
-If you wish to deploy it with a development configuration*, you can run `docker-compose up`.
+If you wish to deploy it with a development configuration*, you can run `docker compose up`.
 
 If you need it to be deployed on production ground, change the `NODE_ENV=development` value in the `.env` file by `NODE_ENV=production`.
-You can then run the `docker-compose up` command!
+You can then run the `docker compose up` command!
 
 _\* the Developer eXperience (DX) is a priority to us, which means default commands will always trigger processes for the development environment, never for the production one!_

docker-compose.yaml

@@ -1,10 +1,14 @@
 x-env_file:
   &env-file
-  env_file: ./.env
+  env_file:
+    - ./.env
+    - ./.env.${NODE_ENV}
+
 x-network:
   &network
   networks:
     - postgres-network
+
 x-restart-policy:
   &restart-policy
   restart: always
@@ -26,12 +30,15 @@ services:
       interval: 1s
       timeout: 1s
       retries: 60
+
   bot:
     <<: [*env-file, *network, *restart-policy]
+    environment:
+      - NODE_ENV=${NODE_ENV}
     build:
       context: .
       dockerfile: ./Dockerfile
-    command: yarn tsx ./index.ts | tee -a /var/log/datadrop/console.log
+    command: dotenvx run --convention=nextjs -- yarn start
     volumes:
       - bot_logs:/var/log/datadrop/
     depends_on:

index.ts

@@ -1,11 +1,11 @@
 import { GatewayIntentBits } from "discord.js";
-import * as dotenv from "dotenv";
+import * as dotenvx from "@dotenvx/dotenvx";
 
 import { readConfig } from "./src/config.js";
 import { DatadropClient } from "./src/datadrop.js";
 import type { Configuration } from "./src/models/Configuration.js";
 
-dotenv.config({ debug: Boolean(process.env.DEBUG), encoding: "utf-8" });
+dotenvx.config({ debug: Boolean(process.env.DEBUG), encoding: "utf-8" });
 
 let client: DatadropClient;
 readConfig()

package.json

@@ -4,11 +4,12 @@
 	"type": "module",
 	"main": "./build/index.js",
 	"scripts": {
-		"start": "docker-compose up --build",
-		"stop": "docker-compose down",
-		"deploy:commands": "tsc && node ./scripts/deploy-commands.cjs",
+		"cu": "docker compose up --build",
+		"cd": "docker compose down",
+		"start": "tsx ./index.ts | tee -a /var/log/datadrop/console.log",
 		"build": "rm -rf build/ && tsc",
-		"lint": "biome check --write ./src index.ts ./scripts",
+		"deploy:commands": "yarn build && node ./scripts/deploy-commands.cjs",
+		"lint": "biome check --write index.ts ./src ./scripts",
 		"env-gen": "node ./scripts/envgen.cjs"
 	},
 	"repository": {
@@ -22,14 +23,14 @@
 	},
 	"homepage": "https://github.com/section-IG/DataDrop#readme",
 	"dependencies": {
+		"@dotenvx/dotenvx": "^1.21.1",
 		"@hunteroi/advanced-logger": "^0.2.0",
 		"@hunteroi/discord-selfrole": "^4.0.4",
 		"@hunteroi/discord-temp-channels": "^3.3.0",
 		"@hunteroi/discord-verification": "^1.5.0",
 		"@sendgrid/mail": "8.1.3",
 		"discord-sync-commands": "^0.3.0",
 		"discord.js": "^14.16.2",
-		"dotenv": "^16.4.5",
 		"ts-postgres": "1.3.0"
 	},
 	"devDependencies": {