Посетители узлов AST

AST в ESLint рассматривается как основа всей системы анализа кода, поскольку любая проверка, преобразование или диагностика выполняется не над исходным текстом напрямую, а над его структурным представлением. Абстрактное синтаксическое дерево (AST) позволяет разложить JavaScript-код на узлы, каждый из которых описывает конкретную конструкцию языка: выражение, оператор, объявление переменной, вызов функции и так далее. Именно к этим узлам и применяются механизмы посещения (visitors), определяющие поведение правил ESLint.

AST представляет код в виде иерархического дерева, где каждый узел соответствует синтаксической конструкции. Например, конструкция вызова функции fn(a, b) будет представлена узлом CallExpression, внутри которого находятся дочерние узлы Identifier (имя функции) и список аргументов.

Ключевые особенности AST в контексте ESLint:

  • строго типизированные узлы в формате ESTree
  • вложенная структура без циклов
  • наличие метаданных (позиции в исходном коде, диапазоны символов)
  • единый формат независимо от исходного синтаксиса (ES6+, TypeScript через парсеры)

Каждый узел содержит поле type, определяющее его природу, а также дополнительные свойства, зависящие от типа узла.

Механизм обхода дерева

Для анализа AST ESLint использует обход дерева, при котором каждый узел посещается в определённом порядке. Этот процесс реализуется через паттерн “visitor”, где набор функций соответствует типам узлов.

Существуют два базовых режима обхода:

  • enter (вход в узел) — обработка узла до посещения его потомков
  • exit (выход из узла) — обработка узла после обхода дочерних элементов

Такой подход позволяет реализовывать как простые проверки (например, поиск запрещённых идентификаторов), так и сложные анализы, зависящие от контекста.

Посетители узлов в правилах ESLint

Каждое правило ESLint реализуется через функцию create, возвращающую объект посетителей. Ключи этого объекта соответствуют типам узлов AST или селекторам.

Базовая структура правила:

export default {
  create(context) {
    return {
      Identifier(node) {
        // обработка идентификатора
      }
    };
  }
};

Каждая функция-обработчик вызывается автоматически при обходе AST, когда встречается узел соответствующего типа.

Посещение по типу узла

Наиболее прямой способ — указание имени типа узла:

  • Identifier
  • CallExpression
  • VariableDeclaration
  • FunctionDeclaration

Каждая функция получает объект node, содержащий структуру узла и его свойства.

Селекторы как расширение модели посетителей

Помимо простого указания типа узла, ESLint поддерживает селекторы, основанные на CSS-подобной нотации. Они позволяют описывать более сложные условия.

Примеры селекторов:

  • CallExpression Identifier — идентификатор внутри вызова функции
  • MemberExpression[computed=false] — доступ к свойству через точку
  • FunctionDeclaration[id.name="test"] — функция с конкретным именем

Селекторы позволяют существенно сократить необходимость ручной проверки вложенности узлов внутри обработчика.

Контекст выполнения посетителей

Каждый посетитель получает доступ к объекту context, который предоставляет API для взаимодействия с процессом линтинга.

Основные возможности context:

  • context.report() — регистрация ошибки или предупреждения
  • context.getSourceCode() — доступ к исходному коду и утилитам анализа
  • context.options — параметры правила
  • context.filename — имя анализируемого файла

Пример использования:

Identifier(node) {
  if (node.name === "eval") {
    context.report({
      node,
      message: "Использование eval запрещено"
    });
  }
}

Роль объекта SourceCode

SourceCode предоставляет дополнительные инструменты для работы с AST и текстом:

  • получение токенов
  • поиск комментариев
  • извлечение фрагментов кода
  • анализ пробелов и форматирования

Хотя AST описывает структуру, SourceCode связывает её с реальным текстом, что позволяет делать точные диагностические сообщения и фиксы.

Порядок обхода и вложенность посетителей

AST обходится глубоко-первым способом (depth-first traversal). Это означает, что:

  1. Сначала посещается корневой узел
  2. Затем рекурсивно обрабатываются дочерние узлы
  3. После завершения обработки детей выполняется exit-логика

