chore(repo): init AppConfig module

This commit is contained in:
Francesco Spilla 2025-02-07 12:16:13 +01:00
parent 8806114929
commit a742b9dc5e
8 changed files with 100 additions and 4 deletions

3
.gitignore vendored
View File

@ -1,5 +1,8 @@
# See http://help.github.com/ignore-files/ for more about ignoring files. # See http://help.github.com/ignore-files/ for more about ignoring files.
# dotenv
.env
# compiled output # compiled output
dist dist
tmp tmp

View File

@ -1,9 +1,10 @@
import { Module } from '@nestjs/common'; import { Module } from '@nestjs/common';
import { AppConfigModule } from './modules/config/config.module';
import { AppController } from './app.controller'; import { AppController } from './app.controller';
import { AppService } from './app.service'; import { AppService } from './app.service';
@Module({ @Module({
imports: [], imports: [AppConfigModule],
controllers: [AppController], controllers: [AppController],
providers: [AppService], providers: [AppService],
}) })

View File

@ -0,0 +1,19 @@
import coerceRecordTypes from '../modules/config/coerce-record-types';
import { registerAs } from '@nestjs/config';
import { z } from 'zod';
export const localSchema = z.object({
production: z.boolean(),
port: z.number().optional(),
});
export type LocalConfig = z.infer<typeof localSchema>;
export const localConfig = registerAs('local', () => {
const env = coerceRecordTypes(process.env);
const config: LocalConfig = localSchema.strict().parse({
production: env['PRODUCTION'],
port: env['PORT'],
});
return config;
});

View File

@ -0,0 +1,11 @@
import { clone, each } from 'lodash';
export default (raw: Record<string, any>): Record<string, string | number | boolean | undefined> => {
raw = clone(raw);
return each(raw, (value, key) => {
if (value === 'true') raw[key] = true;
if (value === 'false') raw[key] = false;
if (value === 'null') raw[key] = null;
if (!isNaN(Number(value))) raw[key] = Number(value);
});
};

View File

@ -0,0 +1,15 @@
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { localConfig } from '../../config/local.config';
@Module({
imports: [
ConfigModule.forRoot({
isGlobal: true,
expandVariables: true,
load: [localConfig],
}),
],
})
export class AppConfigModule {}

View File

@ -6,12 +6,16 @@
import { Logger } from '@nestjs/common'; import { Logger } from '@nestjs/common';
import { NestFactory } from '@nestjs/core'; import { NestFactory } from '@nestjs/core';
import { AppModule } from './app/app.module'; import { AppModule } from './app/app.module';
import { LocalConfig, localConfig } from './app/config/local.config';
async function bootstrap() { async function bootstrap() {
const app = await NestFactory.create(AppModule); const app = await NestFactory.create(AppModule);
const globalPrefix = 'api'; const globalPrefix = 'api';
app.setGlobalPrefix(globalPrefix); app.setGlobalPrefix(globalPrefix);
const port = process.env.PORT || 3000;
const config = app.get<LocalConfig>(localConfig.KEY);
const port = config.port || 3000;
await app.listen(port); await app.listen(port);
Logger.log(`🚀 Application is running on: http://localhost:${port}/${globalPrefix}`); Logger.log(`🚀 Application is running on: http://localhost:${port}/${globalPrefix}`);
} }

View File

