@sequencemedia/eslint-config-typescript 0.0.5 → 0.1.0

package/test/configs/index.spec.mjs

@@ -0,0 +1,14 @@
+import {
+  expect
+} from 'chai'
+
+import {
+  recommended,
+  typescript
+} from '@sequencemedia/eslint-config-typescript/configs'
+
+describe('@sequencemedia/eslint-config-typescript/configs', () => {
+  describe('`recommended`', () => it('is an object', () => expect(recommended).to.be.an('object')))
+
+  describe('`typescript`', () => it('is an object', () => expect(typescript).to.be.an('object')))
+})

package/test/configs/recommended.spec.mjs

@@ -0,0 +1,9 @@
+import {
+  expect
+} from 'chai'
+
+import recommended from '@sequencemedia/eslint-config-typescript/configs/recommended'
+
+describe('@sequencemedia/eslint-config-typescript/configs/recommended', () => {
+  describe('`recommended`', () => it('is an object', () => expect(recommended).to.be.an('object')))
+})

package/test/configs/typescript.spec.mjs

@@ -0,0 +1,9 @@
+import {
+  expect
+} from 'chai'
+
+import typescript from '@sequencemedia/eslint-config-typescript/configs/typescript'
+
+describe('@sequencemedia/eslint-config-typescript/configs/typescript', () => {
+  describe('`typescript`', () => it('is an object', () => expect(typescript).to.be.an('object')))
+})

package/test/merge/recommended.spec.mjs

@@ -0,0 +1,75 @@
+import {
+  expect
+} from 'chai'
+
+import RECOMMENDED from '@sequencemedia/eslint-config-typescript/configs/recommended'
+
+import merge from '@sequencemedia/eslint-config-typescript/merge/recommended'
+
+describe('@sequencemedia/eslint-config-typescript/merge/recommended', () => {
+  describe('`merge`', () => it('is a function', () => expect(merge).to.be.a('function')))
+
+  describe('`merge()`', () => {
+    describe('Always', () => it('returns an object', () => expect(merge()).to.be.an('object')))
+
+    describe('Merges', () => {
+      it('returns an object', () => {
+        const MOCK_FILES = [
+          'MOCK FILES'
+        ]
+        const MOCK_IGNORES = [
+          'MOCK IGNORES'
+        ]
+        const MOCK_LANGUAGE_OPTIONS = {
+          mockOption: 'MOCK LANGUAGE OPTIONS'
+        }
+        const MOCK_LINTER_OPTIONS = {
+          mockOptions: 'MOCK LINTER OPTIONS'
+        }
+        const MOCK_RULES = {
+          mockOption: 'MOCK RULES'
+        }
+        const MOCK_SETTINGS = {
+          mockOption: 'MOCK SETTINGS'
+        }
+
+        const {
+          languageOptions: RECOMMENDED_LANGUAGE_OPTIONS,
+          linterOptions: RECOMMENDED_LINTER_OPTIONS,
+          rules: RECOMMENDED_RULES
+        } = RECOMMENDED
+
+        return (
+          expect(
+            merge({
+              files: MOCK_FILES,
+              ignores: MOCK_IGNORES,
+              languageOptions: MOCK_LANGUAGE_OPTIONS,
+              linterOptions: MOCK_LINTER_OPTIONS,
+              rules: MOCK_RULES,
+              settings: MOCK_SETTINGS
+            })
+          )
+            .to.eql({
+              ...RECOMMENDED,
+              files: MOCK_FILES,
+              ignores: MOCK_IGNORES,
+              languageOptions: {
+                ...RECOMMENDED_LANGUAGE_OPTIONS,
+                ...MOCK_LANGUAGE_OPTIONS
+              },
+              linterOptions: {
+                ...RECOMMENDED_LINTER_OPTIONS,
+                ...MOCK_LINTER_OPTIONS
+              },
+              rules: {
+                ...RECOMMENDED_RULES,
+                ...MOCK_RULES
+              },
+              settings: MOCK_SETTINGS
+            })
+        )
+      })
+    })
+  })
+})

package/test/merge/typescript.spec.mjs

@@ -2,11 +2,7 @@ import {
   expect
 } from 'chai'
 
