feat: initial replacement of tslint with eslint

Author: michaelwittwer

eslint-plugins/no-dynamo.js

@@ -0,0 +1,36 @@
+/**
+ * Custom ESLint plugin for dynamo-easy specific rules
+ */
+
+// eslint-disable-next-line import/no-internal-modules
+import { noDynamoNamedImport } from '../eslint-rules/no-dynamo-named-import'
+
+const DEFAULT_RULE_NS = `dynamo-easy`
+
+/** @type { import '@eslint/core'.Plugin } */
+const meta = { name: 'dynamo-easy/eslint-plugin-rules', haba: "gugu" }
+
+/** @type Record<string, RuleDefinition>  */
+const rules = {
+  'no-dynamo-named-import': noDynamoNamedImport
+}
+
+/** @type Record<string, ConfigObject> */
+const configs = {
+  recommended: {
+    name: 'recommended',
+    plugins: {
+      [DEFAULT_RULE_NS]: { meta, rules },
+    },
+    rules: {
+      [`${DEFAULT_RULE_NS}/deny-parent-index-file-import`]: 'error',
+      [`${DEFAULT_RULE_NS}/prefix-builtin-module-import`]: 'error',
+    },
+  },
+}
+
+export default {
+  meta,
+  rules,
+  configs,
+}

eslint-rules/no-dynamo-named-import.js

@@ -0,0 +1,37 @@
+/**
+ * Custom ESLint rule: no-dynamo-named-import
+ *
+ * We prevent named imports from aws-sdk/clients/dynamodb, this is a design decision to be more obvious about where the
+ * import is from, this is not common practice but because our code has a lot of code dependent on dynamoDB we do this
+ * for easier reading and understanding
+ */
+
+import { ESLintUtils } from '@typescript-eslint/utils'
+
+export const noDynamoNamedImport = ESLintUtils.RuleCreator.withoutDocs(() => {
+  return {
+    create(context) {
+      return {
+        ImportDeclaration(node) {
+          const moduleName = node.source.value
+
+          if (moduleName === 'aws-sdk/clients/dynamodb') {
+            // Check if it's a named import
+            if (node.specifiers && node.specifiers.length > 0) {
+              const hasNamedImport = node.specifiers.some(
+                (specifier) => specifier.type === 'ImportSpecifier'
+              )
+
+              if (hasNamedImport) {
+                context.report({
+                  node,
+                  messageId: 'namedImportNotAllowed',
+                })
+              }
+            }
+          }
+        },
+      }
+    },
+  }
+})

eslint-rules/no-dynamo-named-import.test.js

@@ -0,0 +1,57 @@
+/**
+ * Test for the no-dynamo-named-import ESLint rule
+ */
+
+// eslint-disable-next-line import/no-internal-modules
+import {noDynamoNamedImport} from '../eslint-rules/no-dynamo-named-import.js'
+import {RuleTester} from 'eslint'
+
+const ruleTester = new RuleTester({
+  languageOptions: {
+    parserOptions: {
+      ecmaVersion: 2020,
+      sourceType: 'module',
+    },
+  },
+})
+
+ruleTester.run('no-dynamo-named-import', noDynamoNamedImport, {
+  valid: [
+    // Wildcard import is allowed
+    {
+      code: "import * as DynamoDB from 'aws-sdk/clients/dynamodb'",
+    },
+    // Imports from other modules are allowed
+    {
+      code: "import * as moment from 'moment'",
+    },
+    {
+      code: "import { Config } from 'aws-sdk'",
+    },
+  ],
+
+  invalid: [
+    // Named imports from aws-sdk/clients/dynamodb are not allowed
+    {
+      code: "import { Key } from 'aws-sdk/clients/dynamodb'",
+      errors: [
+        {
+          messageId: 'namedImportNotAllowed',
+        },
+      ],
+    },
+    // Multiple named imports also not allowed
+    {
+      code: "import { Key, AttributeMap } from 'aws-sdk/clients/dynamodb'",
+      errors: [
+        {
+          messageId: 'namedImportNotAllowed',
+        },
+      ],
+    },
+  ],
+})
+
+// eslint-disable-next-line no-undef
+console.log('All tests passed!')
+

eslint.config.js

@@ -0,0 +1,35 @@
+import { defineScTsConfig } from '@shiftcode/eslint-config-recommended'
+// import noDynamoPlugin from './eslint-plugins/no-dynamo.js'
+
+export default [
+  ...defineScTsConfig({
+    languageOptions: { parserOptions: { project: ['./tsconfig.lint.json'] } },
+  }),
+  {
+    files: ['**/*.{ts,mts,cts,js,mjs,cjs}'],
+    rules: {
+      '@typescript-eslint/naming-convention': 'off',
+      '@typescript-eslint/no-unsafe-member-access': 'off',
+      '@typescript-eslint/no-array-constructor': 'off',
+      '@typescript-eslint/no-redundant-type-constituents': 'off',
+      '@typescript-eslint/no-unsafe-return': 'off',
+      '@typescript-eslint/no-unsafe-call': 'off',
+      '@typescript-eslint/restrict-template-expressions': 'off',
+      '@typescript-eslint/require-await': 'off',
+      'simple-import-sort/exports': 'off',
+      'simple-import-sort/imports': 'off',
+      '@typescript-eslint/switch-exhaustiveness-check': 'off',
+      '@typescript-eslint/member-ordering': 'off',
+    }
+  },
+  {
+    files: ['**/*.{ts,mts,cts,js,mjs,cjs}'],
+    ignores: [
+      'src/**/*', // ignore all files inside src/
+      '!src/**/*.{spec,test}.ts', // un-ignore test files
+    ],
+    rules: {
+      'unused-imports/no-unused-vars': 'off'
+    }
+  }
+]

jest.config.js

@@ -1,4 +1,5 @@
 /** @type {import('ts-jest').JestConfigWithTsJest} */
+// eslint-disable-next-line no-undef
 module.exports = {
   preset: 'ts-jest',
   testEnvironment: 'node',