sdk-typescript/strands-ts/eslint.config.js at 392a18415fa286473a34b426b2defaee92b35aa5 · gautamsirdeshmukh/sdk-typescript · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
import eslint from '@eslint/js'
import tseslint from '@typescript-eslint/eslint-plugin'
import tsparser from '@typescript-eslint/parser'
import tsdoc from 'eslint-plugin-tsdoc'

export default [
  eslint.configs.recommended,
  {
    rules: {
      // Disabled: TypeScript compiler catches all redeclaration cases and
      // understands value/type namespace merging (e.g., const + type with
      // same name). See https://typescript-eslint.io/rules/no-redeclare/
      'no-redeclare': 'off',
    },
  },
  // Apply SDK rules to src files
  sdkRules({
    files: ['src/**/*.ts'],
    tsconfig: './src/tsconfig.json',
  }),
  // Prevent non-vended-tools from importing vended-tools
  noVendedToolsImports({
    files: ['src/**/*.ts'],
    ignores: ['src/vended-tools/**/*.ts'],
  }),
  // Then unit-test rules to UTs
  unitTestRules({
    files: ['src/**/__tests__/**/*.ts'],
    tsconfig: './src/tsconfig.json',
  }),
  // Apply UT rules to the integ tests
  unitTestRules({
    files: ['test/integ/**/*.ts'],
    tsconfig: './test/integ/tsconfig.json',
  }),
  // Then stricter integ test rules
  integTestRules({
    files: ['test/integ/**/*.ts'],
    tsconfig: './test/integ/tsconfig.json',
  }),
]

function sdkRules(options) {
  return {
    files: options.files,
    languageOptions: {
      parser: tsparser,
      parserOptions: {
        ecmaVersion: 2022,
        sourceType: 'module',
        project: options.tsconfig,
      },
      globals: {
        console: 'readonly',
        process: 'readonly',
        setTimeout: 'readonly',
        clearTimeout: 'readonly',
        atob: 'readonly',
        btoa: 'readonly',
        crypto: 'readonly',
      },
    },
    plugins: {
      '@typescript-eslint': tseslint,
      tsdoc: tsdoc,
    },
    rules: {
      ...tseslint.configs.recommended.rules,
      '@typescript-eslint/no-explicit-any': 'error',
      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
      '@typescript-eslint/explicit-function-return-type': 'error',
      '@typescript-eslint/explicit-module-boundary-types': 'error',
      'tsdoc/syntax': 'error',
    },
  }
}

function unitTestRules(options) {
  return {
    files: options.files,
    languageOptions: {
      parser: tsparser,
      parserOptions: {
        ecmaVersion: 2022,
        sourceType: 'module',
        project: options.tsconfig,
      },
      globals: {
        process: 'readonly',
        console: 'readonly',
        window: 'readonly',
        document: 'readonly',
        navigator: 'readonly',
        setTimeout: 'readonly',
        clearTimeout: 'readonly',
      },
    },
    plugins: {
      '@typescript-eslint': tseslint,
    },
    rules: {
      ...tseslint.configs.recommended.rules,
      '@typescript-eslint/no-explicit-any': 'off',
      '@typescript-eslint/no-unused-vars': ['error', { argsIgnorePattern: '^_', varsIgnorePattern: '^_' }],
      '@typescript-eslint/explicit-function-return-type': 'off',
      quotes: ['error', 'single', { avoidEscape: true }],
    },
  }
}

function integTestRules(options) {
  return {
    files: options.files,
    languageOptions: {
      parserOptions: {
        project: options.tsconfig,
      },
    },
    rules: {
      'no-restricted-imports': [
        'error',
        {
          patterns: [
            {
              group: ['../src', '../src/**'],
              message:
                'Integration tests should use $/sdk/* path aliases instead of ../src. Test fixtures can import from $/sdk/*.',
            },
          ],
        },
      ],
    },
  }
}

function noVendedToolsImports(options) {
  return {
    files: options.files,
    ignores: options.ignores,
    rules: {
      'no-restricted-imports': [
        'error',
        {
          patterns: [
            {
              group: ['**/vended-tools', '**/vended-tools/**'],
              message:
                'Core SDK files should not import from vended-tools. Vended tools are optional and independently importable.',
            },
          ],
        },
      ],
    },
  }
}