Merge pull request #7 from afteracademy/formatting

Formatting

Author: janishar

.eslintignore

@@ -0,0 +1,8 @@
+.vscode/ 
+
+node_modules/
+
+# Build products
+build/
+dist/
+tools/

.eslintrc

@@ -0,0 +1,24 @@
+{
+  "rules": {
+    "semi": ["error", "always"],
+    "@typescript-eslint/ban-ts-ignore": "off",
+    "@typescript-eslint/no-var-requires": "off",
+    "@typescript-eslint/no-explicit-any": "off",
+    "@typescript-eslint/explicit-function-return-type": "off",
+    "@typescript-eslint/no-use-before-define": "off"
+  },
+  "extends": [
+    "plugin:@typescript-eslint/recommended", // Uses the recommended rules from the @typescript-eslint/eslint-plugin
+    "prettier/@typescript-eslint", // Uses eslint-config-prettier to disable ESLint rules from @typescript-eslint/eslint-plugin that would conflict with prettier
+    "plugin:prettier/recommended" // Enables eslint-plugin-prettier and eslint-config-prettier. This will display prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 2020, // Allows for the parsing of modern ECMAScript features
+    "sourceType": "module" // Allows for the use of imports
+  },
+
+  "env": {
+    "node": true
+  }
+}

.prettierignore

@@ -0,0 +1,6 @@
+build/
+coverage/
+keys/
+logs/
+node_modules/
+*.md

.prettierrc

@@ -0,0 +1,8 @@
+{
+  "useTabs": false,
+  "semi": true,
+  "trailingComma": "all",
+  "singleQuote": true,
+  "printWidth": 100,
+  "tabWidth": 2
+}

.travis.yml

@@ -8,4 +8,4 @@ before_install:
   - cp keys/public.pem.example keys/public.pem
   - cp keys/private.pem.example keys/private.pem
   - cp tests/.env.test.example tests/.env.test
-  - docker-compose up -d
+  - docker-compose up -d

addons/init-mongo.js

