Skip to content

Commit 57b17e9

Browse files
committed
docs: improve documents
1 parent d2c8961 commit 57b17e9

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ To synchronize the end-of-line of the git repository.
133133

134134
### Webpack
135135

136-
We overwrite the default `webpack.config.js` so that the production build can bundle all required libraries in `main.js`. For the configuration, we ignored a list of the nestjs-buildin library so that we could build it without error. If you need these libraries for your development, you can comment it in the lazy imports list.
136+
We overwrite the default `webpack.config.js` so that the production build can bundle all required libraries in `main.ts`. For the configuration, we ignored a list of the nestjs-buildin library so that we could build it without error. If you need these libraries for your development, you can comment it in the lazy imports list.
137137

138138
### Alias Path
139139

@@ -197,7 +197,7 @@ _Reference:_
197197

198198
### Pino Logger
199199

200-
We used [nestjs-pino](https://github.com/iamolegga/nestjs-pino) to auto-log every request metadata and response time. We also centralized Pino config in `app.config.ts` for `main.js` reuse it.
200+
We used [nestjs-pino](https://github.com/iamolegga/nestjs-pino) to auto-log every request metadata and response time. We also centralized Pino config in `app.config.ts` for `main.ts` reuse it.
201201

202202
### Swagger
203203

src/filter/validator-exception.filter.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import { FastifyReply } from 'fastify';
33
import { NormalException } from '@/exception/normal.exception';
44
import { ValidationError } from 'class-validator';
55

6-
// Re-format error response of class-validator
6+
// Re-format error response of class-validator to fit Google JSON style
77
@Catch(ValidationError)
88
export class ValidationExceptionFilter implements ExceptionFilter {
99
private readonly logger = new Logger(ValidationExceptionFilter.name);

src/interceptor/response.interceptor.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {
77
import { HttpSuccessResponse } from '@share/interfaces';
88
import { Observable, map } from 'rxjs';
99

10-
// Re-format all non-error response
10+
// Re-format all non-error response to fit Google JSON style
1111
@Injectable()
1212
export class ResponseInterceptor<T>
1313
implements NestInterceptor<T, HttpSuccessResponse<T>>

src/modules/app/index.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
export * from './dto';
21
export * from './app.config';
32
export * from './app.controller';
43
export * from './app.module';
54
export * from './app.service';
5+
export * from './dto';

0 commit comments

Comments
 (0)