-import {
-  parser
-} from 'typescript-eslint'
-
-import TYPESCRIPT from '@sequencemedia/eslint-config-typescript/config/typescript'
+import TYPESCRIPT from '@sequencemedia/eslint-config-typescript/configs/typescript'
 
 import merge from '@sequencemedia/eslint-config-typescript/merge/typescript'
 
@@ -25,16 +21,17 @@ describe('@sequencemedia/eslint-config-typescript/merge/typescript', () => {
           'MOCK IGNORES'
         ]
         const MOCK_LANGUAGE_OPTIONS = {
-          parser,
-          parserOptions: {
-            projectService: true
-          }
+          mockOption: 'MOCK LANGUAGE OPTIONS'
         }
         const MOCK_LINTER_OPTIONS = {
-          reportUnusedDisableDirectives: 'error'
+          mockOptions: 'MOCK LINTER OPTIONS'
+        }
+        const MOCK_RULES = {
+          mockOption: 'MOCK RULES'
+        }
+        const MOCK_SETTINGS = {
+          mockOption: 'MOCK SETTINGS'
         }
-        const MOCK_RULES = { mockOption: 'MOCK RULES' }
-        const MOCK_SETTINGS = { mockOption: 'MOCK SETTINGS' }
 
         const {
           rules: TYPESCRIPT_RULES

package/test/merge.spec.mjs

@@ -6,7 +6,7 @@ import {
   parser
 } from 'typescript-eslint'
 
-import TYPESCRIPT from '@sequencemedia/eslint-config-typescript/config/typescript'
+import TYPESCRIPT from '@sequencemedia/eslint-config-typescript/configs/typescript'
 
 import merge from '@sequencemedia/eslint-config-typescript/merge'
 
@@ -25,18 +25,21 @@ describe('@sequencemedia/eslint-config-typescript/merge', () => {
           'MOCK IGNORES'
         ]
         const MOCK_LANGUAGE_OPTIONS = {
-          parser,
-          parserOptions: {
-            projectService: true
-          }
+          mockOption: 'MOCK LANGUAGE OPTIONS'
         }
         const MOCK_LINTER_OPTIONS = {
-          reportUnusedDisableDirectives: 'error'
+          mockOption: 'MOCK LINTER OPTIONS'
+        }
+        const MOCK_RULES = {
+          mockOption: 'MOCK RULES'
+        }
+        const MOCK_SETTINGS = {
+          mockOption: 'MOCK SETTINGS'
         }
-        const MOCK_RULES = { mockOption: 'MOCK RULES' }
-        const MOCK_SETTINGS = { mockOption: 'MOCK SETTINGS' }
 
         const {
+          languageOptions: TYPESCRIPT_LANGUAGE_OPTIONS,
+          linterOptions: TYPESCRIPT_LINTER_OPTIONS,
           rules: TYPESCRIPT_RULES
         } = TYPESCRIPT
 
@@ -54,28 +57,38 @@ describe('@sequencemedia/eslint-config-typescript/merge', () => {
             .to.eql([
               {
                 name: '@sequencemedia/eslint-config-typescript',
-                files: MOCK_FILES,
-                ignores: MOCK_IGNORES,
                 languageOptions: {
-                  ecmaVersion: 'latest',
-                  ...MOCK_LANGUAGE_OPTIONS
+                  parser,
+                  parserOptions: {
+                    projectService: true
+                  }
                 },
-                linterOptions: MOCK_LINTER_OPTIONS,
-                rules: MOCK_RULES,
-                settings: MOCK_SETTINGS
+                linterOptions: {
+                  reportUnusedDisableDirectives: 'error'
+                },
+                files: [
+                  '**/*.{ts,mts,cts}'
+                ]
               },
               {
                 ...TYPESCRIPT,
                 files: MOCK_FILES,
                 ignores: MOCK_IGNORES,
-                languageOptions: MOCK_LANGUAGE_OPTIONS,
-                linterOptions: MOCK_LINTER_OPTIONS,
+                languageOptions: {
+                  ...TYPESCRIPT_LANGUAGE_OPTIONS,
+                  ...MOCK_LANGUAGE_OPTIONS
+                },
+                linterOptions: {
+                  ...TYPESCRIPT_LINTER_OPTIONS,
+                  ...MOCK_LINTER_OPTIONS
+                },
                 rules: {
                   ...TYPESCRIPT_RULES,
                   ...MOCK_RULES
                 },
                 settings: MOCK_SETTINGS
-              }])
+              }
+            ])
         )
       })
     })

