misc tweaks

import-js · Jul 18, 2024 · 7091ee0 · 7091ee0
1 parent e96db1a
commit 7091ee0
Show file tree

Hide file tree

Showing 2 changed files with 64 additions and 39 deletions.
diff --git a/docs/rules/no-unused-modules.md b/docs/rules/no-unused-modules.md
@@ -29,8 +29,7 @@ This rule takes the following option:
 
  - **`missingExports`**: if `true`, files without any exports are reported (defaults to `false`)
  - **`unusedExports`**: if `true`, exports without any static usage within other modules are reported (defaults to `false`)
- - **`ignoreUnusedTypeExports`**: if `true`, type exports without any static usage within other modules are reported (defaults to `false` and has no effect unless `unusedExports` is `true`)
- - `src`: an array with files/paths to be analyzed. It only applies to unused exports. Defaults to `process.cwd()`, if not provided
+ - **`ignoreUnusedTypeExports`**: if `true`, TypeScript type exports without any static usage within other modules are reported (defaults to `false` and has no effect unless `unusedExports` is `true`) - `src`: an array with files/paths to be analyzed. It only applies to unused exports. Defaults to `process.cwd()`, if not provided
  - `ignoreExports`: an array with files/paths for which unused exports will not be reported (e.g module entry points in a published package)
 
 ### Example for missing exports
@@ -117,7 +116,9 @@ export function doAnything() {
 export default 5 // will not be reported
 ```
 
-### Example for unused exports with `ignoreUnusedTypeExports` set to `true`
+### Unused exports with `ignoreUnusedTypeExports` set to `true`
+
+The following will not be reported:
 
 ```ts
 export type Foo = {}; // will not be reported

diff --git a/tests/src/rules/no-unused-modules.js b/tests/src/rules/no-unused-modules.js
@@ -1148,24 +1148,6 @@ context('TypeScript', function () {
           parser,
           filename: testFilePath('./no-unused-modules/typescript/file-ts-e-used-as-type.ts'),
         }),
-        test({
-          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
-          code: `export interface c {};`,
-          parser,
-          filename: testFilePath('./no-unused-modules/typescript/file-ts-c-used-as-type.ts'),
-        }),
-        test({
-          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
-          code: `export type d = {};`,
-          parser,
-          filename: testFilePath('./no-unused-modules/typescript/file-ts-d-used-as-type.ts'),
-        }),
-        test({
-          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
-          code: `export enum e { f };`,
-          parser,
-          filename: testFilePath('./no-unused-modules/typescript/file-ts-e-used-as-type.ts'),
-        }),
         // Should also be valid when the exporting files are linted before the importing ones
         isESLint4TODO ? [] : test({
           options: unusedExportsTypescriptOptions,
@@ -1191,24 +1173,6 @@ context('TypeScript', function () {
           parser,
           filename: testFilePath('./no-unused-modules/typescript/file-ts-f-import-type.ts'),
         }),
-        test({
-          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
-          code: `export interface c {};`,
-          parser,
-          filename: testFilePath('./no-unused-modules/typescript/file-ts-c-unused.ts'),
-        }),
-        test({
-          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
-          code: `export type d = {};`,
-          parser,
-          filename: testFilePath('./no-unused-modules/typescript/file-ts-d-unused.ts'),
-        }),
-        test({
-          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
-          code: `export enum e { f };`,
-          parser,
-          filename: testFilePath('./no-unused-modules/typescript/file-ts-e-unused.ts'),
-        }),
       ),
       invalid: [].concat(
         test({
@@ -1252,6 +1216,66 @@ context('TypeScript', function () {
   });
 });
 
+describe('ignoreUnusedTypeExports', () => {
+  getTSParsers().forEach((parser) => {
+    typescriptRuleTester.run('no-unused-modules', rule, {
+      valid: [
+        // unused vars should not report
+        test({
+          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+          code: `export interface c {};`,
+          parser,
+          filename: testFilePath(
+            './no-unused-modules/typescript/file-ts-c-unused.ts',
+          ),
+        }),
+        test({
+          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+          code: `export type d = {};`,
+          parser,
+          filename: testFilePath(
+            './no-unused-modules/typescript/file-ts-d-unused.ts',
+          ),
+        }),
+        test({
+          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+          code: `export enum e { f };`,
+          parser,
+          filename: testFilePath(
+            './no-unused-modules/typescript/file-ts-e-unused.ts',
+          ),
+        }),
+        // used vars should not report
+        test({
+          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+          code: `export interface c {};`,
+          parser,
+          filename: testFilePath(
+            './no-unused-modules/typescript/file-ts-c-used-as-type.ts',
+          ),
+        }),
+        test({
+          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+          code: `export type d = {};`,
+          parser,
+          filename: testFilePath(
+            './no-unused-modules/typescript/file-ts-d-used-as-type.ts',
+          ),
+        }),
+        test({
+          options: unusedExportsTypescriptIgnoreUnusedTypesOptions,
+          code: `export enum e { f };`,
+          parser,
+          filename: testFilePath(
+            './no-unused-modules/typescript/file-ts-e-used-as-type.ts',
+          ),
+        }),
+      ],
+      invalid: [],
+    });
+  });
+});
+
 describe('correctly work with JSX only files', () => {
   jsxRuleTester.run('no-unused-modules', rule, {
     valid: [