Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4,584 changes: 4,009 additions & 575 deletions pnpm-lock.yaml

Large diffs are not rendered by default.

57 changes: 57 additions & 0 deletions template/nest-next/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# compiled output
/dist
/node_modules
/build

# Logs
logs
*.log
npm-debug.log*
pnpm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*

# OS
.DS_Store

# Tests
/coverage
/.nyc_output

# IDEs and editors
/.idea
.project
.classpath
.c9/
*.launch
.settings/
*.sublime-workspace

# IDE - VSCode
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# temp directory
.temp
.tmp

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
configs/config.json
4 changes: 4 additions & 0 deletions template/nest-next/.prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"singleQuote": true,
"trailingComma": "all"
}
98 changes: 98 additions & 0 deletions template/nest-next/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
<p align="center">
<a href="http://nestjs.com/" target="blank"><img src="https://nestjs.com/img/logo-small.svg" width="120" alt="Nest Logo" /></a>
</p>

[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456
[circleci-url]: https://circleci.com/gh/nestjs/nest

<p align="center">A progressive <a href="http://nodejs.org" target="_blank">Node.js</a> framework for building efficient and scalable server-side applications.</p>
<p align="center">
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/v/@nestjs/core.svg" alt="NPM Version" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/l/@nestjs/core.svg" alt="Package License" /></a>
<a href="https://www.npmjs.com/~nestjscore" target="_blank"><img src="https://img.shields.io/npm/dm/@nestjs/common.svg" alt="NPM Downloads" /></a>
<a href="https://circleci.com/gh/nestjs/nest" target="_blank"><img src="https://img.shields.io/circleci/build/github/nestjs/nest/master" alt="CircleCI" /></a>
<a href="https://discord.gg/G7Qnnhy" target="_blank"><img src="https://img.shields.io/badge/discord-online-brightgreen.svg" alt="Discord"/></a>
<a href="https://opencollective.com/nest#backer" target="_blank"><img src="https://opencollective.com/nest/backers/badge.svg" alt="Backers on Open Collective" /></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://opencollective.com/nest/sponsors/badge.svg" alt="Sponsors on Open Collective" /></a>
<a href="https://paypal.me/kamilmysliwiec" target="_blank"><img src="https://img.shields.io/badge/Donate-PayPal-ff3f59.svg" alt="Donate us"/></a>
<a href="https://opencollective.com/nest#sponsor" target="_blank"><img src="https://img.shields.io/badge/Support%20us-Open%20Collective-41B883.svg" alt="Support us"></a>
<a href="https://twitter.com/nestframework" target="_blank"><img src="https://img.shields.io/twitter/follow/nestframework.svg?style=social&label=Follow" alt="Follow us on Twitter"></a>
</p>
<!--[![Backers on Open Collective](https://opencollective.com/nest/backers/badge.svg)](https://opencollective.com/nest#backer)
[![Sponsors on Open Collective](https://opencollective.com/nest/sponsors/badge.svg)](https://opencollective.com/nest#sponsor)-->

## Description

[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.

## Project setup

```bash
$ pnpm install
```

## Compile and run the project

```bash
# development
$ pnpm run start

# watch mode
$ pnpm run start:dev

# production mode
$ pnpm run start:prod
```

## Run tests

```bash
# unit tests
$ pnpm run test

# e2e tests
$ pnpm run test:e2e

# test coverage
$ pnpm run test:cov
```

## Deployment

When you're ready to deploy your NestJS application to production, there are some key steps you can take to ensure it runs as efficiently as possible. Check out the [deployment documentation](https://docs.nestjs.com/deployment) for more information.

If you are looking for a cloud-based platform to deploy your NestJS application, check out [Mau](https://mau.nestjs.com), our official platform for deploying NestJS applications on AWS. Mau makes deployment straightforward and fast, requiring just a few simple steps:

```bash
$ pnpm install -g @nestjs/mau
$ mau deploy
```

With Mau, you can deploy your application in just a few clicks, allowing you to focus on building features rather than managing infrastructure.

## Resources

Check out a few resources that may come in handy when working with NestJS:

- Visit the [NestJS Documentation](https://docs.nestjs.com) to learn more about the framework.
- For questions and support, please visit our [Discord channel](https://discord.gg/G7Qnnhy).
- To dive deeper and get more hands-on experience, check out our official video [courses](https://courses.nestjs.com/).
- Deploy your application to AWS with the help of [NestJS Mau](https://mau.nestjs.com) in just a few clicks.
- Visualize your application graph and interact with the NestJS application in real-time using [NestJS Devtools](https://devtools.nestjs.com).
- Need help with your project (part-time to full-time)? Check out our official [enterprise support](https://enterprise.nestjs.com).
- To stay in the loop and get updates, follow us on [X](https://x.com/nestframework) and [LinkedIn](https://linkedin.com/company/nestjs).
- Looking for a job, or have a job to offer? Check out our official [Jobs board](https://jobs.nestjs.com).

## Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).

## Stay in touch

- Author - [Kamil Myśliwiec](https://twitter.com/kammysliwiec)
- Website - [https://nestjs.com](https://nestjs.com/)
- Twitter - [@nestframework](https://twitter.com/nestframework)

## License

Nest is [MIT licensed](https://github.com/nestjs/nest/blob/master/LICENSE).
9 changes: 9 additions & 0 deletions template/nest-next/configs/config.example.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"database":{
"host": "localhost",
"port": 3306,
"user": "root",
"password": "root",
"dbName": "tinypro"
}
}
36 changes: 36 additions & 0 deletions template/nest-next/eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// @ts-check
import eslint from '@eslint/js';
import eslintPluginPrettierRecommended from 'eslint-plugin-prettier/recommended';
import globals from 'globals';
import tseslint from 'typescript-eslint';

export default tseslint.config(
{
ignores: ['eslint.config.mjs'],
},
eslint.configs.recommended,
...tseslint.configs.recommendedTypeChecked,
eslintPluginPrettierRecommended,
{
languageOptions: {
globals: {
...globals.node,
...globals.jest,
},
sourceType: 'commonjs',
parserOptions: {
projectService: true,
tsconfigRootDir: import.meta.dirname,
},
},
},
{
rules: {
'@typescript-eslint/no-explicit-any': 'off',
'@typescript-eslint/no-floating-promises': 'warn',
'@typescript-eslint/no-unsafe-argument': 'warn',
"prettier/prettier": ["error", { endOfLine: "auto" }],
'@typescript-eslint/no-unsafe-call': 'off',
},
},
);
17 changes: 17 additions & 0 deletions template/nest-next/libs/configure/src/configure.module.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { Module } from '@nestjs/common';
import { ConfigModule } from '@nestjs/config';
import { loader } from './loader';
import { ConfigureService } from './configure.service';

@Module({
imports: [
ConfigModule.forRoot({
load: [loader],
isGlobal: true,
}),
],
controllers: [],
providers: [ConfigureService],
exports: [ConfigureService],
})
export class ConfigureModule {}
11 changes: 11 additions & 0 deletions template/nest-next/libs/configure/src/configure.service.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import { ConfigService, Path, PathValue } from '@nestjs/config';
import { Configure } from './configure/configure';
import { Injectable } from '@nestjs/common';

@Injectable()
export class ConfigureService {
constructor(private readonly configService: ConfigService<Configure, true>) {}
get<P extends Path<Configure>>(path: P): PathValue<Configure, P> {
return this.configService.get(path, { infer: true });
}
}
5 changes: 5 additions & 0 deletions template/nest-next/libs/configure/src/configure/configure.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
import { DatabaseConfig } from './database';

export type Configure = {
database: DatabaseConfig;
};
7 changes: 7 additions & 0 deletions template/nest-next/libs/configure/src/configure/database.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export type DatabaseConfig = {
host: string;
port: number;
user: string;
password: string;
dbName: string;
};
1 change: 1 addition & 0 deletions template/nest-next/libs/configure/src/configure/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
export * from './configure';
3 changes: 3 additions & 0 deletions template/nest-next/libs/configure/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export * from './configure.module';
export * from './configure';
export * from './configure.service';
6 changes: 6 additions & 0 deletions template/nest-next/libs/configure/src/loader.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import { readFileSync } from 'fs';
import { join } from 'path';

export const loader = () =>
// eslint-disable-next-line @typescript-eslint/no-unsafe-return
JSON.parse(readFileSync(join(__dirname, './config/config.json')).toString());
9 changes: 9 additions & 0 deletions template/nest-next/libs/configure/tsconfig.lib.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"declaration": true,
"outDir": "../../dist/libs/configure"
},
"include": ["src/**/*"],
"exclude": ["node_modules", "dist", "test", "**/*spec.ts"]
}
24 changes: 24 additions & 0 deletions template/nest-next/libs/shared/src/.generate/i18n.generated.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/* DO NOT EDIT, file generated by nestjs-i18n */

/* eslint-disable */
/* prettier-ignore */
import { Path } from "nestjs-i18n";
/* prettier-ignore */
export type I18nTranslations = {
"exception": {
"common": {
"INTERNAL_ERROR": string;
};
"permission": {
"NOT_FOUND": string;
};
};
"validation": {
"NOT_EMPTY": string;
"IS_ARRAY": string;
"NOT_EMPTY_HUMAN": string;
"TYPE_ERROR": string;
};
};
/* prettier-ignore */
export type I18nPath = Path<I18nTranslations>;
41 changes: 41 additions & 0 deletions template/nest-next/libs/shared/src/error.base.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
import { HttpStatus } from '@nestjs/common';
import { I18nPath } from './.generate/i18n.generated';

export type DomainErrorProps = {
message: I18nPath;
code: HttpStatus;
details?: unknown;
params?: Record<string, any>;
cause?: Error;
};

export class DomainError extends Error {
/**
* HTTP 状态码
* @type {HttpStatus}
*/
public readonly code: HttpStatus;
/**
* 错误信息
* @type {I18nPath}
*/
public readonly message: I18nPath;
/**
* 附加详情
* @type {unknown}
*/
public readonly details?: unknown;
/**
* 模板参数,用于格式化错误信息
* @type {Record<string, any>}
*/
public readonly args?: Record<string, any>;

constructor(props: DomainErrorProps) {
super(props.message, { cause: props.cause });
this.code = props.code;
this.message = props.message;
this.details = props.details;
this.args = props.params;
}
}
38 changes: 38 additions & 0 deletions template/nest-next/libs/shared/src/global-exception.filter.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
import {
ArgumentsHost,
Catch,
ExceptionFilter,
Injectable,
Logger,
} from '@nestjs/common';
import { DomainError } from './error.base';
import { I18nService } from 'nestjs-i18n';
import { Request, Response } from 'express';
import { I18nTranslations } from './.generate/i18n.generated';

@Catch(Error)
@Injectable()
export class GlobalExceptionFilter implements ExceptionFilter<Error> {
private readonly logger: Logger = new Logger(GlobalExceptionFilter.name);
constructor(private readonly i18n: I18nService<I18nTranslations>) {}
catch(exception: any, host: ArgumentsHost) {
this.logger.error(exception);
const ctx = host.switchToHttp();
const response: Response = ctx.getResponse();
const request: Request = ctx.getRequest();
const lang = request.headers['accept-language']?.split(',')[0] || 'enUS';
if (exception instanceof DomainError) {
const { code, message, details, args } = exception;
const translatedMessage = this.i18n.translate(message, { args, lang });
return response.status(code).json({
statusCode: code,
message: translatedMessage,
details,
});
}
return response.status(500).json({
statusCode: 500,
message: this.i18n.translate('exception.common.INTERNAL_ERROR', { lang }),
});
}
}
5 changes: 5 additions & 0 deletions template/nest-next/libs/shared/src/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export { DomainError } from './error.base';
export type { DomainErrorProps } from './error.base';
export { GlobalExceptionFilter } from './global-exception.filter';
export * from './.generate/i18n.generated';
export * from './pagination';
Loading