Update Project

Author: henriqueleite42

.env.docker

@@ -1,8 +1,3 @@
 NODE_ENV=dev
 
 PORT=3000
-
-POSTGRES_USER=dev_db
-POSTGRES_PASSWORD=123
-POSTGRES_HOST=db
-POSTGRES_DATABSE=dev_db

.eslintrc.json

@@ -1,11 +1,5 @@
 {
 	"root": true,
-	"parser": "@typescript-eslint/parser",
-	"parserOptions": {
-		"project": "tsconfig.json",
-		"sourceType": "module"
-	},
-	"plugins": ["import-helpers"],
 	"extends": [
 		"@techmmunity/eslint-config/common",
 		"@techmmunity/eslint-config/typescript",

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,6 @@
 ## What this PR introduces?
 
-<!-- Please, includes adescription of this pull request -->
+<!-- Please, includes a description of this pull request -->
 
 ## PR Checklist
 
@@ -12,7 +12,7 @@ Please check if your PR fulfills the following requirements:
 - [ ] Swagger Docs for all the possible requests and responses have been added / updated
 - [ ] Mocks fot the database have been added / updated
 - [ ] Lib of the service have been updated
-- [ ] Lib package.json version have been increased and follow semantiic versioning
+- [ ] Lib package.json version have been increased and follow semantic versioning
 
 ## PR Type
 

.github/workflows/tests.yml

@@ -14,31 +14,16 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Add SSH Key
-        uses: webfactory/ssh-agent@v0.5.2
-        with:
-          ssh-private-key: ${{ secrets.CORE_REPOSITORY_SSH_KEY }}
-
-      - name: Clone Core Repository
-        run: |
-          git clone git@github.com:techmmunity/core.git
-          mv core/src src/core
-          rm -rf core
-
       - name: Install Dependencies
         run: |
           yarn
 
-      - name: Test TypeScript Syntax
+      - name: Run Tests
         run: |
-          yarn temp:test-tsc
-
-      # - name: Run Tests
-      #   run: |
-      #     yarn test:cov
+          yarn test:cov
 
-      # - name: Colect Coverage
-      #   if: github.event_name == 'push' && github.ref == 'refs/heads/master'
-      #   uses: coverallsapp/github-action@v1.1.2
-      #   with:
-      #     github-token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Colect Coverage
+        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+        uses: coverallsapp/github-action@v1.1.2
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}

.nvmrc

@@ -1 +1 @@
-14
+v16.13.2

.vscode/extensions.json

@@ -1,13 +1,3 @@
 {
-	"recommendations": [
-		"editorconfig.editorconfig",
-		"irongeek.vscode-env",
-		"dbaeumer.vscode-eslint",
-		"eamodio.gitlens",
-		"bierner.markdown-preview-github-styles",
-		"pkief.material-icon-theme",
-		"esbenp.prettier-vscode",
-		"gruntfuggly.todo-tree",
-		"shardulm94.trailing-spaces"
-	]
+	"recommendations": ["techmmunity.extensions", "techmmunity.keymap"]
 }

.vscode/settings.json

@@ -1,12 +1,25 @@
 {
 	// ================== Editor General Config =====================
 
+	// Defines Prettier as Default Formatter
+	"editor.defaultFormatter": "esbenp.prettier-vscode",
+
+	// Add a vertical line on the 80 characters limit
+	"editor.rulers": [80],
+
 	// Define Tab Size = 2 Spaces (Half of the Default Size)
 	"editor.tabSize": 2,
 
 	// Disable Tab To Space Conversion
 	"editor.insertSpaces": false,
 
+	// Disable Identation Detection,
+	// Because All The Indentations MUST BE
+	// Tabs With 2 Spaces (ﾉ °益°)ﾉ 彡 ┻━┻
+	// Setted to true because some
+	// OS projects use 4 spaces ou 2 tabs, etc
+	"editor.detectIndentation": true,
+
 	// Config Default End Of Line Formatting
 	"files.eol": "\n",
 
@@ -18,53 +31,40 @@
 		"source.fixAll.eslint": true
 	},
 
+	// Icons
+	"workbench.iconTheme": "material-icon-theme",
+
 	// Color of Comments
 	"editor.tokenColorCustomizations": {
 		"comments": "#00a0eb"
 	},
 
 	// Make VSCode understand this files as files of this languages
 	"files.associations": {
+		".sequelizerc": "javascript",
 		".prettierignore": "ignore",
 		".lintstagedrc": "json",
 		".env.*": "env"
 	},
-	"material-icon-theme.languages.associations": {
-		"env": "tune"
-	},
 
 	// ======================= Formatters ===========================
 
+	// Disable prettier on files that conclict with eslint
 	"[javascript]": {
-		"editor.defaultFormatter": "dbaeumer.vscode-eslint"
+		"editor.defaultFormatter": null
 	},
 	"[typescript]": {
-		"editor.defaultFormatter": "dbaeumer.vscode-eslint"
+		"editor.defaultFormatter": null
 	},
 	"[javascriptreact]": {
-		"editor.defaultFormatter": "dbaeumer.vscode-eslint"
+		"editor.defaultFormatter": null
 	},
 	"[typescriptreact]": {
-		"editor.defaultFormatter": "dbaeumer.vscode-eslint"
+		"editor.defaultFormatter": null
 	},
 
 	// ================ Languages General Config ====================
 
-	// TypeScript
-	"typescript.updateImportsOnFileMove.enabled": "always",
-	"typescript.tsserver.log": "verbose",
-	"typescript.suggest.autoImports": true,
-	// JavaScript
-	"javascript.updateImportsOnFileMove.enabled": "always",
-	"javascript.suggest.autoImports": true,
-
-	// =========== Plugins & Extensions General Config ===============
-
-	// GitLens
-	"gitlens.codeLens.recentChange.enabled": false,
-	"gitlens.codeLens.authors.enabled": true,
-	"gitlens.codeLens.enabled": false,
-
 	// Eslint
 	"eslint.packageManager": "yarn",
 	"eslint.validate": [
@@ -81,7 +81,8 @@
 		"redux": "redux-actions",
 		"modules": "generator",
 		"entities": "class",
-		"migrations": "database"
+		"migrations": "database",
+		"@helpers": "utils"
 	},
 	"material-icon-theme.files.associations": {
 		"*.controller.ts": "nest-controller",
@@ -96,14 +97,15 @@
 		"*.interceptor.ts": "nest-guard",
 		"*.resolver.ts": "graphql",
 		"*.input.ts": "graphql",
-		"*.return.ts": "graphql",
-		"docker-compose.hmg.yml": "docker",
-		".env.hmg": "tune",
-		".env.docker": "tune"
+		"*.return.ts": "graphql"
+	},
+	"material-icon-theme.languages.associations": {
+		"env": "tune"
 	},
 
 	// TODO Tree
 	"todo-tree.regex.regex": "(//|#|<!--|;|/\\*|^|^\\s*(-|\\d+.))\\s*($TAGS)",
 	"todo-tree.general.tags": ["BUG", "HACK", "FIXME", "TODO", "[ ]"],
-	"todo-tree.tree.showScanModeButton": false
+	"todo-tree.tree.showScanModeButton": false,
+	"cSpell.words": ["nestjs", "techmmunity"]
 }

