refactor: Update ESLint rulesets

[Pathan-Amaankhan]

Note

This pull request (PR) constitutes Part 2 of the migration process for the subsequent PRs:

• https://github.com/rtCamp/headless/pull/321
• https://github.com/rtCamp/headless/pull/322
• https://github.com/rtCamp/headless/pull/327

What

• Update the ESLint rulesets and enforce stricter guidelines.

ESLint Changes

.eslintrc.cjs File

parser

• @typescript-eslint/parser parser migrated from packages/eslint-config/index.js as it is not required in public package because JavaScript files are shipped. (ref: refactor: Update eslint import-resolver for TS #60 (comment))

ignorePatterns

• ignorePatterns are sorted ascending.

rules

@typescript-eslint/naming-convention

• Enforcing naming conventions helps keep the codebase consistent, and reduces overhead when thinking about how to name a variable.

@typescript-eslint/no-restricted-imports

• Restricts use of classnames & lodash imports in TypeScript files.

dot-notation

• Enforces dot notation on Objects. Setting allowKeywords option to false prevents using reserved keywords.

eslint-comments/require-description

• Throws error if directive comments are used without description.

import/default

• If a default import is requested, this rule will report if there is no default export in the imported module.

import/named

• Verifies that all named imports are part of the set of named exports in the referenced module.

jest/expect-expect

• Ensure that there is at least one expect call made in a test.

jsdoc/no-types

• Allows adding type-definitions to @param & @return

jsdoc/require-param-type

• Requires that each @param tag has a type value (within curly brackets).

jsdoc/require-returns-type

• Requires that @returns tag has a type value (in curly brackets).

@stylistic/jsx/jsx-closing-tag-location

• This rule checks all JSX multiline elements with children (non-self-closing) and verifies the location of the closing tag is aligned with the line containing the opening tag.

no-empty-function

• Disallow empty functions

no-restricted-imports

• Restricts use of classnames & lodash imports in JavaScript files.

no-restricted-syntax

• Disallows specified syntax (Currently no syntax is restricted but as the project grows certain restrictions will be added as required in future versions)

prefer-destructuring

• Forces de-structuring of arrays and objects.

react/jsx-boolean-value

• When using a boolean attribute in JSX, you can set the attribute value to true or omit the value.

react/jsx-curly-brace-presence

• Prevents adding unnecessary curly braces in jsx children and props.

overrides

• Self-documented, Please refer changelog.

---

packages/eslint-config/index.js File

plugins

The following new plugins have been added:

• @typescript-eslint
• jest
• @stylistic/jsx

extends

plugin:eslint-comments/recommended

• ESLint rulesets for directive comments.

---

Related Issue(s):

• https://github.com/rtCamp/headless/issues/250

Testing Instructions

• Run npm install && npm run lint.

Additional Info

• This PR should be reviewed after refactor: Update eslint import-resolver for TS #60 is merged.

Checklist

• I have read the Contribution Guidelines.
• My code is tested to the best of my abilities.
• My code passes all lints (ESLint, tsc, prettier etc.).
• My code has detailed inline documentation.
• I have added unit tests to verify the code works as intended.
• I have updated the project documentation accordingly.

[justlevine]

Still a lot of changes here, with no justification of what/why.

Might make sense to move these into multiple (atomic) PRs, or to put them in our internal config for now until we can have a real discussion about what rules make it into a public ruleset and why.

[Pathan-Amaankhan]

Have migrated rulesets to internal config in d5767a3.

Please let me know if I should migrate the added plugins & extended rulesets also to the internal config.

[justlevine]

Unless you want to spend the extra justifying them (and the other preexisting ones that are included in @wordpress/eslint-plugin/recommended) ;-)

[justlevine]

:-/ Same problem as the previous (now closed PRs): i.e. this is changes a lot of configs, but there's

• no justification (inline or in the PR description) for the changes
• too much strictness going into an ecosystem package (vs our internal code that we could theoretically change up).

[Pathan-Amaankhan]

no justification (inline or in the PR description) for the changes

Please do let me know if I should go ahead and update the PR description explaining each ruleset along with the reason why we added it.

[justlevine]

Not finding some rules:

eslint-comments/require-description
jsx-closing-tag-location

[justlevine]

Call it a hunch, but I'm betting all the JSDoc type changes should be stripped out into their own PR

[Pathan-Amaankhan]

Not sure (Just doc rules) but we can do that also.

Please let me know and will create a separate PR.

[changeset-bot]

⚠️ No Changeset found

Latest commit: bf7eaf9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[Pathan-Amaankhan]

We will be breaking down this PR into smaller PRs so that it is easier to fix eslint error we get after adding the ruleset.
Keeping this PR in draft state so that we don't loose the change reference. Once all the nuclear PRs are merged, we can close this PR.

--- Edit ---
PR Lists:

1. refactor!: move ESLint overrides from package to local ruleset #86
2. chore: make repository ESLint ruleset stricter (first pass) #89
3. chore: cleanup ESLint rulesets #84
4. feat: Add recommended eslint rules for comments #98
5. chore: enforce dot-notation eslint rule #99
6. chore: Add eslint-comments/require-description eslint rule #100 (Dependencies: chore: cleanup ESLint rulesets #84)
7. feat: Add @stylistic/jsx/jsx-closing-tag-location eslint rule #101 (Dependencies: chore: cleanup ESLint rulesets #84)
8. chore: Add jsdoc/require-param-type eslint rule #102
9. feat: Add no-empty-function eslint rule #104

[justlevine]

@Pathan-Amaankhan is there anything left from this PR worth backporting or can we close?