Для узла:

function test() {
  return 1;
}

последовательность посещений будет включать:

  • FunctionDeclaration (enter)
  • Identifier (enter/exit)
  • BlockStatement (enter)
  • ReturnStatement (enter)
  • Literal (enter)
  • выходы в обратном порядке

Узлы и их ключевые типы

В рамках ESLint AST наиболее часто используются следующие категории узлов:

Выражения

  • CallExpression
  • BinaryExpression
  • LogicalExpression
  • AssignmentExpression

Эти узлы представляют операции, вычисления и вызовы.

Объявления

  • VariableDeclaration
  • FunctionDeclaration
  • ClassDeclaration

Они формируют структуру программы.

Идентификаторы и литералы

  • Identifier
  • Literal

Минимальные атомарные элементы AST.

Уточнённые посетители: enter и exit

ESLint позволяет явно разделять логику входа и выхода с помощью суффикса :exit.

CallExpression: {
  enter(node) {
    // до обработки аргументов
  },
  exit(node) {
    // после обработки аргументов
  }
}

Использование exit-обработчиков критично при анализе вложенных структур, где требуется агрегировать данные снизу вверх.

Механизм сопоставления посетителей

При обходе AST ESLint формирует таблицу соответствий между типами узлов и функциями обработчиков. Для каждого узла выполняется:

  1. Определение типа узла

  2. Поиск соответствующих visitor-функций

  3. Вызов обработчиков в порядке приоритета:

    • точные типы
    • селекторы
    • универсальные обработчики

Если для одного узла определено несколько селекторов, они вызываются последовательно.

Динамическое поведение посетителей

Посетители не ограничены статической структурой. Они могут:

  • регистрировать состояние во внешних переменных
  • использовать стек контекста
  • взаимодействовать между собой через замыкания

Пример типичного паттерна:

create(context) {
  let inFunction = false;

  return {
    FunctionDeclaration: {
      enter() {
        inFunction = true;
      },
      exit() {
        inFunction = false;
      }
    },
    ReturnStatement(node) {
      if (!inFunction) {
        context.report({
          node,
          message: "return вне функции"
        });
      }
    }
  };
}

Наследование и комбинирование посетителей

В сложных правилах часто используется объединение логики нескольких типов узлов. Один и тот же visitor может обрабатывать разные конструкции:

  • FunctionDeclaration
  • FunctionExpression
  • ArrowFunctionExpression

Это позволяет абстрагировать поведение от конкретного синтаксиса и работать с семантикой функции как таковой.

Связь посетителей с фазой парсинга

Посетители работают уже после этапа парсинга, когда исходный код преобразован в AST. ESLint поддерживает различные парсеры (например, Babel или TypeScript), но модель visitors остаётся неизменной, так как основана на стандарте ESTree.

Таким образом, посетители полностью отделены от синтаксиса конкретной версии JavaScript, работая с унифицированной структурой узлов.

Оптимизация обхода узлов

Производительность посетителей зависит от количества обрабатываемых узлов. Для оптимизации применяются:

  • ограничение области анализа через селекторы
  • ранний выход из обработчиков
  • минимизация вычислений внутри visitor-функций
  • использование кеширования результатов анализа

Особенно важно избегать избыточной логики в часто встречающихся узлах, таких как Identifier, поскольку они присутствуют практически в каждом AST.

Контекстная чувствительность посетителей

Некоторые правила требуют учитывать контекст узла:

  • область видимости переменных
  • вложенность функций
  • тип модуля (ESM или CommonJS)
  • наличие директив "use strict"

Эта информация не всегда содержится напрямую в AST-узле и требует дополнительного анализа через scopeManager, предоставляемый ESLint.

Scope и связь с посетителями

ScopeManager строит дополнительное представление поверх AST, связывая идентификаторы с их объявлениями. Посетители могут использовать это для более точного анализа:

  • проверка неиспользуемых переменных
  • контроль теневых объявлений
  • анализ замыканий

Таким образом, AST visitors работают в связке с системой областей видимости, расширяя возможности статического анализа.

Оглавление