Esta dependencia está pensada para ser utilizada en NestJs Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

• 🥳 Demo
• 📝 Requerimientos básicos
• 🛠️ Instalar dependencia
• ⚙️ Configuración
• 📤 Commits
• 📄 Changelog
• 📜 License MIT

📝 Requerimientos básicos

• NestJs Starter
• Node.js v14.15.4 or higher (Download)
• NPM v6.14.10 or higher
• NestJS v8.2.0 or higher (Documentación)

🛠️ Instalar dependencia

npm install @tresdoce/nestjs-commons

⚙️ Configuración

Eslint

// .eslintrc.js

const config = require('@tresdoce/nestjs-commons');
module.exports = config.eslintConfig();

Jest

// jest.config.ts

import { jestConfig } from '@tresdoce/nestjs-commons';
import * as dotenv from 'dotenv';

process.env.NODE_ENV = 'test';

dotenv.config({
  path: '.env.test',
});

module.exports = jestConfig;

Webpack

// webpack.config.js

const config = require('@tresdoce/nestjs-commons');
module.exports = (options) => config.buildConfig(options);

HTTPS

Se requiere crear el certificado y la privkey (llave privada), Podés encontrar más info acá.

// ./src/main.ts

import * as path from 'path';
import { readHttpsCertificate } from '@tresdoce/nestjs-commons'

const crtPath = path.resolve(__dirname, './ssl/fullchain.crt');
const keyPath = path.resolve(__dirname, './ssl/privkey.key');

async function bootstrap() {
    const app = await NestFactory.create(AppModule, {
        httpsOptions: readHttpsCertificate(crtPath, keyPath),
        logger: new Logger(),
    });

    ...

    await app.listen(port, () => {
        console.log(`App running on: http://localhost:${port}`);
    });
}

bootstrap();

📤 Commits

Para los mensajes de commits se toma como referencia conventional commits.

<type>[optional scope]: <description>

[optional body]

[optional footer]

• type: chore, docs, feat, fix, refactor (más comunes)
• scope: indica la página, componente, funcionalidad
• description: comienza en minúsculas y no debe superar los 72 caracteres.

📄 Changelog

All notable changes to this package will be documented in Changelog file.