Update README.md for #1256 (#1277)

import-js · Jan 30, 2019 · bdc05aa · bdc05aa · Kerumen · Mar 13, 2019
1 parent 9bac44e
commit bdc05aa
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -144,6 +144,22 @@ rules:
   # etc...
 ```
 
+# Typescript
+
+You may use the following shortcut or assemble your own config using the granular settings described below.
+
+Make sure you have installed the [`@typescript-eslint/parser`] which is used in the following configuration. Unfortunately NPM does not allow to list optional peer dependencies. 
+
+```yaml
+extends:
+  - eslint:recommended
+  - plugin:import/errors
+  - plugin:import/warnings
+  - plugin:import/typescript # this line does the trick
+```
+
+[`@typescript-eslint/parser`]: https://github.com/typescript-eslint/typescript-eslint/tree/master/packages/parser
+
 # Resolvers
 
 With the advent of module bundlers and the current state of modules and module

diff --git a/config/typescript.js b/config/typescript.js
@@ -10,7 +10,7 @@ module.exports = {
   settings: {
     'import/extensions': allExtensions,
     'import/parsers': {
-      'typescript-eslint-parser': tsExtensions
+      '@typescript-eslint/parser': tsExtensions
     },
     'import/resolver': {
       'node': {