package/common/merge.mjs

@@ -1,82 +0,0 @@
-function hasLanguageOptionsParser ({ languageOptions: { parser = null } = {} }) {
-  return Boolean(parser)
-}
-
-function getLanguageOptionsParser ({ languageOptions: { parser = null } = {} }) {
-  return parser
-}
-
-function removeParserByEntriesKey ([key]) {
-  return key !== 'parser'
-}
-
-export function getLanguageOptionsWithoutParser ({ languageOptions = {} }) {
-  const entries = Object.entries(languageOptions)
-
-  return (
-    Object.fromEntries(
-      entries.filter(removeParserByEntriesKey)
-    )
-  )
-}
-
-export function getLanguageOptions ({ languageOptions = {} }) {
-  return languageOptions
-}
-
-export function getLinterOptions ({ linterOptions = {} }) {
-  return linterOptions
-}
-
-export function getProcessor ({ processor = {} }) {
-  return processor
-}
-
-export function getRules ({ rules = {} }) {
-  return rules
-}
-
-export function getSettings ({ settings = {} }) {
-  return settings
-}
-
-export function mergeLanguageOptions (alpha = {}, omega = {}) {
-  return (
-    Object
-      .assign(
-        hasLanguageOptionsParser(alpha) ? { parser: getLanguageOptionsParser(alpha) } : {},
-        structuredClone(getLanguageOptionsWithoutParser(alpha)),
-        getLanguageOptions(omega)
-      )
-  )
-}
-
-export function mergeLinterOptions (alpha = {}, omega = {}) {
-  return (
-    Object
-      .assign(
-        structuredClone(getLinterOptions(alpha)),
-        getLinterOptions(omega)
-      )
-  )
-}
-
-export function mergeRules (alpha = {}, omega = {}) {
-  return (
-    Object
-      .assign(
-        structuredClone(getRules(alpha)),
-        getRules(omega)
-      )
-  )
-}
-
-export function mergeSettings (alpha = {}, omega = {}) {
-  return (
-    Object
-      .assign(
-        structuredClone(getSettings(alpha)),
-        getSettings(omega)
-      )
-  )
-}

package/config/typescript.mjs

