acorn README

The project's README from github.com/acornjs/acorn. As one markdown file: README.md.

Acorn Logo Acorn

Build Status NPM version CDNJS

A tiny, fast JavaScript parser, written completely in JavaScript.

Community

Acorn is open source software released under an MIT license.

You are welcome to report bugs or create pull requests on github.

Packages

This repository holds three packages:

To build the content of the repository, run npm install.

git clone https://github.com/acornjs/acorn.git
cd acorn
npm install

Plugin developments

Acorn is designed to support plugins which can, within reasonable bounds, redefine the way the parser works. Plugins can add new token types and new tokenizer contexts (if necessary), and extend methods in the parser object. This is not a clean, elegant API—using it requires an understanding of Acorn's internals, and plugins are likely to break whenever those internals are significantly changed. But still, it is possible, in this way, to create parsers for JavaScript dialects without forking all of Acorn. And in principle it is even possible to combine such plugins, so that if you have, for example, a plugin for parsing types and a plugin for parsing JSX-style XML literals, you could load them both and parse code with both JSX tags and types.

A plugin is a function from a parser class to an extended parser class. Plugins can be used by simply applying them to the Parser class (or a version of that already extended by another plugin). But because that gets a little awkward, syntactically, when you are using multiple plugins, the static method Parser.extend can be called with any number of plugin values as arguments to create a Parser class extended by all those plugins. You'll usually want to create such an extended class only once, and then repeatedly call parse on it, to avoid needlessly confusing the JavaScript engine's optimizer.

const {Parser} = require("acorn")

const MyParser = Parser.extend(
  require("acorn-jsx")(),
  require("acorn-bigint")
)
console.log(MyParser.parse("// Some bigint + JSX code"))

Plugins override methods in their new parser class to implement additional functionality. It is recommended for a plugin package to export its plugin function as its default value or, if it takes configuration parameters, to export a constructor function that creates the plugin function.

This is what a trivial plugin, which adds a bit of code to the readToken method, might look like:

module.exports = function noisyReadToken(Parser) {
  return class extends Parser {
    readToken(code) {
      console.log("Reading a token!")
      super.readToken(code)
    }
  }
}

acorn (acornjs/acorn)

Searching Database…

11.5K ·GitHub
Acorn
Что это такое?Acorn — это небольшой и быстрый парсер JavaScript, написанный полностью на JavaScript. Он разбирает исходный код JS на абстрактное синтаксическое дерево (совместимое с ESTree), которое затем могут анализировать или преобразовывать другие инструменты.
Это самостоятельное приложение или библиотека, которую я добавляю в свой проект?Это библиотека, которая распространяется в виде трёх пакетов: acorn (основной парсер), acorn-loose (парсер, устойчивый к ошибкам) и acorn-walk (обходчик синтаксического дерева).
Как добавить это в проект?Установите его как пакет npm и вызовите его функцию parse для строки с исходным кодом JS, чтобы получить AST в ответ; чтобы собрать сам репозиторий, выполните npm install.
Нужно ли сначала установить что-то особенное?Достаточно Node.js и npm; у самого пакета нет зависимостей времени выполнения.
Можно ли просто сделать форк Acorn, чтобы поддержать свой диалект JS?Вместо форка Acorn поддерживает систему плагинов: плагины расширяют класс Parser, добавляя новый синтаксис, но API плагинов не очень чистый и опирается на внутренние детали, поэтому плагины могут сломаться, когда внутренности Acorn меняются.
Кто это будет использовать?Разработчики, которые создают инструменты вроде бандлеров, линтеров, транспайлеров или анализаторов кода и которым нужно разбирать JavaScript на AST.
Можно ли подключить сразу несколько плагинов, например для JSX и синтаксиса типов?Да, Parser.extend принимает несколько функций-плагинов в качестве аргументов, что позволяет собрать один класс Parser, который понимает и JSX-теги, и аннотации типов, например.
Как плагины на самом деле меняют парсер?Плагин — это функция, которая получает класс Parser и возвращает расширенный подкласс, переопределяя методы (например, readToken), чтобы добавить новые типы токенов, контексты токенизатора или новое поведение при разборе.
Для чего нужен acorn-loose?Это вариант парсера, устойчивый к ошибкам: он старается построить AST наилучшим образом, даже если во входном JavaScript есть синтаксические ошибки.
Что делает acorn-walk?Он предоставляет обходчик синтаксического дерева для прохода по AST, созданному acorn, что полезно для анализа или преобразования кода.
What are similar projects?MDsveX, ua-parser-js, compiler, postcss, cheerio, PHP-Parser, babel, marked
Which topics is it in?ast, parsing, parser, npm-package, compiler, javascript-library, npm, tool, nodejs, library, javascript, web
Creator
acornjs
Size
6.4 MB
Stars
11.5K
Updated
CommitOct 14
Age
14y
Commits · 90 Days