Skip to content

⬅️ Back to Table of Contents

📄 typescript-eslint/src

📊 Analysis Summary

Metric Count
🔧 Functions 2
📦 Imports 13
📊 Variables & Constants 3
🔄 Re-exports 4
📑 Type Aliases 1

📚 Table of Contents

🛠️ File Location:

📂 packages/typescript-eslint/src/index.ts

📦 Imports

Name Source
TSESLint @typescript-eslint/utils
FlatConfig @typescript-eslint/utils/ts-eslint
pluginBase @typescript-eslint/eslint-plugin
rawPlugin @typescript-eslint/eslint-plugin/use-at-your-own-risk/raw-plugin
addCandidateTSConfigRootDir @typescript-eslint/typescript-estree
CompatibleConfig ./compatibility-types
CompatibleConfigArray ./compatibility-types
CompatibleParser ./compatibility-types
CompatiblePlugin ./compatibility-types
config ./config-helper
getTSConfigRootDirFromStack ./getTSConfigRootDirFromStack
extensions ./globs
globs ./globs

Variables & Constants

Name Type Kind Value Exported
parser CompatibleParser const rawPlugin.parser as CompatibleParser satisfies FlatConfig.Parser ✓
plugin CompatiblePlugin const pluginBase satisfies FlatConfig.Plugins['string'] ✓
configs { all: CompatibleConfigArray; base: C... const createConfigsGetters({ /** * Enables each the rules provided as a part of typ... ✓

Re-exports

Type Source Exported Names
named @typescript-eslint/utils/ts-eslint FlatConfig
named ./config-helper config, ConfigWithExtends, InfiniteDepthConfigWithExtends, ConfigArray
named ./globs extensions, globs
named ./compatibility-types CompatibleConfig, CompatibleConfigArray, CompatibleParser, CompatiblePlugin

Functions

createConfigsGetters(values: T): T

Parameters:

  • values T

Returns: T

Calls:

  • Object.defineProperties
  • Object.fromEntries
  • Object.entries(values).map
  • getTSConfigRootDirFromStack (from ./getTSConfigRootDirFromStack)
  • addCandidateTSConfigRootDir (from @typescript-eslint/typescript-estree)
Code 
function createConfigsGetters<T extends object>(values: T): T {
  const configs = {};

  Object.defineProperties(
    configs,
    Object.fromEntries(
      Object.entries(values).map(([key, value]: [string, unknown]) => [
        key,
        {
          enumerable: true,
          get: () => {
            const candidateRootDir = getTSConfigRootDirFromStack();
            if (candidateRootDir) {
              addCandidateTSConfigRootDir(candidateRootDir);
            }

            return value;
          },
        },
      ]),
    ),
  );

  return configs as T;
}

Internal helpers

Declared inside another function in this file.

get(): unknown

Returns: unknown

Calls:

  • getTSConfigRootDirFromStack (from ./getTSConfigRootDirFromStack)
  • addCandidateTSConfigRootDir (from @typescript-eslint/typescript-estree)
Code 
() => {
            const candidateRootDir = getTSConfigRootDirFromStack();
            if (candidateRootDir) {
              addCandidateTSConfigRootDir(candidateRootDir);
            }

            return value;
          }

Type Aliases

Config

type Config = TSESLint.FlatConfig.ConfigFile;

Generated by Syntax Scribe