https://github.com/ariya/esprima

ECMAScript parsing infrastructure for multipurpose analysis
https://github.com/ariya/esprima

Last synced: 3 months ago
JSON representation

ECMAScript parsing infrastructure for multipurpose analysis

• Host: GitHub
• URL: https://github.com/ariya/esprima
• Owner: ariya
• License: bsd-2-clause
• Fork: true (jquery/esprima)
• Created: 2015-02-06T19:17:29.000Z (almost 10 years ago)
• Default Branch: main
• Last Pushed: 2021-06-14T02:36:18.000Z (over 3 years ago)
• Last Synced: 2024-05-30T05:31:46.320Z (6 months ago)
• Language: TypeScript
• Homepage: http://esprima.org
• Size: 55.7 MB
• Stars: 408
• Watchers: 27
• Forks: 32
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: ChangeLog
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.BSD

Awesome Lists containing this project

• awesome-javascript - esprima - ECMAScript parsing infrastructure for multipurpose analysis - ★ 315 (Editors)

README

        
[![NPM version](https://img.shields.io/npm/v/esprima.svg)](https://www.npmjs.com/package/esprima)

[![npm download](https://img.shields.io/npm/dm/esprima.svg)](https://www.npmjs.com/package/esprima)

[![Tests](https://github.com/jquery/esprima/workflows/Tests/badge.svg)](https://github.com/jquery/esprima/actions)

[![Coverage Status](https://img.shields.io/codecov/c/github/jquery/esprima/master.svg)](https://codecov.io/github/jquery/esprima)

**Esprima** ([esprima.org](http://esprima.org), BSD license) is a high performance,

standard-compliant [ECMAScript](http://www.ecma-international.org/publications/standards/Ecma-262.htm)

parser written in ECMAScript (also popularly known as

[JavaScript](https://en.wikipedia.org/wiki/JavaScript)).

Esprima is created and maintained by [Ariya Hidayat](https://twitter.com/ariyahidayat),

with the help of [many contributors](https://github.com/jquery/esprima/contributors).

### Features

- Full support for ECMAScript 2019 ([ECMA-262 10th Edition](http://www.ecma-international.org/publications/standards/Ecma-262.htm))

- Sensible [syntax tree format](https://github.com/estree/estree/blob/master/es5.md) as standardized by [ESTree project](https://github.com/estree/estree)

- Experimental support for [JSX](https://facebook.github.io/jsx/), a syntax extension for [React](https://facebook.github.io/react/)

- Optional tracking of syntax node location (index-based and line-column)

- [Heavily tested](http://esprima.org/test/ci.html) (~1600 [unit tests](https://github.com/jquery/esprima/tree/master/test/fixtures) with [full code coverage](https://codecov.io/github/jquery/esprima))

### API

Esprima can be used to perform [lexical analysis](https://en.wikipedia.org/wiki/Lexical_analysis) (tokenization) or [syntactic analysis](https://en.wikipedia.org/wiki/Parsing) (parsing) of a JavaScript program.

A simple example on Node.js REPL:

```javascript

> var esprima = require('esprima');

> var program = 'const answer = 42';

> esprima.tokenize(program);

[ { type: 'Keyword', value: 'const' },

  { type: 'Identifier', value: 'answer' },

  { type: 'Punctuator', value: '=' },

  { type: 'Numeric', value: '42' } ]

  

> esprima.parseScript(program);

{ type: 'Program',

  body:

   [ { type: 'VariableDeclaration',

       declarations: [Object],

       kind: 'const' } ],

  sourceType: 'script' }

```

For more information, please read the [complete documentation](http://esprima.org/doc).