@ornikar/eslint-plugin-ornikar 21.0.0 → 21.2.0

package/CHANGELOG.md

@@ -3,6 +3,31 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [21.2.0](https://github.com/ornikar/eslint-configs/compare/v21.1.0...v21.2.0) (2023-11-02)
+
+
+### Features
+
+* eslint-plugin-ornikar improve ignoreFiles in typescript-no-unused-exports [no issue] ([#633](https://github.com/ornikar/eslint-configs/issues/633)) ([db2c331](https://github.com/ornikar/eslint-configs/commit/db2c3311de9c53a4f74b30954af273195b9d8f90))
+
+
+
+## [21.1.0](https://github.com/ornikar/eslint-configs/compare/v21.0.0...v21.1.0) (2023-10-20)
+
+
+### Features
+
+* **deps:** update typescript-eslint monorepo to v6.8.0 ([#624](https://github.com/ornikar/eslint-configs/issues/624)) ([2b51343](https://github.com/ornikar/eslint-configs/commit/2b51343a953af6cc468f2c16447b4da4d4bc6e9e))
+* **eslint-plugin-ornikar:** add typescript-no-unused-exports rule [no issue] ([#632](https://github.com/ornikar/eslint-configs/issues/632)) ([b5baffe](https://github.com/ornikar/eslint-configs/commit/b5baffef16c3e8e274d5398c303e09ed2d322219))
+
+
+### Bug Fixes
+
+* **deps:** update typescript-eslint monorepo to v6.7.4 ([#616](https://github.com/ornikar/eslint-configs/issues/616)) ([c3eb1ce](https://github.com/ornikar/eslint-configs/commit/c3eb1ce5126a26b5fd740e7b1153a6cd015c3bc3))
+* **eslint-plugin-ornikar:** ignore mocks and generated files ([02b6cbf](https://github.com/ornikar/eslint-configs/commit/02b6cbf5c006d25f540895b2304b3a31e1942345))
+
+
+
 ## [21.0.0](https://github.com/ornikar/eslint-configs/compare/v20.2.1...v21.0.0) (2023-09-26)
 
 

package/configs/all.js

@@ -4,5 +4,6 @@ module.exports = {
   rules: {
     '@ornikar/ornikar/forbid-fetch-import': 'error',
     '@ornikar/ornikar/react-function-component-return-react-node': 'error',
+    '@ornikar/ornikar/typescript-no-unused-exports': 'off', // experimental
   },
 };

package/fixtures/tsconfig.json

@@ -3,6 +3,7 @@
     "jsx": "preserve",
     "target": "es5",
     "module": "commonjs",
+    "moduleDetection": "force",
     "strict": true
   },
   "include": ["**/*.ts", "**/*.tsx"]

package/fixtures/unused-export.ts

@@ -0,0 +1 @@
+export function UnusedExport(): void {}

package/fixtures/used-export.ts

@@ -0,0 +1 @@
+export function UsedExport(): void {}

package/fixtures/using-exports.ts

@@ -0,0 +1 @@
+import { UsedExport } from './used-export';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ornikar/eslint-plugin-ornikar",
-  "version": "21.0.0",
+  "version": "21.2.0",
   "description": "eslint plugin for ornikar",
   "repository": {
     "directory": "@ornikar/eslint-plugin-ornikar",
@@ -19,7 +19,13 @@
     ]
   },
   "peerDependencies": {
-    "eslint": "^8.39.0"
+    "eslint": "^8.39.0",
+    "typescript": ">=5.2.2"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
   },
   "scripts": {
     "lint:eslint": "yarn ../.. eslint --report-unused-disable-directives --quiet @ornikar/eslint-plugin-ornikar"
@@ -29,16 +35,17 @@
     ".": "./index.js"
   },
   "dependencies": {
-    "eslint-plugin-react": "^7.33.2"
+    "@typescript-eslint/utils": "6.8.0",
+    "eslint-plugin-react": "^7.33.2",
+    "ts-unused-exports": "^10.0.1"
   },
   "devDependencies": {
     "@eslint/eslintrc": "2.1.2",
-    "@typescript-eslint/rule-tester": "6.7.2",
-    "@typescript-eslint/utils": "6.7.2",
-    "eslint": "8.49.0"
+    "@typescript-eslint/rule-tester": "6.8.0",
+    "eslint": "8.52.0",
+    "typescript": "5.2.2"
   },
   "engines": {
     "node": ">=18.18.0"
-  },
-  "gitHead": "99c0a576f6ee3da108b9101453f6a0954c54b33e"
-}
+  }
+}

package/rules/typescript-no-unused-exports.js

@@ -0,0 +1,115 @@
+'use strict';
+
+const path = require('node:path');
+// eslint-disable-next-line import/no-unresolved -- missing main in package.json
+const { ESLintUtils } = require('@typescript-eslint/utils');
+const { default: analyzeTsConfig } = require('ts-unused-exports');
+
+exports.meta = {
+  type: 'problem',
+
+  docs: {
+    description: 'Identifies unused exports using "ts-unused-exports". Made for usage with vscode only.',
+    category: 'Best Practices',
+    recommended: false, // experimental
+  },
+
+  messages: {
+    unusedExport: "Export '{{exportName}}' is unused.",
+    removeExport: "Remove export '{{exportName}}'.",
+  },
+
+  hasSuggestions: true,
+
+  schema: [
+    {
+      additionalProperties: false,
+      properties: {
+        allowUnusedEnums: {
+          type: 'boolean',
+        },
+        allowUnusedTypes: {
+          type: 'boolean',
+        },
+        ignoreFiles: {
+          type: 'string',
+        },
+      },
+      type: 'object',
+    },
+  ],
+};
+
+function getSuggestionFixer(node) {
+  return (fixer) => {
+    return fixer.remove(node);
+  };
+}
+
+exports.create = (context) => {
+  const options = context.options || {};
+
+  const services = ESLintUtils.getParserServices(context);
+  // configFilePath is all lowercase on mac
+  const tsconfigPathLowercased = services.program.getCompilerOptions().configFilePath;
+  // should cover ornikar case.
+  const tsconfigPath = path.join(process.cwd(), path.relative(process.cwd().toLowerCase(), tsconfigPathLowercased));
+
+  const tsUnusedOptions = [
+    '--ignoreFiles=/(__mocks__|__generated__)/',
+    '--ignoreFiles=[.](web|ios|android)$',
+    '--ignoreFiles=apollo/typeDefs$',
+  ];
+
+  if (options.allowUnusedEnums) {
+    tsUnusedOptions.push('--allowUnusedEnums');
+  }
+
+  if (options.allowUnusedTypes) {
+    tsUnusedOptions.push('--allowUnusedTypes');
+  }
+
+  if (options.ignoreFiles) {
+    tsUnusedOptions.push(`--ignoreFiles=${options.ignoreFiles}`);
+  }
+
+  const result = analyzeTsConfig(tsconfigPath, tsUnusedOptions);
+
+  return {
+    Program() {
+      const filename = context.getFilename();
+
+      if (!result[filename]) {
+        return;
+      }
+
+      const sourceCode = context.getSourceCode();
+
+      for (const unusedExport of result[filename]) {
+        const index = sourceCode.getIndexFromLoc({
+          column: unusedExport.location.character,
+          line: unusedExport.location.line,
+        });
+
+        const exportToken = sourceCode.getTokenByRangeStart(index);
+
+        if (!exportToken) {
+          throw new Error('Expected export node');
+        }
+
+        context.report({
+          node: exportToken,
+          messageId: 'unusedExport',
+          data: { exportName: unusedExport.exportName },
+          suggest: [
+            {
+              messageId: 'removeExport',
+              data: { exportName: unusedExport.exportName },
+              fix: getSuggestionFixer(exportToken),
+            },
+          ],
+        });
+      }
+    },
+  };
+};

package/rules/typescript-no-unused-exports.test.js

@@ -0,0 +1,49 @@
+'use strict';
+
+const fs = require('node:fs');
+const path = require('node:path');
+const { RuleTester } = require('./test-utils/RuleTester');
+const rule = require('./typescript-no-unused-exports');
+
+const ruleTester = new RuleTester({
+  parser: require.resolve('@typescript-eslint/parser'),
+  parserOptions: {
+    tsconfigRootDir: path.join(__dirname, '../fixtures'),
+    project: './tsconfig.json',
+  },
+});
+
+const fixturesPath = path.join(__dirname, '../fixtures');
+
+ruleTester.run('typescript-no-unused-exports', rule, {
+  valid: [
+    {
+      filename: path.join(fixturesPath, 'used-export.ts'),
+      code: fs.readFileSync(path.join(fixturesPath, 'used-export.ts'), 'utf8'),
+    },
+  ],
+  invalid: [
+    {
+      filename: path.join(fixturesPath, 'unused-export.ts'),
+      code: fs.readFileSync(path.join(fixturesPath, 'unused-export.ts'), 'utf8'),
+      errors: [
+        {
+          messageId: 'unusedExport',
+          data: { exportName: 'UnusedExport' },
+          line: 1,
+          endLine: 1,
+          column: 1,
+          endColumn: 7,
+          suggestions: [
+            {
+              messageId: 'removeExport',
+              data: { exportName: 'UnusedExport' },
+              output: ` function UnusedExport(): void {}
+`,
+            },
+          ],
+        },
+      ],
+    },
+  ],
+});