@newtral/nestjs-logger

Install

npm install @newtral/nestjs-logger

Usage

Pino logger wrapper to be used in conjunction with NestJS

import { LoggerModule, LoggerService } from '@newtral/nestjs-logger';
import { Injectable, Module, OnModuleInit } from '@nestjs/common';

@Injectable()
class AppService implements OnModuleInit {
  private readonly logger = this.loggerService.getLogger(module);

  constructor(private readonly loggerService: LoggerService) {}

  onModuleInit(): void {
    this.logger.info('app service ready!');
    this.logger.warn({ foo: 'bar' }, 'logging with metadata and formatters  %s', ':)');
  }
}

@Module({
  imports: [
    LoggerModule.forRoot({
      // Default log verbosity level for every logger
      // Can be overridden by the .getLogger() method
      logLevel: 'info',
      // Enable pretty print. The log format is json by default
      prettyPrint: true
    })
  ],
  providers: [AppService]
})
class AppModule {}

Development

The project use husky and lint-staged for linting and fixing possible errors on source code before commit

Git hooks scripts are installed after running npm install the first time

npm run build:commonjs

Compile typescript files from the src folder inside the lib folder

npm run build:esm

Compile typescript files from the src folder inside the esm folder using es modules

npm run build

Concurrently run both build:commonjs and build:esm

npm run clean

Remove the following directories/files

• lib
• esm
• reports

npm test

Run tests files inside the tests folder that matches the following patterns. Exit with code > 0 on error

• *.test.ts
• *.spec.ts

npm run cover

The same as npm test and generates coverages reports in reports/coverage. Exit with code > 0 on error

npm run lint

Check eslint errors according to .eslintrc

npm run lint:fix

Run npm run lint applying fixes and run prettier on every typescript file

npm run health

Check for:

• Build errors
• Tests failures
• Lint errors

npm run ci

Run test and generate every possible report. Do not exit with error code > 0 if the tests fail. It generates a report file instead

• reports/lint-checkstyle.xml Lint report in chackstyle format
• reports/test-results.xml Test report in xUnit format
• reports/coverage/clover.xml Coverage report in clover format
• reports/coverage/cobertura-coverage.xml Coverage report in cobertura format
• reports/coverage/lcov.info Coverage report in lcov
• reports/coverage/index.html Coverage report in html

npm run release

• Bump package.json version accordingly to the commit messages
• Generate changelog for the new version from the commit messages
• Commit package.json and CHANGELOG.md with the new changes
• Create a git tag with the new version
• You'll need to execute git push --follow-tags origin master after generating a release