lint pretty --check
This commit is contained in:
parent
dd557c78f7
commit
6f571e05ca
|
@ -2,7 +2,7 @@ module.exports = {
|
||||||
parser: '@typescript-eslint/parser',
|
parser: '@typescript-eslint/parser',
|
||||||
parserOptions: {
|
parserOptions: {
|
||||||
project: 'tsconfig.json',
|
project: 'tsconfig.json',
|
||||||
tsconfigRootDir : __dirname,
|
tsconfigRootDir: __dirname,
|
||||||
sourceType: 'module',
|
sourceType: 'module',
|
||||||
},
|
},
|
||||||
plugins: ['@typescript-eslint/eslint-plugin'],
|
plugins: ['@typescript-eslint/eslint-plugin'],
|
||||||
|
|
|
@ -12,7 +12,7 @@ test:
|
||||||
stage: test
|
stage: test
|
||||||
image: docker/compose:latest
|
image: docker/compose:latest
|
||||||
variables:
|
variables:
|
||||||
DOCKER_TLS_CERTDIR: ""
|
DOCKER_TLS_CERTDIR: ''
|
||||||
services:
|
services:
|
||||||
- docker:dind
|
- docker:dind
|
||||||
script:
|
script:
|
||||||
|
@ -22,7 +22,7 @@ test:
|
||||||
- docker exec -t v3-auth-api sh -c "npm run test:integration:ci"
|
- docker exec -t v3-auth-api sh -c "npm run test:integration:ci"
|
||||||
coverage: /All files[^|]*\|[^|]*\s+([\d\.]+)/
|
coverage: /All files[^|]*\|[^|]*\s+([\d\.]+)/
|
||||||
rules:
|
rules:
|
||||||
- if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH || $CI_COMMIT_MESSAGE =~ /--check/ || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
- if: '$CI_MERGE_REQUEST_TARGET_BRANCH_NAME == $CI_DEFAULT_BRANCH || $CI_COMMIT_MESSAGE =~ /--check/ || $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
|
||||||
when: always
|
when: always
|
||||||
|
|
||||||
###############
|
###############
|
||||||
|
@ -33,7 +33,7 @@ build:
|
||||||
stage: build
|
stage: build
|
||||||
image: docker:20.10.22
|
image: docker:20.10.22
|
||||||
variables:
|
variables:
|
||||||
DOCKER_TLS_CERTDIR: ""
|
DOCKER_TLS_CERTDIR: ''
|
||||||
services:
|
services:
|
||||||
- docker:dind
|
- docker:dind
|
||||||
before_script:
|
before_script:
|
||||||
|
|
|
@ -0,0 +1,6 @@
|
||||||
|
node_modules
|
||||||
|
*.log*
|
||||||
|
.env
|
||||||
|
dist
|
||||||
|
coverage
|
||||||
|
.prettierrc.json
|
21
README.md
21
README.md
|
@ -14,7 +14,7 @@ A RabbitMQ instance is also required to send / receive messages when data has be
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
- copy `.env.dist` to `.env` :
|
- copy `.env.dist` to `.env` :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
cp .env.dist .env
|
cp .env.dist .env
|
||||||
|
@ -22,13 +22,13 @@ A RabbitMQ instance is also required to send / receive messages when data has be
|
||||||
|
|
||||||
Modify it if needed.
|
Modify it if needed.
|
||||||
|
|
||||||
- install the dependencies :
|
- install the dependencies :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
- start the containers :
|
- start the containers :
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker compose up -d
|
docker compose up -d
|
||||||
|
@ -150,7 +150,7 @@ For AuthZ, the app exposes the following [gRPC](https://grpc.io/) services :
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
In return, the service gives an authorization response :
|
In return, the service gives an authorization response :
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
|
@ -158,15 +158,14 @@ For AuthZ, the app exposes the following [gRPC](https://grpc.io/) services :
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## Messages
|
## Messages
|
||||||
|
|
||||||
Various RabbitMQ messages are sent for logging purpose.
|
Various RabbitMQ messages are sent for logging purpose.
|
||||||
|
|
||||||
## Tests
|
## Tests / ESLint / Prettier
|
||||||
|
|
||||||
Tests are run outside the container for ease of use (switching between different environments inside containers using prisma is complicated and error prone).
|
Tests are run outside the container for ease of use (switching between different environments inside containers using prisma is complicated and error prone).
|
||||||
The integration tests use a dedicated database (see *db-test* section of *docker-compose.yml*).
|
The integration tests use a dedicated database (see _db-test_ section of _docker-compose.yml_).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# run all tests (unit + integration)
|
# run all tests (unit + integration)
|
||||||
|
@ -180,6 +179,12 @@ npm run test:integration
|
||||||
|
|
||||||
# coverage
|
# coverage
|
||||||
npm run test:cov
|
npm run test:cov
|
||||||
|
|
||||||
|
# ESLint
|
||||||
|
npm run lint
|
||||||
|
|
||||||
|
# Prettier
|
||||||
|
npm run pretty
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
|
@ -25,5 +25,7 @@ RUN npm run build
|
||||||
# Run unit tests
|
# Run unit tests
|
||||||
RUN npm run test:unit:ci
|
RUN npm run test:unit:ci
|
||||||
|
|
||||||
# Start the server
|
# ESLint / Prettier
|
||||||
CMD [ "node", "dist/main.js" ]
|
RUN npm run lint:check
|
||||||
|
RUN npm run pretty:check
|
||||||
|
|
||||||
|
|
|
@ -14,6 +14,9 @@
|
||||||
"start:debug": "nest start --debug --watch",
|
"start:debug": "nest start --debug --watch",
|
||||||
"start:prod": "node dist/main",
|
"start:prod": "node dist/main",
|
||||||
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
|
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
|
||||||
|
"lint:check": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix-dry-run --ignore-path .gitignore",
|
||||||
|
"pretty:check": "./node_modules/.bin/prettier --check .",
|
||||||
|
"pretty": "./node_modules/.bin/prettier --write .",
|
||||||
"test": "npm run migrate:test && dotenv -e .env.test jest",
|
"test": "npm run migrate:test && dotenv -e .env.test jest",
|
||||||
"test:unit": "jest --testPathPattern 'tests/unit/' --verbose",
|
"test:unit": "jest --testPathPattern 'tests/unit/' --verbose",
|
||||||
"test:unit:ci": "jest --testPathPattern 'tests/unit/' --coverage",
|
"test:unit:ci": "jest --testPathPattern 'tests/unit/' --coverage",
|
||||||
|
|
Loading…
Reference in New Issue