feat: added basic eslint to repo

Author: anasstahr

.eslintignore

@@ -0,0 +1,6 @@
+node_modules
+dist
+out
+coverage
+.vscode
+.git

.eslintrc.js

@@ -0,0 +1,114 @@
+/* [object Object]*/ module.exports = {
+    root: true,
+    parser: '@typescript-eslint/parser',
+    parserOptions: {
+        ecmaVersion: 'latest',
+        sourceType: 'module',
+        requireConfigFile: false,
+    },
+    env: {
+        node: true,
+        mocha: true,
+        es2024: true,
+    },
+    plugins: ['@typescript-eslint', '@stylistic', 'unicorn', 'header', 'security-node'],
+    extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/eslint-recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:prettier/recommended',
+    ],
+    rules: {
+        curly: 2, // Enforce braces on "if"/"for"/etc.
+        'id-length': [
+            'error',
+            {
+                min: 1,
+                max: 40,
+                exceptionPatterns: [
+                    '^INSERT_TO_CURSOR_POSITION_NOTIFICATION_METHOD$',
+                    '^DID_CHANGE_DEPENDENCY_PATHS_NOTIFICATION_METHOD$',
+                ],
+            },
+        ],
+        // https://typescript-eslint.io/rules/naming-convention/
+        '@typescript-eslint/naming-convention': [
+            'error',
+            {
+                selector: 'default',
+                format: ['camelCase', 'PascalCase'],
+                // Allow underscores.
+                leadingUnderscore: 'allowSingleOrDouble',
+                trailingUnderscore: 'allowSingleOrDouble',
+            },
+            // Allow object properties, enums, and methods to have any format
+            {
+                selector: ['objectLiteralProperty', 'classMethod', 'enumMember'],
+                format: null,
+            },
+            // Allow constants to use UPPER_CASE
+            {
+                selector: 'variable',
+                modifiers: ['const'],
+                format: ['camelCase', 'PascalCase', 'UPPER_CASE'],
+            },
+        ],
+        // Avoid accidental use of "==" instead of "===".
+        eqeqeq: 'error',
+        '@typescript-eslint/no-namespace': 'error',
+        '@typescript-eslint/no-floating-promises': 'off', // Temporarily disabled
+        '@typescript-eslint/no-redundant-type-constituents': 'off', // Temporarily disabled
+        '@typescript-eslint/no-unused-vars': 'error',
+        '@typescript-eslint/no-explicit-any': 'off', // Temporarily disabled
+        // Do not check loops so while(true) works.
+        'no-constant-condition': ['error', { checkLoops: false }],
+
+        // https://eslint.style/rules/default/spaced-comment
+        // Require space after // comment.
+        '@stylistic/spaced-comment': [
+            'error',
+            'always',
+            {
+                block: {
+                    markers: ['!'], // Allow the /*!…*/ license header.
+                },
+            },
+        ],
+
+        // Rules from https://github.com/sindresorhus/eslint-plugin-unicorn
+        'unicorn/no-abusive-eslint-disable': 'error',
+        'unicorn/no-null': 'off', // Temporarily disabled
+        'unicorn/no-unnecessary-polyfills': 'error',
+        'unicorn/no-useless-spread': 'error',
+        'unicorn/prefer-array-some': 'error',
+        'unicorn/prefer-blob-reading-methods': 'error',
+        'unicorn/prefer-code-point': 'error',
+        'unicorn/prefer-date-now': 'error',
+        'unicorn/prefer-dom-node-text-content': 'error',
+        'unicorn/prefer-includes': 'error',
+        'unicorn/prefer-keyboard-event-key': 'error',
+        'unicorn/prefer-modern-dom-apis': 'error',
+        'unicorn/prefer-modern-math-apis': 'error',
+        'unicorn/prefer-native-coercion-functions': 'error',
+        'unicorn/prefer-reflect-apply': 'error',
+        'unicorn/prefer-string-trim-start-end': 'error',
+        'unicorn/prefer-type-error': 'error',
+        // Discourage `.forEach` because it can lead to accidental, incorrect use of async callbacks.
+        'unicorn/no-array-for-each': 'error',
+        'security-node/detect-child-process': 'error',
+
+        // TODO: do we want to enable this?
+        // 'header/header': [
+        //     'error',
+        //     'block',
+        //     {
+        //         pattern:
+        //             'Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.\\r?\\n \\* SPDX-License-Identifier: Apache-2.0',
+        //     },
+        //     { lineEndings: 'unix' },
+        // ],
+
+        'prettier/prettier': ['error', { endOfLine: 'auto' }],
+    },
+    ignorePatterns: ['node_modules/**', 'dist/**', 'out/**', 'coverage/**', '.vscode/**', '.git/**'],
+}

package.json

@@ -29,6 +29,7 @@
         "precompile": "npm run generate-types --workspaces --if-present",
         "compile": "tsc --build && npm run compile --workspaces --if-present",
         "check:formatting": "prettier --check .",
+        "lint": "npx eslint . --ext .ts",
         "format": "prettier . --write",
         "format-staged": "npx pretty-quick --staged",
         "prepare": "husky .husky",