eslint.config.js

import globals from 'globals'
import pluginJs from '@eslint/js'
import tseslint from 'typescript-eslint'
import pluginNode from 'eslint-plugin-n'
import pluginImport from 'eslint-plugin-import'
import prettierRecommended from 'eslint-plugin-prettier/recommended'

export default [
  {
    ignores: ['node_modules/', 'dist/', '**/*.d.ts'],
  },
  {
    files: ['**/*.{js,ts}'],
  },
  { languageOptions: { globals: globals.node } },
  pluginJs.configs.recommended,
  ...tseslint.configs.recommended,
  {
    languageOptions: {
      parserOptions: {
        projectService: {
          allowDefaultProject: [
            'eslint.config.js',
            'test/fixtures/tunnel-ends.mjs',
            'test/utils/which-node-test.mjs',
            'vendor/build-common.ts',
            'vendor/seccomp/build.ts',
            'vendor/srt-win/build.ts',
            'vendor/java-proxy-agent/build.ts',
          ],
        },
        tsconfigRootDir: import.meta.dirname,
      },
    },
  },
  {
    files: ['test/**/*.ts'],
    languageOptions: {
      parserOptions: {
        project: './tsconfig.test.json',
        projectService: false,
      },
    },
  },
  {
    plugins: {
      'eslint-plugin-n': pluginNode,
      import: pluginImport,
    },
    rules: {
      '@typescript-eslint/no-unused-vars': [
        'error',
        {
          args: 'all',
          argsIgnorePattern: '^_',
          caughtErrors: 'all',
          caughtErrorsIgnorePattern: '^_',
          destructuredArrayIgnorePattern: '^_',
          varsIgnorePattern: '^_',
          ignoreRestSiblings: true,
        },
      ],
      '@typescript-eslint/switch-exhaustiveness-check': [
        'error',
        {
          considerDefaultExhaustiveForUnions: true,
        },
      ],
      '@typescript-eslint/await-thenable': 'error',
      '@typescript-eslint/no-floating-promises': [
        'error',
        {
          ignoreVoid: true,
          ignoreIIFE: true,
        },
      ],
      '@typescript-eslint/consistent-type-imports': [
        'error',
        {
          prefer: 'type-imports',
          fixStyle: 'inline-type-imports',
        },
      ],
      eqeqeq: ['error', 'always'],
      'eslint-plugin-n/no-unsupported-features/es-builtins': [
        'error',
        {
          version: '>=22.12.0',
          ignores: [],
        },
      ],
      'eslint-plugin-n/no-unsupported-features/node-builtins': [
        'error',
        {
          version: '>=22.12.0',
          // Web-standard Request/Headers/ReadableStream and the
          // Readable.toWeb/fromWeb adapters are available since Node 18.0.0
          // (the rule flags them as experimental until 21–23) and stable in
          // Bun, which is SRT's primary runtime.
          ignores: [
            'Request',
            'Headers',
            'ReadableStream',
            'stream.Readable.toWeb',
            'stream.Readable.fromWeb',
            // In the 22 line only from 22.16.0, by the rule's data, so
            // `>=22.12.0` does not cover it.
            'import.meta.dirname',
          ],
        },
      ],
      'no-async-promise-executor': 'off',
      'import/no-cycle': [
        'warn',
        {
          maxDepth: 4,
          ignoreExternal: true,
          disableScc: true,
        },
      ],
    },
    settings: {
      'import/parsers': {
        '@typescript-eslint/parser': ['.ts'],
      },
      'import/resolver': {
        typescript: {
          project: './tsconfig.json',
        },
      },
    },
    linterOptions: {
      reportUnusedDisableDirectives: false,
    },
  },
  {
    // bubblewrap takes no patterns, so every path that reaches the Linux
    // backend is a name. normalizePathForSandbox with one argument decides
    // pattern or name from the characters of the path, which would read a
    // name with `[`, `*` or `?` in it as a pattern again.
    files: [
      'src/sandbox/linux-sandbox-utils.ts',
      'src/sandbox/read-deny-glob.ts',
    ],
    rules: {
      'no-restricted-syntax': [
        'error',
        {
          selector:
            "CallExpression[callee.name='normalizePathForSandbox'][arguments.length=1]",
          message:
            'Every path here is a name: pass { literal: true }, so that glob characters in it are not read as a pattern.',
        },
      ],
    },
  },
  {
    // Runtimes differ in what realpathSync does with a backslash in a name.
    files: ['src/**/*.ts'],
    ignores: ['src/utils/real-path.ts'],
    rules: {
      'no-restricted-properties': [
        'error',
        ...['realpathSync', 'realpath'].map(property => ({
          property,
          message: 'Ask realPathOf (src/utils/real-path.ts) instead.',
        })),
      ],
    },
  },
  prettierRecommended,
]