.eslintrc.js

/** @type {import('eslint').Linter.Config} */
module.exports = {
  'root': true,
  'parser': '@typescript-eslint/parser',
  'plugins': [
    '@typescript-eslint',
    'zk',
    '@microsoft/eslint-plugin-sdl'
  ],
  'parserOptions': {
    'ecmaVersion': 5,
    'sourceType': 'script',
    'ecmaFeatures': {}
  },
  'env': {
    'browser': true
  },
  'overrides': [
    {
      'files': [
        '*.js'
      ],
      'globals': {
        '$eval': 'readonly',
        'JQuery': 'readonly',
        'DOMPurify': 'writable',
        'jq': 'writable',
        'JQ': 'writable',
        'zjq': 'writable',
        'zUtl': 'writable',
        'zAu': 'writable',
        'zWs': 'writable',
        'zWatch': 'writable',
        'zFlex': 'writable',
        'zKeys': 'writable',
        'msgzk': 'writable',
        'msgzul': 'writable',
        'Dates': 'readonly',
        'DateImpl': 'readonly',
        'WeakMap': 'readonly',
        // packages
        'zk': 'writable',
        'zhtml': 'writable',
        'zkbind': 'writable',
        'zul': 'writable',
        'zkex': 'writable',
        'zkmax': 'writable',
        'za11y': 'writable',
        // mount.js exports
        'zkdt': 'readonly',
        'zkx': 'readonly',
        'zkx_': 'readonly',
        'zkac': 'readonly',
        'zkmx': 'readonly',
        'zkmb': 'readonly',
        'zkme': 'readonly',
        'zkdh': 'readonly',
        // duplicate function declaration reserved keyword
        '_zkf': 'writable',
        'Moment': 'readonly'
      },
      'extends': [
        'eslint:recommended',
        'plugin:zk/recommended'
      ],
      'rules': {
        // Recommended
        'for-direction': 'error',
        'getter-return': 'error',
        'no-async-promise-executor': 'error',
        'no-compare-neg-zero': 'error',
        'no-console': 'error',
        'no-constant-condition': ['error', { 'checkLoops': false }],
        'no-control-regex': 'error',
        'no-debugger': 'error',
        'no-dupe-args': 'error',
        'no-dupe-else-if': 'error',
        'no-dupe-keys': 'error',
        'no-duplicate-case': 'error',
        'no-empty': ['error', { 'allowEmptyCatch': true }],
        'no-empty-character-class': 'error',
        'no-ex-assign': 'error',
        'no-extra-boolean-cast': 'error',
        'no-extra-semi': 'error',
        'no-func-assign': 'error',
        'no-import-assign': 'error',
        'no-inner-declarations': 'error',
        'no-invalid-regexp': 'error',
        'no-irregular-whitespace': 'error',
        'no-misleading-character-class': 'error',
        'no-obj-calls': 'error',
        'no-prototype-builtins': 'error',
        'no-regex-spaces': 'error',
        'no-setter-return': 'error',
        'no-sparse-arrays': 'error',
        'no-unexpected-multiline': 'error',
        'no-unreachable': 'error',
        'no-unsafe-finally': 'error',
        'no-unsafe-negation': 'error',
        'use-isnan': 'error',
        'valid-typeof': 'error',

        'no-alert': 'error',
        'no-case-declarations': 'error',
        'no-empty-pattern': 'error',
        'no-fallthrough': 'error',
        'no-global-assign': 'error',
        'no-octal': 'error',
        'no-self-assign': 'error',
        'no-unused-labels': 'error',
        'no-useless-catch': 'error',
        'no-useless-escape': 'error',
        'no-with': 'error',
        'no-delete-var': 'error',
        'no-shadow-restricted-names': 'error',
        'no-undef': ['error', { 'typeof': false }],
        'no-unused-vars': ['error', { 'vars': 'local', 'args': 'none' }],
        'no-eval': 'error',
        'no-implied-eval': 'error',
        'no-mixed-spaces-and-tabs': ['error', 'smart-tabs'],
        'no-multiple-empty-lines': 'error',
        'no-trailing-spaces': ['error', { 'skipBlankLines': true }],
        'no-multi-spaces': ['error', { 'ignoreEOLComments': true }],
        'brace-style': ['error', '1tbs', { 'allowSingleLine': true }],
        'dot-location': ['error', 'property'],
        //'operator-linebreak': ['error', 'after', { 'overrides': {'+': 'before', '-': 'before', '*': 'before', '/': 'before', '.': 'before'} }],
        'semi-spacing': 'error',
        'semi-style': 'error',
        'space-unary-ops': 'error',
        'key-spacing': 'error',
        'func-call-spacing': 'error',
        'one-var': ['error', 'consecutive'],
        'space-before-function-paren': ['error', { 'named': 'ignore' }],
        'space-in-parens': 'error',
        'semi': 'error',
        'space-infix-ops': 'error',
        'keyword-spacing': 'error',
        'space-before-blocks': 'error',
        'switch-colon-spacing': 'error',
        'comma-spacing': 'error',
        'comma-style': 'error',
        'quotes': ['error', 'single', { 'avoidEscape': true }],
        'unicode-bom': 'error',
        'zk/noMixedHtml': [ 2, {
          'htmlVariableRules': [ '^uuid$', 'html/i', {
            object: 'msgzul',
            property: '.*'
          } ],
          'htmlFunctionRules': [
            'dom(?:(?!Evt|Target).)', 'getStyle', 'getSclass', 'getZclass', 'HTML_$',
          ],
          'sanitizedVariableRules': [ {
            object: 'this',
            property: '^uuid$'
          }],
          'functions': {
            'zUtl.encodeXML': { // zUtl.encodeXML()
              'htmlInput': true,
              'safe': true,
              'htmlOutput': true, // true to indicate that the function returns encoded HTML
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'zUtl.encodeXMLAttribute': { // zUtl.encodeXMLAttribute()
              'htmlInput': true,
              'safe': true,
              'htmlOutput': true, // true to indicate that the function returns encoded HTML
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            '.$s': {
              'htmlInput': true,
              'htmlOutput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'out.push': {
              'htmlInput': true// out.push()
            },
            'jq': {
              'htmlInput': true,
              'safe': true
            },
            'jq.parseStyle': {
              'htmlInput': true,
              'safe': true
            },
            'Widget.$': {
              'htmlInput': true,
              'safe': true
            },
            'zk.error': {
              'htmlInput': true,
              'safe': true
            },
            '.startsWith': {
              'htmlInput': true,
              'safe': true
            },
            '.replace': {
              'htmlInput': true,
              'htmlOutput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            '.removeClass': {
              'htmlInput': true,
              'safe': true
            },
            '.addClass': {
              'htmlInput': true,
              'safe': true
            },
            'DOMPurify.sanitize': {
              'htmlOutput': true,
              'htmlInput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'jq.filterTextStyle': {
              'htmlOutput': true,
              'htmlInput': true,
              'safe': true
            },
            'jq.px': {
              'htmlInput': true,
              'htmlOutput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'zUtl.appendAttr': {
              'htmlInput': true,
              'safe': true
            }
          }
        }],
        'zk/noLocationHrefAssign': [ 2, {
          'escapeFunc': 'zUtl.encodeURL'
        }]
      }
    },
    {
      'files': [
        '*.ts'
      ],
      'parserOptions': {
        'project': './tsconfig.json'
      },
      'extends': [
        'eslint:recommended',
        'plugin:@typescript-eslint/recommended',
        'plugin:@typescript-eslint/recommended-requiring-type-checking',
        'plugin:@typescript-eslint/strict',
        'plugin:zk/recommended',
        'plugin:@microsoft/sdl/required',
        'plugin:@microsoft/sdl/typescript'
      ],
      'rules': {
        // Recommended
        // Possible Problems
        'no-cond-assign': 'warn',
        'no-constant-condition': [
          'error',
          {
            'checkLoops': false
          }
        ],
        // Suggestions
        'no-alert': 'error',
        'no-console': 'error',
        'no-empty': [
          'error',
          {
            'allowEmptyCatch': true
          }
        ],
        'no-empty-function': 'error',
        'no-eval': 'warn',
        'no-implied-eval': 'warn',
        'no-var': 'off',
        'prefer-const': 'warn',
        'prefer-rest-params': 'warn',
        'prefer-spread': 'error',
        'no-useless-call': 'error',
        // Layout & Formatting
        'brace-style': [
          'error',
          '1tbs',
          {
            'allowSingleLine': true
          }
        ],
        'dot-location': [
          'error',
          'property'
        ],
        'no-mixed-spaces-and-tabs': [
          'error',
          'smart-tabs'
        ],
        'no-multi-spaces': [
          'error',
          {
            'ignoreEOLComments': true
          }
        ],
        'no-multiple-empty-lines': 'error',
        'no-trailing-spaces': [
          'error',
          {
            'skipBlankLines': true
          }
        ],
        'semi-spacing': 'error',
        'semi-style': 'error',
        'space-unary-ops': 'error',
        'key-spacing': 'error',
        'func-call-spacing': 'error',
        'one-var': [
          'error',
          'consecutive'
        ],
        'space-before-function-paren': [
          'error',
          {
            'named': 'ignore'
          }
        ],
        'space-in-parens': 'error',
        'semi': 'error',
        'space-infix-ops': 'error',
        'keyword-spacing': 'error',
        'space-before-blocks': 'error',
        'switch-colon-spacing': 'error',
        'comma-spacing': 'error',
        'comma-style': 'error',
        'quotes': [
          'error',
          'single',
          {
            'avoidEscape': true
          }
        ],
        'unicode-bom': 'error',
        // typescript
        'no-undef': 'off',
        'no-unused-vars': 'off',
        '@typescript-eslint/no-unused-vars': 'off',
        '@typescript-eslint/no-restricted-types': [
          'error',
          {
            'types': {
              'Function': {
                'message': 'Prefer `zk.Callable`',
                'fixWith': 'zk.Callable'
              }
            }
          }
        ],
        '@typescript-eslint/consistent-type-assertions': [
          'warn',
          {
            'assertionStyle': 'as',
            'objectLiteralTypeAssertions': 'never'
          }
        ],
        '@typescript-eslint/consistent-type-definitions': [
          'error',
          'interface'
        ],
        '@typescript-eslint/explicit-function-return-type': [
          'error',
          {
            'allowExpressions': true,
            'allowTypedFunctionExpressions': true,
            'allowHigherOrderFunctions': true
          }
        ],
        '@typescript-eslint/explicit-module-boundary-types': 'error',
        '@typescript-eslint/member-delimiter-style': 'off', // removed in v8, use @stylistic if needed
        '@typescript-eslint/naming-convention': [
          'error',
          {
            'selector': 'interface',
            'format': [
              'PascalCase'
            ],
            'custom': {
              'regex': '^I[A-Z]',
              'match': false
            }
          }
        ],
        '@typescript-eslint/no-empty-object-type': [
          'error',
          {
            'allowInterfaces': 'with-single-extends'
          }
        ],
        '@typescript-eslint/no-explicit-any': 'error',
        '@typescript-eslint/no-implied-eval': 'warn',
        '@typescript-eslint/no-namespace': 'off',
        '@typescript-eslint/no-non-null-asserted-nullish-coalescing': 'off',
        '@typescript-eslint/no-non-null-asserted-optional-chain': 'off',
        '@typescript-eslint/no-non-null-assertion': 'off',
        '@typescript-eslint/parameter-properties': 'error', // deprecated
        '@typescript-eslint/no-require-imports': 'error',
        '@typescript-eslint/no-this-alias': 'warn',
        '@typescript-eslint/restrict-plus-operands': 'warn',
        '@typescript-eslint/triple-slash-reference': [
          'error',
          {
            'path': 'never',
            'types': 'never',
            'lib': 'never'
          }
        ],
        '@typescript-eslint/type-annotation-spacing': 'off', // removed in v8, use @stylistic if needed
        '@typescript-eslint/unbound-method': 'off',
        '@typescript-eslint/unified-signatures': 'off', // TSDoc overloaded functions
        '@typescript-eslint/no-redundant-type-constituents': 'warn',
        '@typescript-eslint/no-dynamic-delete': 'warn',
        '@typescript-eslint/no-extraneous-class': 'off',
        // @typescript-eslint v8: new/changed rules — maintain backward compat
        '@typescript-eslint/no-unsafe-call': 'warn', // v8 expanded to catch Function typed calls
        '@typescript-eslint/only-throw-error': 'off', // new in v8, replaces no-throw-literal
        '@typescript-eslint/no-unsafe-function-type': 'off', // new in v8, covered by no-restricted-types
        '@typescript-eslint/no-base-to-string': 'warn', // v8 behavior expanded
        '@typescript-eslint/no-unused-expressions': 'warn', // v8 TS version enabled by preset
        '@typescript-eslint/no-duplicate-type-constituents': 'warn',
        '@typescript-eslint/no-for-in-array': 'warn',
        'zk/noMixedHtml': [ 2, {
          'htmlFunctionRules': [
            'dom(?:(?!Evt|Target).)', 'getStyle', 'getSclass', 'getZclass', 'HTML_$',
          ],
          'sanitizedVariableRules': [ {
            object: 'this',
            property: '^uuid$'
          }],
          'functions': {
            'zUtl.encodeXML': { // zUtl.encodeXML()
              'htmlInput': true,
              'safe': true,
              'htmlOutput': true, // true to indicate that the function returns encoded HTML
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'zUtl.encodeXMLAttribute': { // zUtl.encodeXMLAttribute()
              'htmlInput': true,
              'safe': true,
              'htmlOutput': true, // true to indicate that the function returns encoded HTML
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            '.$s': {
              'htmlInput': true,
              'htmlOutput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'out.push': {
              'htmlInput': true// out.push()
            },
            'jq': {
              'htmlInput': true,
              'safe': true
            },
            'jq.parseStyle': {
              'htmlInput': true,
              'safe': true
            },
            'Widget.$': {
              'htmlInput': true,
              'safe': true
            },
            'zk.error': {
              'htmlInput': true,
              'safe': true
            },
            '.startsWith': {
              'htmlInput': true,
              'safe': true
            },
            '.replace': {
              'htmlInput': true,
              'htmlOutput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            '.removeClass': {
              'htmlInput': true,
              'safe': true
            },
            '.addClass': {
              'htmlInput': true,
              'safe': true
            },
            'DOMPurify.sanitize': {
              'htmlOutput': true,
              'htmlInput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'jq.filterTextStyle': {
              'htmlOutput': true,
              'htmlInput': true,
              'safe': true
            },
            'jq.px': {
              'htmlInput': true,
              'htmlOutput': true,
              'safe': true,
              'sanitized': true // true to indicate that the function returns sanitized HTML
            },
            'zUtl.appendAttr': {
              'htmlInput': true,
              'safe': true
            }
          }
        }],
        'zk/noLocationHrefAssign': [ 2, {
          'escapeFunc': 'zUtl.encodeURL'
        }]
      }
    },
    {
      'files': [
        'gulpfile.js'
      ],
      'env': {
        'browser': false,
        'node': true
      },
      'parserOptions': {
        'ecmaVersion': 2020
      },
      'rules': {
        'no-console': 'off',
        'one-var': 'off'
      }
    },
    {
      'files': [
        'scripts/*.js'
      ],
      'env': {
        'browser': false,
        'node': true
      },
      'parserOptions': {
        'ecmaVersion': 2020
      },
      'rules': {
        'no-console': 'off',
        'one-var': 'off',
        'zk/noMixedHtml': 'off'
      }
    }
  ]
};