Skip to content

⬅️ Back to Table of Contents

📄 linter/types

📊 Analysis Summary

Metric Count
📦 Imports 9
🔄 Re-exports 1
📐 Interfaces 2
📑 Type Aliases 4

📚 Table of Contents

🛠️ File Location:

📂 packages/website/src/components/linter/types.ts

📦 Imports

Name Source
analyze @typescript-eslint/scope-manager
ScopeManager @typescript-eslint/scope-manager
astConverter @typescript-eslint/typescript-estree/use-at-your-own-risk
TSESTree @typescript-eslint/utils
FlatConfig @typescript-eslint/utils/ts-eslint
Linter @typescript-eslint/utils/ts-eslint
SourceCode @typescript-eslint/utils/ts-eslint
RuleModule @typescript-eslint/utils/ts-eslint
esquery esquery

Re-exports

Type Source Exported Names
named @typescript-eslint/typescript-estree/use-at-your-own-risk ParseSettings

Interfaces

UpdateModel

Interface Code
export interface UpdateModel {
  storedAST?: TSESTree.Program;
  storedScope?: ScopeManager;
  storedTsAST?: ts.Node;
  typeChecker?: ts.TypeChecker;
}

Properties

Name Type Optional Description
storedAST TSESTree.Program not shown
storedScope ScopeManager not shown
storedTsAST ts.Node not shown
typeChecker ts.TypeChecker not shown

WebLinterModule

Interface Code
export interface WebLinterModule {
  analyze: typeof analyze;
  astConverter: typeof astConverter;
  builtinRules: Map<string, RuleModule<string>>;
  configs: Record<string, FlatConfig.Config | FlatConfig.ConfigArray>;
  createLinter: () => Linter;
  esquery: typeof esquery;
  plugin: FlatConfig.Plugin & { rules: Record<string, RuleModule<string>> };
  visitorKeys: SourceCode.VisitorKeys;
}

Properties

Name Type Optional Description
analyze typeof analyze not shown
astConverter typeof astConverter not shown
builtinRules Map<string, RuleModule<string>> not shown
configs Record<string, FlatConfig.Config \| FlatConfig.ConfigArray> not shown
createLinter () => Linter not shown
esquery typeof esquery not shown
plugin FlatConfig.Plugin & { rules: Record<string, RuleModule<string>> } not shown
visitorKeys SourceCode.VisitorKeys not shown

Type Aliases

PlaygroundSystem

type PlaygroundSystem = {
  removeFile: (fileName: string) => void;
  searchFiles: (path: string) => string[];
  getScriptFileNames: () => string[];
} & Required<Pick<ts.System, 'deleteFile' | 'watchFile'>> &
  ts.System;

LinterOnLint

type LinterOnLint = (
  fileName: string,
  messages: Linter.LintMessage[],
) => void;

LinterOnParse

type LinterOnParse = (fileName: string, model: UpdateModel) => void;

RegisterFile

type RegisterFile = (fileName: string, code: string) => void;

Generated by Syntax Scribe