ch: Setup CI workflow for testing, coverage reporting, building and l…

…inting

.eslintrc.js

@@ -3,31 +3,34 @@ module.exports = {
  root: true,
  parser: '@typescript-eslint/parser',
  plugins: ['@typescript-eslint'],
- extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'],
+ extends: [
+ 'eslint:recommended',
+ 'plugin:@typescript-eslint/recommended'
+ ],
  rules: {
  '@typescript-eslint/no-explicit-any': 'off',
- "@typescript-eslint/no-unused-vars": [
- "warn",
+ '@typescript-eslint/no-unused-vars': [
+ 'warn',
  {
- "args": "all",
- "argsIgnorePattern": "^_",
- "caughtErrors": "all",
- "caughtErrorsIgnorePattern": "^_",
- "destructuredArrayIgnorePattern": "^_",
- "varsIgnorePattern": "^_",
- "ignoreRestSiblings": true
- }
+ args: 'all',
+ argsIgnorePattern: '^_',
+ caughtErrors: 'all',
+ caughtErrorsIgnorePattern: '^_',
+ destructuredArrayIgnorePattern: '^_',
+ varsIgnorePattern: '^_',
+ ignoreRestSiblings: true,
+ },
  ],
  'no-undef': 'off',
  'semi': ['warn', 'always'],
  'no-multi-spaces': 'warn',
  'no-trailing-spaces': 'warn',
  'space-before-function-paren': ['warn', 'always'],
- 'func-style': ['warn', 'declaration', { 'allowArrowFunctions': true }],
+ 'func-style': ['warn', 'declaration', { allowArrowFunctions: true }],
  'camelcase': 'warn',
  '@typescript-eslint/explicit-function-return-type': ['warn', { allowExpressions: true }],
  '@typescript-eslint/explicit-member-accessibility': ['off', { accessibility: 'explicit' }],
  'no-unused-vars': 'warn',
  'no-extra-semi': 'warn',
  },
-};
+};

.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: knights-ecomm-be CI
+
+on: [push, pull_request]
+
+jobs:
+ build-lint-test-coverage:
+ runs-on: ubuntu-latest
+
+ steps:
+ - name: Checkout code
+ uses: actions/checkout@v4
+
+ - name: Use Node.js
+ uses: actions/setup-node@v4
+ with:
+ node-version: '20.x'
+
+ - name: Install dependencies
+ run: npm install
+
+ - name: Run ESLint and Prettier
+ run: npm run lint
+
+ - name: Build project
+ run: npm run build --if-present
+
+ - name: Run tests
+ run: npm test
+
+ - name: Upload coverage report to Coveralls
+ uses: coverallsapp/github-action@v2.2.3
+ with:
+ github-token: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -10,7 +10,9 @@ functionalities for the frontend, such as storing, retrieving, deleting data and
 List of endpoints exposed by the service
 
 ## Setup
+
 - to use loggers in program use below functions