@ -11,13 +11,16 @@
"private": true, "private": true,
"dependencies": { "dependencies": {
"@nestjs/common": "^10.0.2", "@nestjs/common": "^10.0.2",
"@nestjs/config": "^4.0.0",
"@nestjs/core": "^10.0.2", "@nestjs/core": "^10.0.2",
"@nestjs/platform-express": "^10.0.2", "@nestjs/platform-express": "^10.0.2",
"@nx/devkit": "20.4.1", "@nx/devkit": "20.4.1",
"axios": "^1.6.0", "axios": "^1.6.0",
"lodash": "^4.17.21",
"patch-package": "^8.0.0", "patch-package": "^8.0.0",
"reflect-metadata": "^0.1.13", "reflect-metadata": "^0.1.13",
"rxjs": "^7.8.0" "rxjs": "^7.8.0",
"zod": "^3.24.1"
}, },
"devDependencies": { "devDependencies": {
"@eslint/js": "^9.8.0", "@eslint/js": "^9.8.0",
@ -38,6 +41,7 @@
"@swc/core": "~1.5.7", "@swc/core": "~1.5.7",
"@swc/helpers": "~0.5.11", "@swc/helpers": "~0.5.11",
"@types/jest": "^29.5.12", "@types/jest": "^29.5.12",
"@types/lodash": "^4.17.15",
"@types/node": "~18.16.9", "@types/node": "~18.16.9",
"eslint": "^9.8.0", "eslint": "^9.8.0",
"eslint-config-prettier": "^9.0.0", "eslint-config-prettier": "^9.0.0",

41
pnpm-lock.yaml generated
View File

@ -8,6 +8,9 @@ dependencies:
'@nestjs/common': '@nestjs/common':
specifier: ^10.0.2 specifier: ^10.0.2
version: 10.4.15(reflect-metadata@0.1.14)(rxjs@7.8.1) version: 10.4.15(reflect-metadata@0.1.14)(rxjs@7.8.1)
'@nestjs/config':
specifier: ^4.0.0
version: 4.0.0(@nestjs/common@10.4.15)(rxjs@7.8.1)
'@nestjs/core': '@nestjs/core':
specifier: ^10.0.2 specifier: ^10.0.2
version: 10.4.15(@nestjs/common@10.4.15)(@nestjs/platform-express@10.4.15)(reflect-metadata@0.1.14)(rxjs@7.8.1) version: 10.4.15(@nestjs/common@10.4.15)(@nestjs/platform-express@10.4.15)(reflect-metadata@0.1.14)(rxjs@7.8.1)
@ -20,6 +23,9 @@ dependencies:
axios: axios:
specifier: ^1.6.0 specifier: ^1.6.0
version: 1.7.9 version: 1.7.9
lodash:
specifier: ^4.17.21
version: 4.17.21
patch-package: patch-package:
specifier: ^8.0.0 specifier: ^8.0.0
version: 8.0.0 version: 8.0.0
@ -29,6 +35,9 @@ dependencies:
rxjs: rxjs:
specifier: ^7.8.0 specifier: ^7.8.0
version: 7.8.1 version: 7.8.1
zod:
specifier: ^3.24.1
version: 3.24.1
devDependencies: devDependencies:
'@eslint/js': '@eslint/js':
@ -85,6 +94,9 @@ devDependencies:
'@types/jest': '@types/jest':
specifier: ^29.5.12 specifier: ^29.5.12
version: 29.5.14 version: 29.5.14
'@types/lodash':
specifier: ^4.17.15
version: 4.17.15
'@types/node': '@types/node':
specifier: ~18.16.9 specifier: ~18.16.9
version: 18.16.20 version: 18.16.20
@ -2310,6 +2322,19 @@ packages:
tslib: 2.8.1 tslib: 2.8.1
uid: 2.0.2 uid: 2.0.2
/@nestjs/config@4.0.0(@nestjs/common@10.4.15)(rxjs@7.8.1):
resolution: {integrity: sha512-hyhUMtVwlT+tavtPNyekl8iP0QTU1U6awKrgdOSxhMhp3TQMltx7hz2yqGTcARp+19zWPfgJudyxthuD3lPp/Q==}
peerDependencies:
'@nestjs/common': ^10.0.0 || ^11.0.0
rxjs: ^7.1.0
dependencies:
'@nestjs/common': 10.4.15(reflect-metadata@0.1.14)(rxjs@7.8.1)
dotenv: 16.4.7
dotenv-expand: 12.0.1
lodash: 4.17.21
rxjs: 7.8.1
dev: false
/@nestjs/core@10.4.15(@nestjs/common@10.4.15)(@nestjs/platform-express@10.4.15)(reflect-metadata@0.1.14)(rxjs@7.8.1): /@nestjs/core@10.4.15(@nestjs/common@10.4.15)(@nestjs/platform-express@10.4.15)(reflect-metadata@0.1.14)(rxjs@7.8.1):
resolution: {integrity: sha512-UBejmdiYwaH6fTsz2QFBlC1cJHM+3UDeLZN+CiP9I1fRv2KlBZsmozGLbV5eS1JAVWJB4T5N5yQ0gjN8ZvcS2w==} resolution: {integrity: sha512-UBejmdiYwaH6fTsz2QFBlC1cJHM+3UDeLZN+CiP9I1fRv2KlBZsmozGLbV5eS1JAVWJB4T5N5yQ0gjN8ZvcS2w==}
requiresBuild: true requiresBuild: true
@ -3425,6 +3450,10 @@ packages:
'@types/node': 18.16.20 '@types/node': 18.16.20
dev: true dev: true
/@types/lodash@4.17.15:
resolution: {integrity: sha512-w/P33JFeySuhN6JLkysYUK2gEmy9kHHFN7E8ro0tkfmlDOgxBDzWEZ/J8cWA+fHqFevpswDTFZnDx+R9lbL6xw==}
dev: true
/@types/mime@1.3.5: /@types/mime@1.3.5:
resolution: {integrity: sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==} resolution: {integrity: sha512-/pyBZWSLD2n0dcHE3hq8s8ZvcETHtEuF+3E7XVt0Ig2nvsVQXdghHVcEkIWjy9A0wKfTn97a/PSDYohKIlnP/w==}
dev: true dev: true
@ -5213,6 +5242,13 @@ packages:
dependencies: dependencies:
dotenv: 16.4.7 dotenv: 16.4.7
/dotenv-expand@12.0.1:
resolution: {integrity: sha512-LaKRbou8gt0RNID/9RoI+J2rvXsBRPMV7p+ElHlPhcSARbCPDYcYG2s1TIzAfWv4YSgyY5taidWzzs31lNV3yQ==}
engines: {node: '>=12'}
dependencies:
dotenv: 16.4.7
dev: false
/dotenv@16.4.7: /dotenv@16.4.7:
resolution: {integrity: sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==} resolution: {integrity: sha512-47qPchRCykZC03FhkYAhrvwU4xDBFIj1QPqaarj6mdM/hgUzfPHcpkHJOn3mJAufFeeAxAzeGsr5X0M4k6fLZQ==}
engines: {node: '>=12'} engines: {node: '>=12'}
@ -7371,7 +7407,6 @@ packages:
/lodash@4.17.21: /lodash@4.17.21:
resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==} resolution: {integrity: sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==}
dev: true
/log-symbols@4.1.0: /log-symbols@4.1.0:
resolution: {integrity: sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==} resolution: {integrity: sha512-8XPvpAA8uyhfteu8pIvQxpJZ7SYYdpUivZpGy6sFsBuKRY/7rQGavedeB8aK+Zkyq6upMFVL/9AW6vOYzfRyLg==}
@ -10512,3 +10547,7 @@ packages:
/zen-observable@0.8.15: /zen-observable@0.8.15:
resolution: {integrity: sha512-PQ2PC7R9rslx84ndNBZB/Dkv8V8fZEpk83RLgXtYd0fwUgEjseMn1Dgajh2x6S8QbZAFa9p2qVCEuYZNgve0dQ==} resolution: {integrity: sha512-PQ2PC7R9rslx84ndNBZB/Dkv8V8fZEpk83RLgXtYd0fwUgEjseMn1Dgajh2x6S8QbZAFa9p2qVCEuYZNgve0dQ==}
dev: true dev: true
/zod@3.24.1:
resolution: {integrity: sha512-muH7gBL9sI1nciMZV67X5fTKKBLtwpZ5VBp1vsOQzj1MhrBZ4wlVCm3gedKZWLp0Oyel8sIGfeiz54Su+OVT+A==}
dev: false