@@ -1,350 +0,0 @@
-import {
-  parser,
-  plugin as t
-} from 'typescript-eslint'
-import c from 'eslint-plugin-eslint-comments'
-import n from 'eslint-plugin-n'
-import p from 'eslint-plugin-promise'
-import i from 'eslint-plugin-import'
-
-export default {
-  name: '@sequencemedia/eslint-config-typescript/typescript',
-  linterOptions: {
-    reportUnusedDisableDirectives: 'error'
-  },
-  languageOptions: {
-    parser,
-    parserOptions: {
-      projectService: true
-    }
-  },
-  plugins: {
-    '@typescript-eslint': t,
-    'eslint-comments': c,
-    n,
-    promise: p,
-    import: i
-  },
-  rules: {
-    /**
-     *  `@typescript-eslint`
-     */
-    '@typescript-eslint/adjacent-overload-signatures': ['error'],
-    '@typescript-eslint/array-type': ['error', { default: 'array-simple' }],
-    '@typescript-eslint/await-thenable': ['error'],
-    '@typescript-eslint/ban-ts-comment': [
-      'error',
-      {
-        'ts-expect-error': 'allow-with-description',
-        'ts-ignore': true,
-        'ts-nocheck': true,
-        'ts-check': false,
-        minimumDescriptionLength: 3
-      }
-    ],
-    '@typescript-eslint/ban-tslint-comment': ['error'],
-    '@typescript-eslint/class-literal-property-style': ['error', 'fields'],
-    '@typescript-eslint/class-methods-use-this': [
-      'error',
-      {
-        exceptMethods: [],
-        enforceForClassFields: true,
-        ignoreOverrideMethods: false,
-        ignoreClassesThatImplementAnInterface: false
-      }
-    ],
-    '@typescript-eslint/consistent-generic-constructors': ['error', 'constructor'],
-    '@typescript-eslint/consistent-indexed-object-style': ['error', 'record'],
-    '@typescript-eslint/consistent-type-assertions': [
-      'error',
-      {
-        assertionStyle: 'as',
-        objectLiteralTypeAssertions: 'never'
-      }
-    ],
-    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
-    '@typescript-eslint/consistent-type-exports': [
-      'error',
-      {
-        fixMixedExportsWithInlineTypeSpecifier: true
-      }
-    ],
-    '@typescript-eslint/consistent-type-imports': [
-      'error',
-      {
-        prefer: 'type-imports',
-        disallowTypeAnnotations: true,
-        fixStyle: 'inline-type-imports'
-      }
-    ],
-    '@typescript-eslint/dot-notation': [
-      'error',
-      {
-        allowIndexSignaturePropertyAccess: false,
-        allowKeywords: true,
-        allowPattern: '',
-        allowPrivateClassPropertyAccess: false,
-        allowProtectedClassPropertyAccess: false
-      }
-    ],
-    '@typescript-eslint/explicit-function-return-type': [
-      'error',
-      {
-        allowExpressions: true,
-        allowHigherOrderFunctions: true,
-        allowTypedFunctionExpressions: true,
-        allowDirectConstAssertionInArrowFunctions: true
-      }
-    ],
-    '@typescript-eslint/init-declarations': ['error', 'always'],
-    '@typescript-eslint/max-params': ['error', { max: 4 }],
-    '@typescript-eslint/method-signature-style': ['error'],
-    '@typescript-eslint/naming-convention': [
-      'error',
-      {
-        selector: 'variableLike',
-        leadingUnderscore: 'allow',
-        trailingUnderscore: 'allow',
-        format: ['camelCase', 'PascalCase', 'UPPER_CASE']
-      }
-    ],
-    '@typescript-eslint/no-array-constructor': ['error'],
-    '@typescript-eslint/no-array-delete': ['error'],
-    '@typescript-eslint/no-base-to-string': ['error'],
-    '@typescript-eslint/no-confusing-non-null-assertion': ['error'],
-    '@typescript-eslint/no-confusing-void-expression': [
-      'error',
-      { ignoreArrowShorthand: false, ignoreVoidOperator: false }
-    ],
-    '@typescript-eslint/no-deprecated': ['warn'],
-    '@typescript-eslint/no-dupe-class-members': ['error'],
-    '@typescript-eslint/no-duplicate-enum-values': ['error'],
-    '@typescript-eslint/no-duplicate-type-constituents': [
-      'error',
-      { ignoreIntersections: false, ignoreUnions: false }
-    ],
-    '@typescript-eslint/no-dynamic-delete': ['error'],
-    '@typescript-eslint/no-empty-function': [
-      'error',
-      {
-        allow: []
-      }
-    ],
-    '@typescript-eslint/no-empty-object-type': [
-      'error',
-      { allowInterfaces: 'with-single-extends', allowObjectTypes: 'never' }
-    ],
-    '@typescript-eslint/no-explicit-any': [
-      'error',
-      { fixToUnknown: false, ignoreRestArgs: false }
-    ],
-    '@typescript-eslint/no-extra-non-null-assertion': ['error'],
-    '@typescript-eslint/no-extraneous-class': ['error', { allowWithDecorator: true }],
-    '@typescript-eslint/no-floating-promises': ['error'],
-    '@typescript-eslint/no-for-in-array': ['error'],
-    '@typescript-eslint/no-implied-eval': ['error'],
-    '@typescript-eslint/no-import-type-side-effects': ['error'],
-    '@typescript-eslint/no-inferrable-types': [
-      'error',
-      { ignoreParameters: false, ignoreProperties: false }
-    ],
-    '@typescript-eslint/no-invalid-void-type': ['error'],
-    '@typescript-eslint/no-loop-func': ['error'],
-    '@typescript-eslint/no-magic-numbers': [
-      'error',
-      {
-        ignore: [],
-        ignoreArrayIndexes: false,
-        ignoreDefaultValues: false,
-        ignoreClassFieldInitialValues: false,
-        enforceConst: false,
-        detectObjects: true,
-        ignoreEnums: true,
-        ignoreNumericLiteralTypes: false,
-        ignoreReadonlyClassProperties: true,
-        ignoreTypeIndexes: false
-      }
-    ],
-    '@typescript-eslint/no-meaningless-void-operator': ['error', { checkNever: true }],
-    '@typescript-eslint/no-misused-new': ['error'],
-    '@typescript-eslint/no-misused-promises': ['error'],
-    '@typescript-eslint/no-mixed-enums': ['error'],
-    '@typescript-eslint/no-namespace': ['error'],
-    '@typescript-eslint/no-non-null-asserted-nullish-coalescing': ['error'],
-    '@typescript-eslint/no-non-null-asserted-optional-chain': ['error'],
-    '@typescript-eslint/no-non-null-assertion': ['error'],
-    '@typescript-eslint/no-redundant-type-constituents': ['error'],
-    '@typescript-eslint/no-require-imports': ['error', { allow: [], allowAsImport: false }],
-    '@typescript-eslint/no-this-alias': ['error', { allowDestructuring: true }],
-    '@typescript-eslint/no-unnecessary-boolean-literal-compare': ['error'],
-    '@typescript-eslint/no-unnecessary-condition': [
-      'error',
-      {
-        allowConstantLoopConditions: true
-      }
-    ],
-    '@typescript-eslint/no-unnecessary-parameter-property-assignment': ['error'],
-    '@typescript-eslint/no-unnecessary-qualifier': ['error'],
-    '@typescript-eslint/no-unnecessary-template-expression': ['error'],
-    '@typescript-eslint/no-unnecessary-type-arguments': ['error'],
-    '@typescript-eslint/no-unnecessary-type-assertion': ['error'],
-    '@typescript-eslint/no-unnecessary-type-constraint': ['error'],
-    '@typescript-eslint/no-unnecessary-type-parameters': ['error'],
-    '@typescript-eslint/no-unsafe-argument': ['error'],
-    '@typescript-eslint/no-unsafe-assignment': ['error'],
-    '@typescript-eslint/no-unsafe-call': ['error'],
-    '@typescript-eslint/no-unsafe-declaration-merging': ['error'],
-    '@typescript-eslint/no-unsafe-enum-comparison': ['error'],
-    '@typescript-eslint/no-unsafe-function-type': ['error'],
-    '@typescript-eslint/no-unsafe-member-access': ['error'],
-    '@typescript-eslint/no-unsafe-return': ['error'],
-    '@typescript-eslint/no-unsafe-type-assertion': ['error'],
-    '@typescript-eslint/no-unsafe-unary-minus': ['error'],
-    '@typescript-eslint/no-unused-expressions': [
-      'error',
-      {
-        allowShortCircuit: true,
-        allowTernary: true,
-        allowTaggedTemplates: true,
-        enforceForJSX: false
-      }
-    ],
-    '@typescript-eslint/no-unused-vars': [
-      'error',
-      {
-        args: 'none',
-        caughtErrors: 'none',
-        ignoreRestSiblings: true,
-        vars: 'all'
-      }
-    ],
-    '@typescript-eslint/no-use-before-define': [
-      'error',
-      {
-        functions: false,
-        classes: false,
-        enums: false,
-        variables: false,
-        typedefs: false
-      }
-    ],
-    '@typescript-eslint/no-useless-constructor': ['error'],
-    '@typescript-eslint/no-useless-empty-export': ['error'],
-    '@typescript-eslint/no-wrapper-object-types': ['error'],
-    '@typescript-eslint/non-nullable-type-assertion-style': ['error'],
-    '@typescript-eslint/only-throw-error': [
-      'error',
-      { allowThrowingAny: false, allowThrowingUnknown: false }
-    ],
-    '@typescript-eslint/prefer-as-const': ['error'],
-    '@typescript-eslint/prefer-destructuring': [
-      'error',
-      { array: true, object: true },
-      {
-        enforceForRenamedProperties: true,
-        enforceForDeclarationWithTypeAnnotation: false
-      }
-    ],
-    '@typescript-eslint/prefer-find': ['error'],
-    '@typescript-eslint/prefer-for-of': ['error'],
-    '@typescript-eslint/prefer-function-type': ['error'],
-    '@typescript-eslint/prefer-includes': ['error'],
-    '@typescript-eslint/prefer-literal-enum-member': ['error', { allowBitwiseExpressions: true }],
-    '@typescript-eslint/prefer-namespace-keyword': ['error'],
-    '@typescript-eslint/prefer-nullish-coalescing': [
-      'error',
-      { ignoreConditionalTests: false, ignoreMixedLogicalExpressions: false }
-    ],
-    '@typescript-eslint/prefer-optional-chain': ['error'],
-    '@typescript-eslint/prefer-promise-reject-errors': ['error'],
-    '@typescript-eslint/prefer-readonly': ['error'],
-    '@typescript-eslint/prefer-reduce-type-parameter': ['error'],
-    '@typescript-eslint/prefer-regexp-exec': ['error'],
-    '@typescript-eslint/prefer-return-this-type': ['error'],
-    '@typescript-eslint/prefer-string-starts-ends-with': [
-      'error',
-      { allowSingleElementEquality: 'never' }
-    ],
-    '@typescript-eslint/promise-function-async': ['error'],
-    '@typescript-eslint/related-getter-setter-pairs': ['error'],
-    '@typescript-eslint/require-array-sort-compare': ['error', { ignoreStringArrays: true }],
-    '@typescript-eslint/require-await': ['error'],
-    '@typescript-eslint/restrict-plus-operands': ['error', { skipCompoundAssignments: false }],
-    '@typescript-eslint/restrict-template-expressions': ['error', { allowNumber: true }],
-    '@typescript-eslint/return-await': ['error', 'always'],
-    '@typescript-eslint/strict-boolean-expressions': [
-      'error',
-      {
-        allowString: false,
-        allowNumber: false,
-        allowNullableObject: false,
-        allowNullableBoolean: false,
-        allowNullableString: false,
-        allowNullableNumber: false,
-        allowAny: false
-      }
-    ],
-    '@typescript-eslint/switch-exhaustiveness-check': [
-      'error',
-      {
-        allowDefaultCaseForExhaustiveSwitch: false,
-        requireDefaultForNonUnion: false,
-        considerDefaultExhaustiveForUnions: true
-      }
-    ],
-    '@typescript-eslint/triple-slash-reference': [
-      'error',
-      { lib: 'never', path: 'never', types: 'never' }
-    ],
-    '@typescript-eslint/unbound-method': ['error', { ignoreStatic: false }],
-    '@typescript-eslint/unified-signatures': [
-      'error',
-      { ignoreDifferentlyNamedParameters: false }
-    ],
-    '@typescript-eslint/use-unknown-in-catch-callback-variable': ['error'],
-
-    /**
-     * `eslint-plugin-eslint-comments`
-     */
-    'eslint-comments/disable-enable-pair': ['error', { allowWholeFile: true }],
-    'eslint-comments/no-aggregating-enable': ['error'],
-    'eslint-comments/no-duplicate-disable': ['error'],
-    'eslint-comments/no-unlimited-disable': ['error'],
-    'eslint-comments/no-unused-enable': ['error'],
-    'eslint-comments/require-description': [
-      'error',
-      {
-        ignore: ['eslint-enable', 'eslint-env']
-      }
-    ],
-
-    /**
-     * `eslint-plugin-n`
-     */
-    'n/handle-callback-err': ['error', '^(err|error)$'],
-    'n/no-callback-literal': ['error'],
-    'n/no-deprecated-api': ['error'],
-    'n/no-exports-assign': ['error'],
-    'n/no-new-require': ['error'],
-    'n/no-path-concat': ['error'],
-    'n/process-exit-as-throw': ['error'],
-
-    /**
-     * `eslint-plugin-promise`
-     */
-    'promise/param-names': ['error'],
-
-    /**
-     * `eslint-plugin-import`
-     */
-    'import/export': ['error'],
-    'import/first': ['error'],
-    'import/no-absolute-path': [
-      'error',
-      { esmodule: true, commonjs: true, amd: false }
-    ],
-    'import/no-duplicates': ['error'],
-    'import/no-named-default': ['error'],
-    'import/no-webpack-loader-syntax': ['error']
-  }
-}