From fcf32cc3cc0d92c907a02e69bfc54fab14646496 Mon Sep 17 00:00:00 2001 From: Damien Arrachequesne Date: Fri, 25 Nov 2022 01:00:25 +0100 Subject: [PATCH] docs: add example with NestJS --- examples/single-server-nestjs/.eslintrc.js | 25 +++++++ examples/single-server-nestjs/.gitignore | 35 +++++++++ examples/single-server-nestjs/.prettierrc | 4 + examples/single-server-nestjs/README.md | 73 +++++++++++++++++++ examples/single-server-nestjs/nest-cli.json | 5 ++ examples/single-server-nestjs/package.json | 73 +++++++++++++++++++ .../src/app.controller.spec.ts | 22 ++++++ .../src/app.controller.ts | 12 +++ .../single-server-nestjs/src/app.module.ts | 11 +++ .../single-server-nestjs/src/app.service.ts | 8 ++ .../src/events.gateway.ts | 20 +++++ .../single-server-nestjs/src/events.module.ts | 7 ++ examples/single-server-nestjs/src/main.ts | 8 ++ .../single-server-nestjs/test/app.e2e-spec.ts | 24 ++++++ .../single-server-nestjs/test/jest-e2e.json | 9 +++ .../single-server-nestjs/tsconfig.build.json | 4 + examples/single-server-nestjs/tsconfig.json | 21 ++++++ 17 files changed, 361 insertions(+) create mode 100644 examples/single-server-nestjs/.eslintrc.js create mode 100644 examples/single-server-nestjs/.gitignore create mode 100644 examples/single-server-nestjs/.prettierrc create mode 100644 examples/single-server-nestjs/README.md create mode 100644 examples/single-server-nestjs/nest-cli.json create mode 100644 examples/single-server-nestjs/package.json create mode 100644 examples/single-server-nestjs/src/app.controller.spec.ts create mode 100644 examples/single-server-nestjs/src/app.controller.ts create mode 100644 examples/single-server-nestjs/src/app.module.ts create mode 100644 examples/single-server-nestjs/src/app.service.ts create mode 100644 examples/single-server-nestjs/src/events.gateway.ts create mode 100644 examples/single-server-nestjs/src/events.module.ts create mode 100644 examples/single-server-nestjs/src/main.ts create mode 100644 examples/single-server-nestjs/test/app.e2e-spec.ts create mode 100644 examples/single-server-nestjs/test/jest-e2e.json create mode 100644 examples/single-server-nestjs/tsconfig.build.json create mode 100644 examples/single-server-nestjs/tsconfig.json diff --git a/examples/single-server-nestjs/.eslintrc.js b/examples/single-server-nestjs/.eslintrc.js new file mode 100644 index 0000000..8f5aedb --- /dev/null +++ b/examples/single-server-nestjs/.eslintrc.js @@ -0,0 +1,25 @@ +module.exports = { + parser: '@typescript-eslint/parser', + parserOptions: { + project: 'tsconfig.json', + tsconfigRootDir : __dirname, + sourceType: 'module', + }, + plugins: ['@typescript-eslint/eslint-plugin'], + extends: [ + 'plugin:@typescript-eslint/recommended', + 'plugin:prettier/recommended', + ], + root: true, + env: { + node: true, + jest: true, + }, + ignorePatterns: ['.eslintrc.js'], + rules: { + '@typescript-eslint/interface-name-prefix': 'off', + '@typescript-eslint/explicit-function-return-type': 'off', + '@typescript-eslint/explicit-module-boundary-types': 'off', + '@typescript-eslint/no-explicit-any': 'off', + }, +}; diff --git a/examples/single-server-nestjs/.gitignore b/examples/single-server-nestjs/.gitignore new file mode 100644 index 0000000..22f55ad --- /dev/null +++ b/examples/single-server-nestjs/.gitignore @@ -0,0 +1,35 @@ +# compiled output +/dist +/node_modules + +# 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 \ No newline at end of file diff --git a/examples/single-server-nestjs/.prettierrc b/examples/single-server-nestjs/.prettierrc new file mode 100644 index 0000000..dcb7279 --- /dev/null +++ b/examples/single-server-nestjs/.prettierrc @@ -0,0 +1,4 @@ +{ + "singleQuote": true, + "trailingComma": "all" +} \ No newline at end of file diff --git a/examples/single-server-nestjs/README.md b/examples/single-server-nestjs/README.md new file mode 100644 index 0000000..00a13b1 --- /dev/null +++ b/examples/single-server-nestjs/README.md @@ -0,0 +1,73 @@ +

+ Nest Logo +

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

A progressive Node.js framework for building efficient and scalable server-side applications.

+

+NPM Version +Package License +NPM Downloads +CircleCI +Coverage +Discord +Backers on Open Collective +Sponsors on Open Collective + + Support us + +

