Add ESLint

[Katletos]

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have read the CONTRIBUTING document.
• I have added tests to cover my changes.
• All new and existing tests passed.

[coliff]

ESLint is already included in H5BP in the project root... however, it's the older v8 release.

We would appreciate a PR updating to ESlint v9. For this change the existing .eslintrc.js should be removed.

I don't think we need to include it in the src/, dist/ directories. We'll leave that up to users how to handle that.

[Katletos]

I discussed this with @roblarsen. He supported this idea

[roblarsen]

Yeah, I didn't mind the idea of shipping it with the project, depending on what it looks like.

[Katletos]

@roblarsen @coliff finalization and merge or reject?

[roblarsen]

I haven't looked at it yet. I'll look at it when I get a chance

[Imran-imtiaz48]

Key Changes and Benefits:

1. Addition of Linting Step:
   o The new code introduces a linting step with ESLint via the lint script: "lint": "eslint ./js --fix". This ensures code quality by automatically fixing linting issues in the JavaScript files.
   o The build script now also runs the linting step before executing the webpack build process: "build": "npm run lint && webpack --config webpack.config.prod.js". This is a great addition to catch potential code quality issues before building the project.
2. DevDependency Updates:
   o ESLint Integration:
    You've added eslint, along with @eslint/js and globals as devDependencies. This enhances the development workflow by enforcing code standards and identifying possible issues early in the development process.
   o Version Locking:
    It's great to see version locking for dependencies like eslint and globals, which ensures stability in your development environment.
3. Overall Workflow Improvement:
   o By including the linting step as part of the build process, you're ensuring that only high-quality, properly formatted code makes it to production. This reduces the risk of bugs and increases maintainability.
   Suggestions for Further Improvement:
   • Unit Testing Setup:
   o Since the test script still outputs "Error: no test specified", consider adding a unit testing framework (like Mocha, Jest, or Jasmine) to further improve your code quality and ensure functionality.
   • ESLint Configuration:
   o Ensure that your .eslintrc or equivalent configuration is well-tuned for your project’s coding standards. You might want to review the rules to align them with your team's style guide.

[Katletos]

@roblarsen just a reminder