@tresdoce-nestjs-toolkit/commons NPM

Este módulo está pensada para ser utilizada en NestJS Starter, o cualquier proyecto que utilice una configuración centralizada, siguiendo la misma arquitectura del starter.

Glosario

📝 Requerimientos básicos

NestJS Starter
Node.js v18.17.0 or higher (Download)
YARN v1.22.18 or higher
NPM v9.6.7 or higher
NestJS v10.3.0 or higher (Documentación)

🛠️ Instalar dependencia

npm install -D @tresdoce-nestjs-toolkit/commons

yarn add -D @tresdoce-nestjs-toolkit/commons

👨‍💻 Uso

Eslint config

// .eslintrc.js

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

Jest config

// jest.config.ts

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

process.env.NODE_ENV = 'test';

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

module.exports = jestConfig;

Webpack config

Default Webpack Config

//./nest-cli.json
{
  "$schema": "https://json.schemastore.org/nest-cli",
  "collection": "@nestjs/schematics",
  "sourceRoot": "src",
  "compilerOptions": {
    "plugins": ["@nestjs/swagger"],
    "webpack": true,
    "webpackConfigPath": "./node_modules/@tresdoce-nestjs-toolkit/commons/dist-src/build-config/webpack.config.js"
  }
}

Custom Webpack Config

⚠️ El starter ya cuenta con una configuración para webpack, por lo que implementar una nueva configuración podría llegar a afectar el correcto funcionamiento del buildeado de la aplicación.

Para enviar una configuración custom al webpack de NestJS, se requiere crear un archivo webpack.config.js en el root del proyecto, y en el archivo nest-cli.json borrar la línea de webpackConfigPath que está dentro del compilerOptions, o bien dentro del archivo webpack.config.js escribir tu propia configuración.

//./webpack.config.js
const { buildConfig } = require('@tresdoce-nestjs-toolkit/commons');
module.exports = (options) => {
  const newConfig = {
    entry: './src/serverless.ts',
  };

  return buildConfig(newConfig);
};