+
 ```bash
 logger.error('This is an error message');
 logger.warn('This is a warning message');

jest.config.ts

@@ -1,18 +1,18 @@
 /** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
 export default {
-  preset: "ts-jest",
-  testEnvironment: "node",
-  testMatch: ["**/**/*.test.ts"],
-  verbose: true,
-  forceExit: true,
-  clearMocks: true,
-  resetMocks: true,
-  restoreMocks: true,
-  collectCoverageFrom: [
-  "src/**/*.{ts,tsx}", // Include all JavaScript/JSX files in the src directory
-  ],
-  coveragePathIgnorePatterns: [
-  "/node_modules/", // Exclude the node_modules directory
-  "/__tests__/", // Exclude the tests directory
-  ],
- };
+ preset: 'ts-jest',
+ testEnvironment: 'node',
+ testMatch: ['**/**/*.test.ts'],
+ verbose: true,
+ forceExit: true,
+ clearMocks: true,
+ resetMocks: true,
+ restoreMocks: true,
+ collectCoverageFrom: [
+ 'src/**/*.{ts,tsx}', // Include all JavaScript/JSX files in the src directory
+ ],
+ coveragePathIgnorePatterns: [
+ '/node_modules/', // Exclude the node_modules directory
+ '/__tests__/', // Exclude the tests directory
+ ],
+};

src/__test__/route.test.ts

@@ -1,14 +1,12 @@
 import request from 'supertest';
-import {app, server} from '../index'; // update this with the path to your app file
+import { app, server } from '../index'; // update this with the path to your app file
 
 describe('GET /', () => {
-  afterAll(done => {
-  server.close(done);
-  });
+ afterAll(done => {
+ server.close(done);
+ });
 
  it('responds with "Knights Ecommerce API"', done => {
- request(app)
- .get('/')
- .expect(200, 'Knights Ecommerce API', done);
+ request(app).get('/').expect(200, 'Knights Ecommerce API', done);
  });
 });

src/controllers/index.ts

@@ -1,5 +1,5 @@
 // export all controllers
-function myFunction () {
+function myFunction (): void {
  console.log('Hello');
 }
 myFunction();

src/index.ts

@@ -1,10 +1,10 @@
-import express, { Request, Response } from "express";
-import cors from "cors";
-import dotenv from "dotenv";
-import router from "./routes";
-import { addDocumentation } from "./startups/docs";
+import express, { Request, Response } from 'express';
+import cors from 'cors';
+import dotenv from 'dotenv';
+import router from './routes';
+import { addDocumentation } from './startups/docs';
 
-import {CustomError,errorHandler} from "./middlewares/errorHandler";
+import { CustomError, errorHandler } from './middlewares/errorHandler';
 import morgan from 'morgan';
 dotenv.config();
 
@@ -15,7 +15,7 @@ app.use(express.json());
 app.use(cors({ origin: "*" }));
 app.use(router);
 addDocumentation(app);
-app.all('*', (req: Request,res: Response,next) =>{
+app.all('*', (req: Request, res: Response, next) =>{
  const error = new CustomError(`Can't find ${req.originalUrl} on the server!`,404);
  error.status = 'fail';
  next(error);

src/middlewares/errorHandler.ts

@@ -1,30 +1,25 @@
 import { Request, Response } from 'express';
 
 class CustomError extends Error {
-  statusCode: number;
-  status: string;
+ statusCode: number;
+ status: string;
 
-  constructor (message: string, statusCode: number) {
-  super(message);
-  this.statusCode = statusCode;
-  this.status = `${statusCode}`.startsWith('4') ? 'fail' : 'error';
-  Error.captureStackTrace(this, this.constructor);
-  }
+ constructor (message: string, statusCode: number) {
+ super(message);
+ this.statusCode = statusCode;
+ this.status = `${statusCode}`.startsWith('4') ? 'fail' : 'error';
+ Error.captureStackTrace(this, this.constructor);
+ }
 }
 
-const errorHandler = (
- err: CustomError,
- req: Request,
- res: Response,
-
-) => {
- err.statusCode = err.statusCode || 500;
- err.status = err.status || 'error';
- res.status(err.statusCode).json({
- status: err.statusCode,
- message: err.message
- });
- console.error(err.stack);
+const errorHandler = (err: CustomError, req: Request, res: Response) => {
+ err.statusCode = err.statusCode || 500;
+ err.status = err.status || 'error';
+ res.status(err.statusCode).json({
+ status: err.statusCode,
+ message: err.message,
+ });
+ console.error(err.stack);
 };
 
 export { CustomError, errorHandler };

src/utils/response.utils.ts

@@ -9,13 +9,13 @@ interface ApiResponse {
 
 export const responseSuccess = (
  res: Response,
- status_code: number,
+ statusCode: number,
  message: string,
  data?: any
 ): Response<ApiResponse> => {
  return res.status(200).json(
  jsend.success({
- code: status_code,
+ code: statusCode,
  message,
  data,
  })
@@ -24,13 +24,13 @@ export const responseSuccess = (
 
 export const responseError = (
  res: Response,
- status_code: number,
+ statusCode: number,
  message: string,
  data?: any
 ): Response<ApiResponse> => {
  return res.status(400).json(
  jsend.error({
- code: status_code,
+ code: statusCode,
  message,
  data,
  })