Initial commit

Author: Ngwerume

.eslintrc.js

@@ -0,0 +1,15 @@
+module.exports = {
+    env: {
+      node: true,
+      es6: true,
+      jest: true,
+    },
+    extends: ['eslint:recommended'],
+    plugins: ['jest'],
+    rules: {
+      'jest/no-disabled-tests': 'warn',
+      'jest/no-focused-tests': 'error',
+      'jest/no-identical-title': 'error',
+      'jest/valid-expect': 'error',
+    },
+  };

.github/workflows/codacy.yml

@@ -0,0 +1,54 @@
+name: Client Side Tools and Coverage
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ '*' ]
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: '18'  # Choose your Node.js version
+
+      - name: Install dependencies
+        run: |
+          npm install -g nyc  # Install Istanbul (nyc) for code coverage
+          npm install  # Install project dependencies
+
+      - name: Run tests and collect coverage
+        run: |
+          # Replace with the actual command to run your tests
+          npm test
+
+          # Generate code coverage report using nyc (Istanbul)
+          nyc report --reporter=lcov > $GITHUB_WORKSPACE/lcov.info
+          nyc report --reporter=text-summary  # Display summary in the console
+
+      - name: Upload coverage report to Codacy
+        env:
+            CODACY_PROJECT_TOKEN: ${{ secrets.CODACY_PROJECT_TOKEN }}
+        run: |
+            bash <(curl -Ls https://coverage.codacy.com/get.sh) report -r $GITHUB_WORKSPACE/lcov.info
+
+      - name: Run Codacy Analysis CLI with Docker (optional)
+        run: |
+          export CODACY_CODE=$GITHUB_WORKSPACE
+          docker run \
+            --rm=true \
+            --env CODACY_CODE="$CODACY_CODE" \
+            --volume /var/run/docker.sock:/var/run/docker.sock \
+            --volume "$CODACY_CODE":"$CODACY_CODE" \
+            --volume /tmp:/tmp \
+            codacy/codacy-analysis-cli \
+              analyze --tool eslint --upload --project-token ${{ secrets.CODACY_PROJECT_TOKEN }} --max-allowed-issues 99999 --commit-uuid $GITHUB_SHA
+        if: success()  # Optional, run only if the previous steps were successful

__tests__/main.test.js

@@ -0,0 +1,13 @@
+// __tests__/main.test.js
+
+const main = require('../main');
+
+test('addNumbers function adds two numbers correctly', () => {
+  expect(main.addNumbers(2, 3)).toBe(5);
+});
+
+test('subtractNumbers function subtracts two numbers correctly', () => {
+  expect(main.subtractNumbers(5, 2)).toBe(3);
+});
+
+// Add more tests for other functions if needed

jest.config.js

@@ -0,0 +1,9 @@
+// jest.config.js
+
+module.exports = {
+    testEnvironment: 'node',
+    coverageProvider: 'v8', // Use Istanbul (nyc) for code coverage
+    collectCoverage: true,
+    collectCoverageFrom: ['**/*.js'],
+  };
+  

main.js

@@ -0,0 +1,37 @@
+// This is the main JavaScript file of your sample project.
+
+// Import the utility functions from util.js
+const { add, subtract } = require('./util');
+
+// Function to add two numbers
+function addNumbers(a, b) {
+  return add(a, b);
+}
+
+// Function to subtract two numbers
+function subtractNumbers(a, b) {
+  return subtract(a, b);
+}
+
+// Error: Unused variable 'unusedVariable'
+const unusedVariable = 'This variable is not used';
+
+// Error: Missing semicolon at the end of the line
+const missingSemicolon = 'This line is missing a semicolon';
+
+// Error: Using an undefined variable
+console.log(undefinedVariable);
+
+// Error: Trying to reassign a constant
+const constantValue = 42;
+constantValue = 43;
+
+// Error: Missing function argument
+function missingArgument(arg1, arg2) {
+  return arg1 + arg2;
+}
+
+module.exports = {
+  addNumbers,
+  subtractNumbers,
+};

package.json

@@ -0,0 +1,12 @@
+{
+  "name": "sample-javascript-project",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

util.js

@@ -0,0 +1,18 @@
+// This is a utility module with some basic functions.
+
+// Function to add two numbers
+function add(a, b) {
+    return a + b;
+  }
+  
+  // Function to subtract two numbers
+  function subtract(a, b) {
+    return a - b;
+  }
+  
+  // Export the functions to make them accessible in other modules
+  module.exports = {
+    add,
+    subtract,
+  };
+