docs: add inline comments to ESLint config for clarity

[harshgajera101]

User description

🔧 What this PR does

This pull request adds inline documentation to the ESLint configuration file (eslint.config.js). The comments explain the purpose of various plugins, rules, and environment settings used in the configuration.

📖 Motivation

As a new contributor, I noticed that the configuration file could benefit from clearer inline comments to help others (especially first-time contributors) understand the reasoning behind various linting rules and plugin choices.

✅ Changes Made

• Added comments explaining:
  • Plugin imports and their roles
  • ESLint environment options
  • Mocha and Node-specific rule configurations
  • Prettier formatting rules
• No actual functional/code logic was changed

🔍 Verification

• ✅ Ran eslint . to ensure configuration still works
• ✅ Ensured no rules were modified, only comments added

📎 Related Issues

N/A – This is a general documentation improvement.

🙋‍♀️ Additional Notes

If this style of documentation is welcome, I would be happy to extend it to other parts of the configuration or tooling files in the project.

---

Thank you for reviewing this!

---

PR Type

Documentation

---

Description

• Added comprehensive inline comments to ESLint configuration

• Documented plugin imports, rules, and environment settings

• Improved code readability for new contributors

• No functional changes to linting behavior

---

Diagram Walkthrough

flowchart LR
  A["ESLint Config"] --> B["Plugin Imports"]
  A --> C["Language Options"]
  A --> D["Rule Definitions"]
  B --> E["Added Comments"]
  C --> F["Added Comments"]
  D --> G["Added Comments"]

Loading

File Walkthrough

	Relevant files
Documentation	eslint.config.js Enhanced ESLint config with comprehensive documentation    javascript/selenium-webdriver/eslint.config.js Added detailed inline comments explaining plugin imports and their purposes Documented language options, globals, and parser settings Added explanations for each ESLint rule configuration Clarified Prettier formatting options with inline descriptions +65/-25

---

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[qodo-code-review]

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🧪 No relevant tests

🔒 No security concerns identified

⚡ No major issues detected

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
General	Fix incorrect rule description The comment incorrectly describes the rule's purpose. The n/no-mixed-requires rule actually disallows mixing core modules, file modules, and npm modules in the same require statement block. javascript/selenium-webdriver/eslint.config.js [101] -// Enforce either all `require` at top or dynamic—not both +// Disallow mixing different types of requires (core, file, npm) in same block [To ensure code accuracy, apply this suggestion manually] Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies that the comment for the n/no-mixed-requires rule is misleading and provides an accurate description, which is valuable as the PR's goal is to add explanatory comments.	Low
More

[cgoldberg]

We don't need additional unnecessary comments.

If this style of documentation is welcome, I would be happy to extend it to other parts of the configuration or tooling files in the project.

please don't.