feat: add no-unused-exports rule

gajus · Feb 7, 2023 · ad22fe4 · ad22fe4
1 parent 87b9799
commit ad22fe4
Show file tree

Hide file tree

Showing 3 changed files with 36 additions and 13 deletions.
diff --git a/.README/rules/no-unused-exports.md b/.README/rules/no-unused-exports.md
@@ -1,13 +1,15 @@
 ### `no-unused-exports`
 
-Identifies unused exports.
+Identifies unused TypeScript exports.
 
-> **Note** This rule uses [`ts-unused-exports`](https://github.com/pzavolinsky/ts-unused-exports) program behind the scenes.
+> **Note** This rule is implemented using [`ts-unused-exports`](https://github.com/pzavolinsky/ts-unused-exports).
 
 #### Options
 
-|Config|Type|Description|
-|---|---|---|
-|`tsConfigPath`|string|Path to [tsconfig.json](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)]
+|Config|Type|Required|Default|Description|
+|---|---|---|---|---|
+|`tsConfigPath`|string|Required||Path to [tsconfig.json](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)|
+|`allowUnusedEnums`|boolean||`false`|Allow unused `enum`s.|
+|`allowUnusedTypes`|boolean||`false`|Allow unused `type` and `interface`.|
 
-<!-- assertions noUnusedExports -->
+<!-- assertions noUnusedExports -->
diff --git a/README.md b/README.md
@@ -309,18 +309,19 @@ The 1st option is an array of strings that cannot be contained in the codebase.
 <a name="eslint-plugin-canonical-rules-no-unused-exports"></a>
 ### <code>no-unused-exports</code>
 
-Identifies unused exports.
+Identifies unused TypeScript exports.
 
-> **Note** This rule uses [`ts-unused-exports`](https://github.com/pzavolinsky/ts-unused-exports) program behind the scenes.
+> **Note** This rule is implemented using [`ts-unused-exports`](https://github.com/pzavolinsky/ts-unused-exports).
 
 <a name="user-content-eslint-plugin-canonical-rules-no-unused-exports-options-2"></a>
 <a name="eslint-plugin-canonical-rules-no-unused-exports-options-2"></a>
 #### Options
 
-|Config|Type|Description|
-|---|---|---|
-|`tsConfigPath`|string|Path to [tsconfig.json](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)]
-
+|Config|Type|Required|Default|Description|
+|---|---|---|---|---|
+|`tsConfigPath`|string|Required||Path to [tsconfig.json](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html)|
+|`allowUnusedEnums`|boolean||`false`|Allow unused `enum`s.|
+|`allowUnusedTypes`|boolean||`false`|Allow unused `type` and `interface`.|
 
 
 <a name="user-content-eslint-plugin-canonical-rules-no-use-extend-native"></a>

diff --git a/src/rules/noUnusedExports.ts b/src/rules/noUnusedExports.ts
@@ -2,11 +2,15 @@ import analyzeTsConfig from 'ts-unused-exports';
 import { createRule } from '../utilities';
 
 const defaultOptions = {
+  allowUnusedEnums: false,
+  allowUnusedTypes: false,
   tsConfigPath: '',
 };
 
 type Options = [
   {
+    allowUnusedEnums: boolean;
+    allowUnusedTypes: boolean;
     tsConfigPath: string;
   },
 ];
@@ -17,7 +21,17 @@ export default createRule<Options, MessageIds>({
   create: (context) => {
     const [options] = context.options;
 
-    const result = analyzeTsConfig(options.tsConfigPath);
+    const tsUnusedOptions: string[] = [];
+
+    if (options.allowUnusedEnums) {
+      tsUnusedOptions.push('--allowUnusedEnums');
+    }
+
+    if (options.allowUnusedTypes) {
+      tsUnusedOptions.push('--allowUnusedTypes');
+    }
+
+    const result = analyzeTsConfig(options.tsConfigPath, tsUnusedOptions);
 
     return {
       Program() {
@@ -65,6 +79,12 @@ export default createRule<Options, MessageIds>({
       {
         additionalProperties: false,
         properties: {
+          allowUnusedEnums: {
+            type: 'boolean',
+          },
+          allowUnusedTypes: {
+            type: 'boolean',
+          },
           tsConfigPath: {
             type: 'string',
           },