feat: add linter flow (#61)

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  eslint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '22'
+          cache: 'npm'
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Run ESLint
+        run: npm run lint

README.md

@@ -1,5 +1,6 @@
 [![Dependabot Updates](https://github.com/adminvns/testapi/actions/workflows/dependabot/dependabot-updates/badge.svg?branch=main)](https://github.com/adminvns/testapi/actions/workflows/dependabot/dependabot-updates)
 [![Version](https://img.shields.io/github/v/tag/adminvns/testapi?label=version&color=blue)](https://github.com/adminvns/testapi/tags)
+[![Lint](https://github.com/adminvns/testapi/actions/workflows/lint.yml/badge.svg)](https://github.com/adminvns/testapi/actions/workflows/lint.yml)
 # testapi
 
 A lightweight and customizable RESTful API built with Node.js and Express, designed for testing and learning purposes. This project serves as a foundational template for developers looking to understand API development, middleware integration, and deployment workflows.

api/routes/orders.js

@@ -1,42 +1,42 @@
 const express = require('express');
 const router = express.Router();
 
-router.get('/',(req, res, next)=> {
+router.get('/', (req, res) => {
 
-res.status(200).json({
+  res.status(200).json({
 
-    message: "Order was fetched"
-});
+    message: 'Order was fetched'
+  });
 
 });
 
-router.post('/',(req, res, next)=> {
+router.post('/', (req, res) => {
+
+  res.status(201).json({
+
+    message: 'Order was created'
+  });
 
-    res.status(201).json({
-
-        message: "Order was created"
-    });
-
-    });
+});
 
 
-router.get('/:orderID',(req, res, next)=>{
+router.get('/:orderID', (req, res) => {
 
-    res.status(200).json({
-        message: "order details",
-        id: req.params.orderID
-    })
+  res.status(200).json({
+    message: 'order details',
+    id: req.params.orderID
+  });
 
-})
+});
 
-router.delete('/:orderID',(req, res, next)=>{
+router.delete('/:orderID', (req, res) => {
 
-    res.status(200).json({
-        message: "order deleted",
-        id: req.params.orderID
-    })
+  res.status(200).json({
+    message: 'order deleted',
+    id: req.params.orderID
+  });
 
-})
+});
 
 
 module.exports = router;

api/routes/products.js

@@ -1,59 +1,59 @@
 const express = require('express');
 const router = express.Router();
 
-router.get('/', (req, res, next) => {
+router.get('/', (req, res) => {
 
-    res.status(200).json({
+  res.status(200).json({
 
-        message: "Products(GET method)"
-    });
+    message: 'Products(GET method)'
+  });
 
 });
 
-router.post('/', (req, res, next) => {
+router.post('/', (req, res) => {
 
-    res.status(201).json({
+  res.status(201).json({
 
-        message: "Products(POST method)"
-    });
+    message: 'Products(POST method)'
+  });
 });
 
 
 
-router.get('/:productID', (req, res, next) => {
+router.get('/:productID', (req, res) => {
 
-    const id = req.params.productID;
-    if (id == 123) {
+  const id = req.params.productID;
+  if (id == 123) {
 
-        res.status(200).json({
-            message: "Congratulations on winning it",
-            id: id
-        });
+    res.status(200).json({
+      message: 'Congratulations on winning it',
+      id: id
+    });
 
-    } else {
+  } else {
 
-        res.status(200).json({
+    res.status(200).json({
 
-            message: "This is random id"
-        });
-    }
+      message: 'This is random id'
+    });
+  }
 
 });
 
 
-router.patch('/:productID', (req, res, next) => {
-    res.status(200).json({
+router.patch('/:productID', (req, res) => {
+  res.status(200).json({
 
-        message: " Product updated successfully!"
-    })
+    message: ' Product updated successfully!'
+  });
 });
 
 
-router.delete('/:productID', (req, res, next) => {
-    res.status(200).json({
+router.delete('/:productID', (req, res) => {
+  res.status(200).json({
 
-        message: " Product deleted successfully."
-    })
+    message: ' Product deleted successfully.'
+  });
 });
 
 module.exports = router;

api/routes/visitors.js

@@ -5,35 +5,35 @@ const router = express.Router();
 const visitorLogs = [];
 
 router.get('/', (req, res) => {
-    const ip = req.ip || req.connection.remoteAddress;
-    const timestamp = new Date().toISOString();
+  const ip = req.ip || req.connection.remoteAddress;
+  const timestamp = new Date().toISOString();
 
-    // Add new visit to logs
-    visitorLogs.push({
-        ip,
-        timestamp,
-        userAgent: req.get('User-Agent')
-    });
+  // Add new visit to logs
+  visitorLogs.push({
+    ip,
+    timestamp,
+    userAgent: req.get('User-Agent')
+  });
 
-    // Return all logs
-    res.status(200).json({
-        status: 'ok',
-        message: 'Visitor logs retrieved successfully',
-        totalVisits: visitorLogs.length,
-        logs: visitorLogs
-    });
+  // Return all logs
+  res.status(200).json({
+    status: 'ok',
+    message: 'Visitor logs retrieved successfully',
+    totalVisits: visitorLogs.length,
+    logs: visitorLogs
+  });
 });
 
 // Get statistics about visitors
 router.get('/stats', (req, res) => {
-    const uniqueIPs = new Set(visitorLogs.map(log => log.ip)).size;
+  const uniqueIPs = new Set(visitorLogs.map(log => log.ip)).size;
 
-    res.status(200).json({
-        status: 'ok',
-        totalVisits: visitorLogs.length,
-        uniqueVisitors: uniqueIPs,
-        lastVisit: visitorLogs.length > 0 ? visitorLogs[visitorLogs.length - 1] : null
-    });
+  res.status(200).json({
+    status: 'ok',
+    totalVisits: visitorLogs.length,
+    uniqueVisitors: uniqueIPs,
+    lastVisit: visitorLogs.length > 0 ? visitorLogs[visitorLogs.length - 1] : null
+  });
 });
 
 module.exports = router;

app.js

@@ -1,36 +1,36 @@
-var express = require('express');
-var app = express();
-const morgan = require('morgan')
-const prodRoute = require('./api/routes/products')
-const prodOrder = require('./api/routes/orders')
+const express = require('express');
+const app = express();
+const morgan = require('morgan');
+const prodRoute = require('./api/routes/products');
+const prodOrder = require('./api/routes/orders');
 const healthRoute = require('./api/routes/healthCheck');
 const visitorsRoute = require('./api/routes/visitors');
 //rerouting requests
 
 app.use(morgan('dev'));
 app.use('/products', prodRoute);
-app.use('/orders',prodOrder);
+app.use('/orders', prodOrder);
 app.use('/health', healthRoute);
 app.use('/visitors', visitorsRoute);
 
 //error handling
-app.use((req,res,next)=>{
+app.use((req, res, next) => {
 
-    const err = new Error('This page does not exist, Navigate to /products or /orders or /visitors or /health');
-    err.status = 404;    
-    next(err);
+  const err = new Error('This page does not exist, Navigate to /products or /orders or /visitors or /health');
+  err.status = 404;
+  next(err);
 
 
-})
-app.use((err,req,res,next)=>{
-
-    res.status(err.status || 500)
-    res.json({
-            error:{
-                message: err.message
-            },
-    });
+});
+app.use((err, req, res) => {
+
+  res.status(err.status || 500);
+  res.json({
+    error: {
+      message: err.message
+    },
+  });
 });
 
 
-module.exports= app;
+module.exports = app;

eslint.config.js

@@ -0,0 +1,35 @@
+const js = require('@eslint/js');
+
+module.exports = [
+  js.configs.recommended,
+  {
+    languageOptions: {
+      ecmaVersion: 'latest',
+      sourceType: 'commonjs',
+      globals: {
+        console: 'readonly',
+        process: 'readonly',
+        require: 'readonly',
+        module: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        exports: 'readonly',
+        Buffer: 'readonly',
+        setTimeout: 'readonly',
+        setInterval: 'readonly',
+        clearTimeout: 'readonly',
+        clearInterval: 'readonly'
+      }
+    },
+    rules: {
+      'indent': ['error', 2],
+      'quotes': ['error', 'single'],
+      'semi': ['error', 'always'],
+      'no-unused-vars': ['warn'],
+      'no-console': 'off'
+    }
+  },
+  {
+    ignores: ['node_modules/', '*.log', '.env', 'coverage/', 'dist/', 'build/']
+  }
+];