@@ -1,30 +1,30 @@
-function seed(dbName, user, password){
-	db = db.getSiblingDB(dbName)
-	db.createUser({
-		user: user,
-		pwd: password,
-		roles: [{ role: 'readWrite', db: dbName }]
-	})
+function seed(dbName, user, password) {
+  db = db.getSiblingDB(dbName);
+  db.createUser({
+    user: user,
+    pwd: password,
+    roles: [{ role: 'readWrite', db: dbName }],
+  });
 
-	db.createCollection("api_keys")
-	db.createCollection("roles")
+  db.createCollection('api_keys');
+  db.createCollection('roles');
 
-	db.api_keys.insert({
-		metadata: "To be used by the xyz vendor",
-		key: "GCMUDiuY5a7WvyUNt9n3QztToSHzK7Uj",
-		version: 1,
-		status: true,
-		createdAt: new Date(),
-		updatedAt: new Date()
-	})
+  db.api_keys.insert({
+    metadata: 'To be used by the xyz vendor',
+    key: 'GCMUDiuY5a7WvyUNt9n3QztToSHzK7Uj',
+    version: 1,
+    status: true,
+    createdAt: new Date(),
+    updatedAt: new Date(),
+  });
 
-	db.roles.insertMany([
-		{ code: "LEARNER", status: true, createdAt: new Date(), updatedAt: new Date() },
-		{ code: "WRITER", status: true, createdAt: new Date(), updatedAt: new Date() },
-		{ code: "EDITOR", status: true, createdAt: new Date(), updatedAt: new Date() },
-		{ code: "ADMIN", status: true, createdAt: new Date(), updatedAt: new Date() },
-	])
+  db.roles.insertMany([
+    { code: 'LEARNER', status: true, createdAt: new Date(), updatedAt: new Date() },
+    { code: 'WRITER', status: true, createdAt: new Date(), updatedAt: new Date() },
+    { code: 'EDITOR', status: true, createdAt: new Date(), updatedAt: new Date() },
+    { code: 'ADMIN', status: true, createdAt: new Date(), updatedAt: new Date() },
+  ]);
 }
 
-seed('afteracademy-blog-db', 'afteracademy-blog-db-user', 'changeit')
-seed('afteracademy-blog-test-db', 'afteracademy-blog-test-db-user', 'changeit')
+seed('afteracademy-blog-db', 'afteracademy-blog-db-user', 'changeit');
+seed('afteracademy-blog-test-db', 'afteracademy-blog-test-db-user', 'changeit');

docker-compose.yml

@@ -2,7 +2,7 @@ version: '3'
 
 services:
   app:
-    # This defines the configuration options, including the context and dockerfile, 
+    # This defines the configuration options, including the context and dockerfile,
     # that will be applied when Compose builds the application image.
     build:
       # This defines the build context for the image build — in this case, the current project directory.
@@ -11,13 +11,13 @@ services:
       dockerfile: Dockerfile
     image: app
     container_name: app
-    # This defines the restart policy. The default is no, 
+    # This defines the restart policy. The default is no,
     # but we have set the container to restart unless it is stopped.
     restart: unless-stopped
     env_file: .env
     ports:
       # This maps port from .env on the host to same port number on the container.
-      - "3000:$PORT"
+      - '3000:$PORT'
     links:
       - mongo
 
@@ -26,28 +26,28 @@ services:
     image: mongo:4.2.5
     container_name: mongo
     restart: unless-stopped
-    # This tells Compose that we would like to add environment variables 
+    # This tells Compose that we would like to add environment variables
     # from a file called .env, located in our build context.
     env_file: .env
     environment:
       # MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD together create
-      # a root user in the admin authentication database and ensure that authentication is enabled 
-      # when the container starts. We have set MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD 
+      # a root user in the admin authentication database and ensure that authentication is enabled
+      # when the container starts. We have set MONGO_INITDB_ROOT_USERNAME and MONGO_INITDB_ROOT_PASSWORD
       # using the values from our .env file, which we pass to the db service using the env_file option.
       - MONGO_INITDB_ROOT_USERNAME=$DB_ADMIN
       - MONGO_INITDB_ROOT_PASSWORD=$DB_ADMIN_PWD
       - MONGO_INITDB_DATABASE=$DB_NAME
     ports:
-      - "$DB_PORT:27017"
-    volumes:     
-    - ./addons/init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js:ro
-      # The named volume dbdata will persist the data stored in Mongo’s default data directory, /data/db. 
-      # This will ensure that you don’t lose data in cases where you stop or remove containers.
-    - dbdata:/data/db
+      - '$DB_PORT:27017'
+    volumes:
+      - ./addons/init-mongo.js:/docker-entrypoint-initdb.d/init-mongo.js:ro
+        # The named volume dbdata will persist the data stored in Mongo’s default data directory, /data/db.
+        # This will ensure that you don’t lose data in cases where you stop or remove containers.
+      - dbdata:/data/db
 
-# Our top-level volumes key defines the volumes dbdata. 
-# When Docker creates volumes, the contents of the volume are stored in a part of the host filesystem, /var/lib/docker/volumes/, that’s managed by Docker. 
-# The contents of each volume are stored in a directory under /var/lib/docker/volumes/ and get mounted to any container that uses the volume. 
+# Our top-level volumes key defines the volumes dbdata.
+# When Docker creates volumes, the contents of the volume are stored in a part of the host filesystem, /var/lib/docker/volumes/, that’s managed by Docker.
+# The contents of each volume are stored in a directory under /var/lib/docker/volumes/ and get mounted to any container that uses the volume.
 # In this way, the data that our users will create will persist in the dbdata volume even if we remove and recreate the db container.
 volumes:
-  dbdata:
+  dbdata:

jest.config.js

@@ -1,10 +1,7 @@
 module.exports = {
-	preset: 'ts-jest',
-	testEnvironment: 'node',
-	roots: ['<rootDir>/tests'],
-	setupFiles: ['<rootDir>/tests/setup.ts'],
-	"collectCoverageFrom": [
-		"<rootDir>/src/**/*.ts",
-		"!**/node_modules/**",
-	]
-};
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+  roots: ['<rootDir>/tests'],
+  setupFiles: ['<rootDir>/tests/setup.ts'],
+  collectCoverageFrom: ['<rootDir>/src/**/*.ts', '!**/node_modules/**'],
+};