ESLint TypeScript Configuration Package #20
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
To support projects build with TypeScript (1), a new `@arcticicestudio/eslint-config-typescript` package has been implemented using the awesome @typescript-eslint (2) project. It will mainly extend `@typescript-eslint/eslint-plugin`'s already provided and recommended configurations (3) in order to adapt best practices: 1. `plugin:@typescript-eslint/eslint-recommended` 2. `plugin:@typescript-eslint/recommended` 3. `plugin:@typescript-eslint/recommended-requiring-type-checking` The `@typescript-eslint/parser` (4) is set as ESLint parser. Also as of `@typescript-eslint/parser` version `2.0.0` (5) (also see typescript-eslint/typescript-eslint#890 (6)), the parser will panic when parsing files that are not included within the provided tsconfig(s). The package documentation contains instructions and a quick setup and usage guide to inform about the required `tsconfig` configurations (7) and the corresponding `eslintrc` changes. Next to the support for TypeScript, the package also modifies some React and import related rules in order to prevent conflicts, like the adaption of the `.ts` and `.tsx` extensions for all JS and JSX files as well as removing `.jsx` to force the usage of `.tsx`. There are other rules that have been disabled like the check for valid React `prop-types` since these and not necessary anymore when working with TypeScript. The new package provides two entry points, available as `@arcticicestudio/eslint-config-typescript` (main) and `@arcticicestudio/eslint-config-typescript/prettier` that can both be composed with all other available entry points (8) to inherit their rules. This package mainly depends on the `@typescript-eslint/eslint-plugin@^2.0.0` and `@typescript-eslint/parser@^2.0.0` packages as peer dependencies. References: (1) https://www.typescriptlang.org (2) https://github.com/typescript-eslint/typescript-eslint (3) https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/eslint-plugin/src/configs (4) https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser (5) https://github.com/typescript-eslint/typescript-eslint/releases/tag/v2.0.0 (6) typescript-eslint/typescript-eslint#890 (7) https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser#configuration (8) https://github.com/arcticicestudio/styleguide-javascript/blob/develop/packages/%40arcticicestudio/eslint-config/README.md#entry-points GH-19
svengreb
approved these changes
Aug 20, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #19