ESLint Configuration PreCommit format and Test

.eslintrc.json

@@ -0,0 +1,52 @@
+{
+  "root": true,
+  "extends": ["airbnb-base"],
+  "env": {
+    "node": true,
+    "es6": true,
+    "mocha": true
+  },
+  "rules": {
+    "quotes": ["error", "double"],
+    "one-var": 0,
+    "one-var-declaration-per-line": 0,
+    "new-cap": 0,
+    "no-unused-vars": "off",
+    "import/no-dynamic-require": "off",
+    "operator-linebreak": "off",
+    "arrow-body-style": "off",
+    "global-require": "off",
+    "consistent-return": 0,
+    "no-param-reassign": 0,
+    "comma-dangle": 0,
+    "semi": 0,
+    "curly": ["error", "multi-line"],
+    "import/no-unresolved": [
+      2,
+      { "commonjs": true, "amd": true }
+    ],
+    "no-shadow": [
+      "error",
+      { "allow": ["req", "res", "err"] }
+    ],
+    "valid-jsdoc": [
+      "error",
+      {
+        "requireReturn": true,
+        "requireReturnType": true,
+        "requireParamDescription": false,
+        "requireReturnDescription": true
+      }
+    ],
+    "require-jsdoc": [
+      "error",
+      {
+        "require": {
+          "FunctionDeclaration": true,
+          "MethodDefinition": true,
+          "ClassDeclaration": true
+        }
+      }
+    ]
+  }
+}

.prettierrc.json

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

.stylelintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@thoughtbot/stylelint-config"
+}

README.md

@@ -1,6 +1,7 @@
 # eagles-ec-be
 
 <div style="display: flex; justify-content: center;" align="center">
+[![Code Style](https://img.shields.io/badge/style-hound-brightgreen.svg)](https://houndci.com)
 <img src="https://codecov.io/gh/soleil00/eagles-ec-be/branch/dev/graph/badge.svg?token=9c1e8e93-1062-4e49-a58d-b2777a75fb70" alt="Codecov" >
      <img alt="GitHub Actions Workflow Status" src="https://img.shields.io/github/actions/workflow/status/atlp-rwanda/eagles-ec-be/deploy.yml" >
 <a href="https://codeclimate.com/github/atlp-rwanda/eagles-ec-be/maintainability"><img src="https://api.codeclimate.com/v1/badges/dfe8454356fb9da65407/maintainability" /></a>

hound.yml

@@ -0,0 +1,13 @@
+fail_on_violations: true
+
+scss:
+  enabled: false
+
+stylelint:
+  config_file: .stylelintrc.json
+  enabled: true
+
+eslint:
+  enabled: true
+  version: 8.57.0
+  config_file: .eslintrc

index.ts

@@ -1,15 +1,15 @@
-import sequelize, { connect } from "./src/config/dbConnection";
-import { env } from "./src/utils/env";
-import app from "./src/utils/server";
+import sequelize, { connect } from "./src/config/dbConnection"
+import { env } from "./src/utils/env"
+import app from "./src/utils/server"
 
 app.listen(env.port, async () => {
-  await connect();
+  await connect()
   await sequelize
     .sync()
     .then(() => {
-      console.log(` db synced and server is running on port ${env.port}`);
+      console.log(" db synced and server is running")
     })
     .catch((error: any) => {
-      console.log(error.message);
-    });
-});
+      console.log(error.message)
+    })
+})

package.json

@@ -13,6 +13,24 @@
     "lint:fix": "npx eslint --fix .",
     "test": "cross-env NODE_ENV=test jest --detectOpenHandles --coverage"
   },
+  "lint-staged": {
+    ".ts": [
+      "npm run lint:fix"
+    ],
+    "**/*": "prettier --write"
+  },
+  "eslintConfig": {
+    "extends": [
+      "react-app",
+      "react-app/jest",
+      "prettier"
+    ]
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run lint-staged"
+    }
+  },
   "author": "atlp",
   "license": "MIT",
   "devDependencies": {
@@ -58,6 +76,9 @@
     "pg": "^8.11.5",
     "pg-hstore": "^2.3.4",
     "sequelize": "^6.37.2",
-    "swagger-ui-express": "^5.0.0"
+    "swagger-ui-express": "^5.0.0",
+    "prettier": "3.2.5",
+    "lint-staged": "^15.2.2",
+    "husky": "^9.0.11"
   }
 }

src/sequelize/migrations/20240416115110-create-user.js

@@ -35,10 +35,10 @@ module.exports = {
         allowNull: false,
         type: Sequelize.DATE,
       },
-    });
+    })
   },
 
   async down(queryInterface, Sequelize) {
-    await queryInterface.describeTable("users");
+    await queryInterface.describeTable("users")
   },
-};
+}

src/sequelize/migrations/20240418083442-UserTests.js

@@ -1,44 +1,49 @@
 /** @type {import('sequelize-cli').Migration} */
 module.exports = {
   async up(queryInterface, Sequelize) {
-    await queryInterface.createTable("usersTests", {
-      id: {
-        allowNull: false,
-        autoIncrement: true,
-        primaryKey: true,
-        type: Sequelize.INTEGER,
-      },
-      name: {
-        type: Sequelize.STRING,
-        allowNull: false,
-      },
-      username: {
-        type: Sequelize.STRING,
-        allowNull: false,
-      },
-      email: {
-        type: Sequelize.STRING,
-        allowNull: false,
-        validate: {
-          isEmail: true,
+    await queryInterface.createTable(
+      "usersTests",
+      {
+        id: {
+          allowNull: false,
+          autoIncrement: true,
+          primaryKey: true,
+          type: Sequelize.INTEGER,
+        },
+        name: {
+          type: Sequelize.STRING,
+          allowNull: false,
+        },
+        username: {
+          type: Sequelize.STRING,
+          allowNull: false,
+        },
+        email: {
+          type: Sequelize.STRING,
+          allowNull: false,
+          validate: {
+            isEmail: true,
+          },
+        },
+        password: {
+          type: Sequelize.STRING,
+          allowNull: false,
+        },
+        createdAt: {
+          allowNull: false,
+          type: Sequelize.DATE,
+        },
+        updatedAt: {
+          allowNull: false,
+          type: Sequelize.DATE,
         },
       },
-      password: {
-        type: Sequelize.STRING,
-        allowNull: false,
-      },
-      createdAt: {
-        allowNull: false,
-        type: Sequelize.DATE,
-      },
-      updatedAt: {
-        allowNull: false,
-        type: Sequelize.DATE,
-      },
-    });
+    )
   },
 
   async down(queryInterface, Sequelize) {
-    await queryInterface.describeTable("usersTests");
+    await queryInterface.describeTable(
+      "usersTests",
+    )
   },
-};
+}