FAQ.md

@@ -16,16 +16,16 @@ yarn docker
 ### How do I create a new migration?
 
 - Run `yarn docker` to update your local database
-- Code the new entity (Look to the *.entity.ts files for some examples) or make the changes in an already existent entity
+- Code the new entity (Look to the \*.entity.ts files for some examples) or make the changes in an already existent entity
 - In another terminal, run `yarn docker db` and keep it running
 - Run `yarn migration:generate <MIGRATION_NAME>`
 - Kill the "`yarn docker db`" terminal
 
 **WARNING:** Always check your migrations! Don't trust, verify!
 
-## Enviroment Variables
+## Environment Variables
 
-### How to add a new enviroment variable?
+### How to add a new environment variable?
 
 - Update the `src/types/env.d.ts` with the new variable (all variables must have the `string` type)
 - Add the new env var in to `.env.docker` file (env vars with sensitive content **MUST** have no value, just the key or an example non-real value)
@@ -70,5 +70,5 @@ yarn docker
 - Delete the `src/<API_VERSION>/api/<ENTITY_NAME>/<ENTITY_NAME>.service.spec.ts` file
 - Add `@ApiTag` decorator in the controller of the new entity
 - Change the base url of the controller of the new entity to contain the api version (ApiConfig.version)
-- Save the file of the controller of the new entity to prettier automatilly format the file
-- Save the file of the module of the new entity to prettier automatilly format the file
+- Save the file of the controller of the new entity to prettier automatically format the file
+- Save the file of the module of the new entity to prettier automatically format the file

SETUP.md

@@ -1,11 +1,11 @@
 # Setup Project Details
 
-## Enviroment config
+## Environment config
 
 - [Install yarn](https://classic.yarnpkg.com/en/docs/install/#debian-stable)
 - [Install docker](https://docs.docker.com/engine/install/)
 - [Install docker-compose](https://docs.docker.com/compose/install/)
-- [Do post-instalation docker steps](https://docs.docker.com/engine/install/linux-postinstall/)
+- [Do post-installation docker steps](https://docs.docker.com/engine/install/linux-postinstall/)
 - [Install VSCode](https://code.visualstudio.com/Download)
 - Install **ALL** the extensions recommended in `.vscode/extensions.json`
 - **If the changes are not applied automatically** add the content of `.vscode/settings.json` in your personal settings.json

jest.config.js

@@ -1,3 +1,6 @@
+/* eslint-disable multiline-comment-style */
+/* eslint-disable capitalized-comments */
+
 module.exports = {
 	moduleFileExtensions: ["js", "json", "ts"],
 	rootDir: "src",
@@ -16,14 +19,12 @@ module.exports = {
 	testEnvironment: "node",
 	moduleDirectories: ["node_modules", "src"],
 	resetMocks: true,
-	/*
-	 * CoverageThreshold: {
-	 * 	global: {
-	 * 		branches: 100,
-	 * 		functions: 100,
-	 * 		lines: 100,
-	 * 		statements: 100,
-	 * 	},
-	 * },
-	 */
+	// coverageThreshold: {
+	// 	global: {
+	// 		branches: 100,
+	// 		functions: 100,
+	// 		lines: 100,
+	// 		statements: 100,
+	// 	},
+	// },
 };