Changes to help in excluding objects

Expensify · Jul 17, 2024 · baf7d27 · baf7d27
1 parent 6c9e140
commit baf7d27
Show file tree

Hide file tree

Showing 6 changed files with 362 additions and 21 deletions.
diff --git a/eslint-plugin-expensify/prefer-at.js b/eslint-plugin-expensify/prefer-at.js
@@ -1,10 +1,20 @@
+const {ESLintUtils} = require('@typescript-eslint/utils');
 const message = require('./CONST').MESSAGE.PREFER_AT;
 
 module.exports = {
     meta: {
         fixable: 'code',
     },
     create(context) {
+        const parserServices = ESLintUtils.getParserServices(context);
+        const typeChecker = parserServices.program.getTypeChecker();
+
+        function isArrayType(node) {
+            const tsNode = parserServices.esTreeNodeToTSNodeMap.get(node);
+            const type = typeChecker.getTypeAtLocation(tsNode);
+            return typeChecker.isArrayType(type) || typeChecker.isTupleType(type);
+        }
+
         function isLiteralNumber(node) {
             return node && node.type === 'Literal' && typeof node.value === 'number';
         }
@@ -21,6 +31,11 @@ module.exports = {
 
         function checkNode(node) {
             if (node.type === 'MemberExpression' && node.property) {
+                // Check if the object being accessed is an array
+                if (!isArrayType(node.object)) {
+                    return;
+                }
+
                 // Handle items cases like test[0]
                 if (isLiteralNumber(node.property)) {
                     context.report({

diff --git a/eslint-plugin-expensify/tests/file.ts b/eslint-plugin-expensify/tests/file.ts
diff --git a/eslint-plugin-expensify/tests/prefer-at.test.js b/eslint-plugin-expensify/tests/prefer-at.test.js
@@ -1,11 +1,14 @@
-const RuleTester = require('eslint').RuleTester;
+const RuleTester = require('@typescript-eslint/rule-tester').RuleTester;
 const rule = require('../prefer-at');
 const message = require('../CONST').MESSAGE.PREFER_AT;
 
 const ruleTester = new RuleTester({
+    parser: '@typescript-eslint/parser',
     parserOptions: {
-        ecmaVersion: 6,
+        project: './tsconfig.json',
+        tsconfigRootDir: __dirname,
         sourceType: 'module',
+        ecmaVersion: 2020,
     },
 });
 
@@ -29,6 +32,15 @@ ruleTester.run('prefer-at', rule, {
         {
             code: 'test.at((test.length - 1) / 2)',
         },
+        {
+            code: `
+                const object = {0: 'v0', 1: 'v1', 2: 'v2'};
+                object[0]
+                `,
+        },
+        {
+            code: '[0, 1, 2].at(1)',
+        },
     ],
     invalid: [
         {
@@ -46,21 +58,25 @@ ruleTester.run('prefer-at', rule, {
             }],
         },
         {
-            code: 'sample[sample.length-1]',
-            output: 'sample.at(-1)',
+            code: 'test[(test.length - 1) / 2]',
+            output: 'test.at((test.length - 1) / 2)',
             errors: [{
                 message,
             }],
-        },{
-            code: 'testing[testing.length-2]',
-            output: 'testing.at(-2)',
+        },
+        {
+            code: `
+                const sample = [];
+                sample[sample.length-1]
+                `,
+            output: 'sample.at(sample.length-1)',
             errors: [{
                 message,
             }],
         },
         {
-            code: 'test[(test.length - 1) / 2]',
-            output: 'test.at((test.length - 1) / 2)',
+            code: '[0, 1, 2][1]',
+            output: '[0, 1, 2].at(1)',
             errors: [{
                 message,
             }],

diff --git a/eslint-plugin-expensify/tests/tsconfig.json b/eslint-plugin-expensify/tests/tsconfig.json
@@ -0,0 +1,10 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "es5",
+    "sourceMap": true
+  },
+  "exclude": [
+    "node_modules"
+  ]
+}