Add GitHub Action for Code Linting

This pull request introduces a GitHub Action workflow to automate the linting
of various code types in the repo on each push and pull request.

It add:
- lint.yml to define the workflow
- eslint.config.js to manage the rules for the js linting

The workflow runs the following linters:
- JavaScript: Uses ESLint to check for issues in JavaScript files.
- HTML: Uses HTMLHint to lint HTML files.
- CSS: Uses Stylelint to ensure proper CSS formatting.
- Shell scripts: Uses ShellCheck to lint shell scripts.
- C++: Uses Clang-Tidy to check C++ code for style and potential errors.

By adding this workflow, we ensure consistent code quality and formatting
across multiple languages in the repository.

Author: ekumachidi

.github/workflows/lint.yml

@@ -0,0 +1,56 @@
+name: Lint Code
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Install ESLint globally
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y eslint  # Install ESLint globally
+
+    - name: Install ShellCheck
+      run: |
+        sudo apt-get install -y shellcheck
+
+    - name: Install Clang-Tidy
+      run: |
+        sudo apt-get install -y clang-tidy
+
+    # - name: Install Perl and cpanm
+    #   run: |
+    #     sudo apt-get install -y perl
+    #     sudo apt-get install -y cpanminus  # Install cpanm tool
+
+    # - name: Install missing Perl dependencies
+    #   run: |
+    #     sudo cpanm Module::Pluggable  # Install the missing dependency
+    #     sudo cpanm --installdeps Perl::Critic  # Install all dependencies for Perl::Critic
+
+    # - name: Install Perl::Critic
+    #   run: |
+    #     sudo cpanm Perl::Critic  # Install Perl::Critic module
+
+    - name: Lint JavaScript
+      run: npx eslint .
+
+    - name: Lint HTML
+      run: npx htmlhint .
+
+    - name: Lint CSS
+      run: npx stylelint "**/*.css"
+
+    - name: Lint Shell scripts
+      run: shellcheck **/*.sh
+
+    - name: Lint C++ code
+      run: clang-tidy **/*.cpp
+
+    # - name: Lint Perl
+    #   run: perlcritic **/*.pl

eslint.config.js

@@ -0,0 +1,25 @@
+// eslint.config.js
+module.exports = [
+  {
+    languageOptions: {
+      globals: {
+        // Define any global variables here (e.g., for browsers)
+        window: 'readonly',
+        document: 'readonly',
+      },
+      parserOptions: {
+        ecmaVersion: 12, // ES2021
+        sourceType: 'module', // Enable ES6 modules
+      },
+    },
+    rules: {
+      'no-console': 'warn',  // Warn on console statements
+      'semi': ['error', 'always'], // Enforce semicolons
+      'quotes': ['error', 'single'], // Enforce single quotes
+      'eqeqeq': 'error', // Enforce strict equality (===)
+      'curly': 'error', // Enforce curly braces for control statements
+      'no-unused-vars': 'warn', // Warn about unused variables
+      'no-magic-numbers': 'off', // Optional: disable rule for magic numbers if you want
+    },
+  },
+];