Skip to content

⬅️ Back to Table of Contents

📄 components/types

📊 Analysis Summary

Metric Count
📦 Imports 1
📐 Interfaces 5
📑 Type Aliases 8

📚 Table of Contents

🛠️ File Location:

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

📦 Imports

Name Source
TSESLint @typescript-eslint/utils

Interfaces

RuleDetails

Interface Code
export interface RuleDetails {
  description?: string;
  name: string;
  url?: string;
}

Properties

Name Type Optional Description
description string ✓ not shown
name string ✗ not shown
url string ✓ not shown

ConfigModel

Interface Code
export interface ConfigModel {
  code: string;
  eslintrc: string;
  esQuery?: {
    filter?: string;
    selector: ESQuery.Selector;
  };
  fileType?: ConfigFileType;
  scroll?: boolean;
  showAST?: ConfigShowAst;
  showTokens?: boolean;
  sourceType?: SourceType;
  ts: string;
  tsconfig: string;
}

Properties

Name Type Optional Description
code string ✗ not shown
eslintrc string ✗ not shown
esQuery { filter?: string; selector: ESQuery.Selector; } ✓ not shown
fileType ConfigFileType ✓ not shown
scroll boolean ✓ not shown
showAST ConfigShowAst ✓ not shown
showTokens boolean ✓ not shown
sourceType SourceType ✓ not shown
ts string ✗ not shown
tsconfig string ✗ not shown

ErrorItem

Interface Code
export interface ErrorItem {
  fixer?: { fix(): void; message: string };
  location?: string;
  message: string;
  severity: number;
  suggestions?: { fix(): void; message: string }[];
}

Properties

Name Type Optional Description
fixer { fix(): void; message: string } ✓ not shown
location string ✓ not shown
message string ✗ not shown
severity number ✗ not shown
suggestions { fix(): void; message: string }[] ✓ not shown

ErrorGroup

Interface Code
export interface ErrorGroup {
  group: string;
  items: ErrorItem[];
  uri?: string;
}

Properties

Name Type Optional Description
group string ✗ not shown
items ErrorItem[] ✗ not shown
uri string ✓ not shown

EslintRC

Interface Code
export interface EslintRC {
  rules: RulesRecord;
  extends: string[];
}

Properties

Name Type Optional Description
rules RulesRecord ✗ not shown
extends string[] ✗ not shown

Type Aliases

CompilerFlags

type CompilerFlags = Record<string, unknown>;

SourceType

type SourceType = TSESLint.SourceType;

RulesRecord

type RulesRecord = TSESLint.Linter.RulesRecord;

TabType

type TabType = 'code' | 'eslintrc' | 'tsconfig';

ConfigFileType

type ConfigFileType = `${ts.Extension}`;

ConfigShowAst

type ConfigShowAst = 'es' | 'scope' | 'ts' | 'types' | false;

SelectedRange

type SelectedRange = [number, number];

TSConfig

type TSConfig = {
  compilerOptions: CompilerFlags;
} & Record<string, unknown>;

Generated by Syntax Scribe