Merge pull request #1 from codacy-acme/v0.1

V0.1

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,56 @@
+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: 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
+
+      - name: Install dependencies
+        run: |
+          npm install -g nyc  # Install Istanbul (nyc) for code coverage
+          npm install  # Install project dependencies
+          npm install --save-dev nyc
+          npm install --save-dev chai
+          npm install --save-dev blanket
+          npm install --save-dev mocha
+          npm install --save-dev mocha-lcov-reporter
+
+      - name: Run tests and collect coverage
+        run: |
+          # Replace with the actual command to run your tests
+          npm test
+        continue-on-error: true
+
+      - 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
+        continue-on-error: true

__tests__/main.test.js

@@ -0,0 +1,21 @@
+const { addNumbers, subtractNumbers } = require('../main');
+const { expect } = require('chai');
+
+// Describe a test suite for main.js
+describe('Main Module', () => {
+  // Test the addNumbers function
+  describe('addNumbers', () => {
+    it('should add two numbers correctly', () => {
+      const result = addNumbers(5, 3);
+      expect(result).to.equal(8);
+    });
+  });
+
+  // Test the subtractNumbers function
+  describe('subtractNumbers', () => {
+    it('should subtract two numbers correctly', () => {
+      const result = subtractNumbers(10, 3);
+      expect(result).to.equal(7);
+    });
+  });
+});

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);
+}
+
+// Removed the unused variable
+// const unusedVariable = 'This variable is not used';
+
+// Removed the missing semicolon
+const missingSemicolon = 'This line is missing a semicolon';
+
+// Removed the undefined variable usage
+// console.log(undefinedVariable);
+
+// Removed the attempt to reassign a constant
+// const constantValue = 42;
+// constantValue = 43;
+
+// Removed the missing function argument
+// function missingArgument(arg1, arg2) {
+//   return arg1 + arg2;
+// }
+
+module.exports = {
+  addNumbers,
+  subtractNumbers,
+};