BREAKING CHANGE: Feat/move tools to peer deps

[marcusrbrown]

NOTE: This is waiting on #61 so has been raised as a draft while that one is reviewed. Once that PR is updated, I'll rebase against main.

Description

Make all optional dependencies optional peer dependencies. After this change, to use amex/test you will need to install required peer dependencies:

npm install --save-dev typescript eslint eslint-plugin-jest eslint-plugin-jest-dom eslint-config-amex

To use amex/prettier/test you will need to use:

npm install --save-dev prettier typescript eslint eslint-plugin-jest eslint-plugin-jest-dom eslint-plugin-prettier eslint-config-amex

Please make sure that the PR fulfills these requirements

• I checked that there aren't other open Pull Requests for the same update/change.
• My code follows the code style of this project.
• My change requires a change to the documentation and I have updated the documentation accordingly.
• Rule changes includes a comment to describe the reasoning behind the change.
• PR contains a single rule change.

Motivation and Context

This package provides a main ESLint configuration and a few optional ones. The optional ones are specified as dependencies. In particular Prettier and TypeScript have highly opinionated setups so we should not impose a tool or version on consumers. This is in line with eslint-config-airbnb and other ESLint config bundles that provide optional configurations.

How Has This Been Tested?

The existing tests are used. Do we need tests for the new optional peer dependencies?

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 not work as expected)
• Documentation (adding or updating documentation)
• Dependency update

[ghost]

I might be out of the loop here, but why is typescript needed for jest support?

[marcusrbrown]

eslint-plugin-jest has a direct dependency on a package called @typescript-eslint/experimental-utils which eventually pulls in a package that depends on tsutils, which requires typescript:

jest-community/eslint-plugin-jest#339

I think that their removal of typescript from dependencies of that package was a mistake, as the plugin cannot function without it and the warning is buried under a transient dependency. I'll probably raise a PR over there but I'd rather eslint-config-amex not bring TypeScript along with it in the default configurations.