cleanup with prefer-inline and better docs

import-js · Nov 8, 2022 · 0a2f060 · 0a2f060
1 parent 5d5a2d8
commit 0a2f060
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 8 deletions.
diff --git a/docs/rules/no-duplicates.md b/docs/rules/no-duplicates.md
@@ -69,25 +69,31 @@ import * from './mod.js?minify'
 
 ### Inline Type imports
 
-TypeScript 4.5 introduced a new [feature](https://devblogs.microsoft.com/typescript/announcing-typescript-4-5/#type-on-import-names) that allows mixing of named value and type imports. In order to support fixing to an inline type import when duplicate imports are detected, `preferInline` can be set to true.
+TypeScript 4.5 introduced a new [feature](https://devblogs.microsoft.com/typescript/announcing-typescript-4-5/#type-on-import-names) that allows mixing of named value and type imports. In order to support fixing to an inline type import when duplicate imports are detected, `prefer-inline` can be set to true.
 
 Config:
 
 ```json
-"import/no-duplicates": ["error", {"preferInline": true}]
+"import/no-duplicates": ["error", {"prefer-inline": true}]
 ```
 
+<!--tabs-->
+
+❌ Invalid
+
 ```js
 import { AValue, type AType } from './mama-mia'
 import type { BType } from './mama-mia'
 ```
 
-will fix to
+✅ Valid with `["error", "prefer-inline"]`
 
 ```js
 import { AValue, type AType, type BType } from './mama-mia'
 ```
 
+<!--tabs-->
+
 ## When Not To Use It
 
 If the core ESLint version is good enough (i.e. you're _not_ using Flow and you _are_ using [`import/extensions`](./extensions.md)), keep it and don't use this.

diff --git a/src/rules/no-duplicates.js b/src/rules/no-duplicates.js
@@ -109,8 +109,8 @@ function getFix(first, rest, sourceCode, context) {
     const [specifiersText] = specifiers.reduce(
       ([result, needsComma], specifier) => {
         const isTypeSpecifier = specifier.importNode.importKind === 'type';
-        const preferInline = context.options[0] && context.options[0].preferInline;
-        const insertText = `${preferInline && isTypeSpecifier ? 'type ' : ''}${specifier.text}`;
+        const preferInline = context.options[0] && context.options[0]['prefer-inline'];
+        const insertText = `${prefer-inline && isTypeSpecifier ? 'type ' : ''}${specifier.text}`;
         return [
           needsComma && !specifier.isEmpty
             ? `${result},${insertText}`
@@ -260,7 +260,7 @@ module.exports = {
           considerQueryString: {
             type: 'boolean',
           },
-          preferInline: {
+          'prefer-inline': {
             type: 'boolean',
           },
         },

diff --git a/tests/src/rules/no-duplicates.js b/tests/src/rules/no-duplicates.js
@@ -538,7 +538,7 @@ context('TypeScript', function () {
         test({
           code: "import {type x} from './foo'; import type {y} from './foo'",
           ...parserConfig,
-          options: [{ 'preferInline': false }],
+          options: [{ 'prefer-inline': false }],
           output: `import {type x,y} from './foo'; `,
           errors: [
             {
@@ -556,7 +556,7 @@ context('TypeScript', function () {
         test({
           code: "import {type x} from 'foo'; import type {y} from 'foo'",
           ...parserConfig,
-          options: [{ 'preferInline': true }],
+          options: [{ 'prefer-inline': true }],
           output: `import {type x,type y} from 'foo'; `,
           errors: [
             {