+ + +## Description + +[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository. + +## Installation + +```bash +$ npm install +``` + +## Running the app + +```bash +# development +$ npm run start + +# watch mode +$ npm run start:dev + +# production mode +$ npm run start:prod +``` + +## Test + +```bash +# unit tests +$ npm run test + +# e2e tests +$ npm run test:e2e + +# test coverage +$ npm run test:cov +``` + +## 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://kamilmysliwiec.com) +- Website - [https://nestjs.com](https://nestjs.com/) +- Twitter - [@nestframework](https://twitter.com/nestframework) + +## License + +Nest is [MIT licensed](LICENSE). diff --git a/examples/single-server-nestjs/nest-cli.json b/examples/single-server-nestjs/nest-cli.json new file mode 100644 index 0000000..2566481 --- /dev/null +++ b/examples/single-server-nestjs/nest-cli.json @@ -0,0 +1,5 @@ +{ + "$schema": "https://json.schemastore.org/nest-cli", + "collection": "@nestjs/schematics", + "sourceRoot": "src" +} diff --git a/examples/single-server-nestjs/package.json b/examples/single-server-nestjs/package.json new file mode 100644 index 0000000..1b8a92f --- /dev/null +++ b/examples/single-server-nestjs/package.json @@ -0,0 +1,73 @@ +{ + "name": "single-server-nestjs", + "version": "0.0.1", + "description": "", + "author": "", + "private": true, + "license": "UNLICENSED", + "scripts": { + "prebuild": "rimraf dist", + "build": "nest build", + "format": "prettier --write \"src/**/*.ts\" \"test/**/*.ts\"", + "start": "nest start", + "start:dev": "nest start --watch", + "start:debug": "nest start --debug --watch", + "start:prod": "node dist/main", + "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix", + "test": "jest", + "test:watch": "jest --watch", + "test:cov": "jest --coverage", + "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand", + "test:e2e": "jest --config ./test/jest-e2e.json" + }, + "dependencies": { + "@nestjs/common": "^9.0.0", + "@nestjs/core": "^9.0.0", + "@nestjs/platform-express": "^9.0.0", + "@nestjs/platform-socket.io": "^9.2.0", + "@nestjs/websockets": "^9.2.0", + "reflect-metadata": "^0.1.13", + "rimraf": "^3.0.2", + "rxjs": "^7.2.0" + }, + "devDependencies": { + "@nestjs/cli": "^9.0.0", + "@nestjs/schematics": "^9.0.0", + "@nestjs/testing": "^9.0.0", + "@types/express": "^4.17.13", + "@types/jest": "28.1.8", + "@types/node": "^16.0.0", + "@types/supertest": "^2.0.11", + "@typescript-eslint/eslint-plugin": "^5.0.0", + "@typescript-eslint/parser": "^5.0.0", + "eslint": "^8.0.1", + "eslint-config-prettier": "^8.3.0", + "eslint-plugin-prettier": "^4.0.0", + "jest": "28.1.3", + "prettier": "^2.3.2", + "source-map-support": "^0.5.20", + "supertest": "^6.1.3", + "ts-jest": "28.0.8", + "ts-loader": "^9.2.3", + "ts-node": "^10.0.0", + "tsconfig-paths": "4.1.0", + "typescript": "^4.7.4" + }, + "jest": { + "moduleFileExtensions": [ + "js", + "json", + "ts" + ], + "rootDir": "src", + "testRegex": ".*\\.spec\\.ts$", + "transform": { + "^.+\\.(t|j)s$": "ts-jest" + }, + "collectCoverageFrom": [ + "**/*.(t|j)s" + ], + "coverageDirectory": "../coverage", + "testEnvironment": "node" + } +} diff --git a/examples/single-server-nestjs/src/app.controller.spec.ts b/examples/single-server-nestjs/src/app.controller.spec.ts new file mode 100644 index 0000000..d22f389 --- /dev/null +++ b/examples/single-server-nestjs/src/app.controller.spec.ts @@ -0,0 +1,22 @@ +import { Test, TestingModule } from '@nestjs/testing'; +import { AppController } from './app.controller'; +import { AppService } from './app.service'; + +describe('AppController', () => { + let appController: AppController; + + beforeEach(async () => { + const app: TestingModule = await Test.createTestingModule({ + controllers: [AppController], + providers: [AppService], + }).compile(); + + appController = app.get(AppController); + }); + + describe('root', () => { + it('should return "Hello World!"', () => { + expect(appController.getHello()).toBe('Hello World!'); + }); + }); +}); diff --git a/examples/single-server-nestjs/src/app.controller.ts b/examples/single-server-nestjs/src/app.controller.ts new file mode 100644 index 0000000..cce879e --- /dev/null +++ b/examples/single-server-nestjs/src/app.controller.ts @@ -0,0 +1,12 @@ +import { Controller, Get } from '@nestjs/common'; +import { AppService } from './app.service'; + +@Controller() +export class AppController { + constructor(private readonly appService: AppService) {} + + @Get() + getHello(): string { + return this.appService.getHello(); + } +} diff --git a/examples/single-server-nestjs/src/app.module.ts b/examples/single-server-nestjs/src/app.module.ts new file mode 100644 index 0000000..3a952d8 --- /dev/null +++ b/examples/single-server-nestjs/src/app.module.ts @@ -0,0 +1,11 @@ +import { Module } from '@nestjs/common'; +import { AppController } from './app.controller'; +import { AppService } from './app.service'; +import { EventsModule } from './events.module'; + +@Module({ + imports: [EventsModule], + controllers: [AppController], + providers: [AppService], +}) +export class AppModule {} diff --git a/examples/single-server-nestjs/src/app.service.ts b/examples/single-server-nestjs/src/app.service.ts new file mode 100644 index 0000000..927d7cc --- /dev/null +++ b/examples/single-server-nestjs/src/app.service.ts @@ -0,0 +1,8 @@ +import { Injectable } from '@nestjs/common'; + +@Injectable() +export class AppService { + getHello(): string { + return 'Hello World!'; + } +} diff --git a/examples/single-server-nestjs/src/events.gateway.ts b/examples/single-server-nestjs/src/events.gateway.ts new file mode 100644 index 0000000..30c9d26 --- /dev/null +++ b/examples/single-server-nestjs/src/events.gateway.ts @@ -0,0 +1,20 @@ +import { WebSocketGateway, WebSocketServer } from '@nestjs/websockets'; +import { Server } from 'socket.io'; +import { instrument } from '../../../dist'; + +@WebSocketGateway({ + cors: { + origin: '*', + }, +}) +export class EventsGateway { + @WebSocketServer() + server: Server; + + afterInit() { + // @ts-ignore + instrument(this.server, { + auth: false, + }); + } +} diff --git a/examples/single-server-nestjs/src/events.module.ts b/examples/single-server-nestjs/src/events.module.ts new file mode 100644 index 0000000..2b2d1cb --- /dev/null +++ b/examples/single-server-nestjs/src/events.module.ts @@ -0,0 +1,7 @@ +import { Module } from '@nestjs/common'; +import { EventsGateway } from './events.gateway'; + +@Module({ + providers: [EventsGateway], +}) +export class EventsModule {} diff --git a/examples/single-server-nestjs/src/main.ts b/examples/single-server-nestjs/src/main.ts new file mode 100644 index 0000000..13cad38 --- /dev/null +++ b/examples/single-server-nestjs/src/main.ts @@ -0,0 +1,8 @@ +import { NestFactory } from '@nestjs/core'; +import { AppModule } from './app.module'; + +async function bootstrap() { + const app = await NestFactory.create(AppModule); + await app.listen(3000); +} +bootstrap(); diff --git a/examples/single-server-nestjs/test/app.e2e-spec.ts b/examples/single-server-nestjs/test/app.e2e-spec.ts new file mode 100644 index 0000000..50cda62 --- /dev/null +++ b/examples/single-server-nestjs/test/app.e2e-spec.ts @@ -0,0 +1,24 @@ +import { Test, TestingModule } from '@nestjs/testing'; +import { INestApplication } from '@nestjs/common'; +import * as request from 'supertest'; +import { AppModule } from './../src/app.module'; + +describe('AppController (e2e)', () => { + let app: INestApplication; + + beforeEach(async () => { + const moduleFixture: TestingModule = await Test.createTestingModule({ + imports: [AppModule], + }).compile(); + + app = moduleFixture.createNestApplication(); + await app.init(); + }); + + it('/ (GET)', () => { + return request(app.getHttpServer()) + .get('/') + .expect(200) + .expect('Hello World!'); + }); +}); diff --git a/examples/single-server-nestjs/test/jest-e2e.json b/examples/single-server-nestjs/test/jest-e2e.json new file mode 100644 index 0000000..e9d912f --- /dev/null +++ b/examples/single-server-nestjs/test/jest-e2e.json @@ -0,0 +1,9 @@ +{ + "moduleFileExtensions": ["js", "json", "ts"], + "rootDir": ".", + "testEnvironment": "node", + "testRegex": ".e2e-spec.ts$", + "transform": { + "^.+\\.(t|j)s$": "ts-jest" + } +} diff --git a/examples/single-server-nestjs/tsconfig.build.json b/examples/single-server-nestjs/tsconfig.build.json new file mode 100644 index 0000000..64f86c6 --- /dev/null +++ b/examples/single-server-nestjs/tsconfig.build.json @@ -0,0 +1,4 @@ +{ + "extends": "./tsconfig.json", + "exclude": ["node_modules", "test", "dist", "**/*spec.ts"] +} diff --git a/examples/single-server-nestjs/tsconfig.json b/examples/single-server-nestjs/tsconfig.json new file mode 100644 index 0000000..adb614c --- /dev/null +++ b/examples/single-server-nestjs/tsconfig.json @@ -0,0 +1,21 @@ +{ + "compilerOptions": { + "module": "commonjs", + "declaration": true, + "removeComments": true, + "emitDecoratorMetadata": true, + "experimentalDecorators": true, + "allowSyntheticDefaultImports": true, + "target": "es2017", + "sourceMap": true, + "outDir": "./dist", + "baseUrl": "./", + "incremental": true, + "skipLibCheck": true, + "strictNullChecks": false, + "noImplicitAny": false, + "strictBindCallApply": false, + "forceConsistentCasingInFileNames": false, + "noFallthroughCasesInSwitch": false + } +}