Socket
Socket
Sign inDemoInstall

esprima

Package Overview
Dependencies
0
Maintainers
1
Versions
46
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

esprima

ECMAScript parsing infrastructure for multipurpose analysis


Version published
Maintainers
1
Weekly downloads
41,444,370
decreased by-7.95%

Weekly downloads

Package description

What is esprima?

Esprima is a high performance, standard-compliant ECMAScript parser written in ECMAScript (also popularly known as JavaScript). It is capable of parsing JavaScript code to produce an abstract syntax tree (AST), which can be used for various purposes such as static analysis, code instrumentation, and transformation.

What are esprima's main functionalities?

Parsing JavaScript Code

This feature allows you to parse a string of JavaScript code and obtain an abstract syntax tree (AST) that represents the structure of the code.

const esprima = require('esprima');
const program = 'const answer = 42;';
const ast = esprima.parseScript(program);

Syntax Tree Analysis

Once you have the AST, you can analyze it to extract information about the code, such as variable names, function declarations, and more.

const esprima = require('esprima');
const program = 'const answer = 42;';
const ast = esprima.parseScript(program);
console.log(ast.body[0].declarations[0].id.name); // 'answer'

Tokenization

Esprima can also be used to tokenize JavaScript code, breaking it down into its lexical components (tokens) such as keywords, identifiers, literals, and operators.

const esprima = require('esprima');
const program = 'const answer = 42;';
const tokens = esprima.tokenize(program);
console.log(tokens);

Other packages similar to esprima

Readme

Source

Esprima (esprima.org) is an educational ECMAScript (also popularly known as JavaScript) parsing infrastructure for multipurpose analysis. It is also written in ECMAScript.

Esprima serves as a good basis for various tools such as source modification (Esmorph), coverage analyzer (node-cover and coveraje), source-to-source compiler (Marv), syntax formatter (Code Painter), and code generator (escodegen).

Esprima can be used in a web browser:

<script src="esprima.js"></script>

or in a Node.js application via the package manager:

npm install esprima

Esprima parser output is compatible with Mozilla (SpiderMonkey) Parser API.

A very simple example:

esprima.parse('var answer=42').body[0].declarations[0].init

produces the following object:

{ type: 'Literal', value: 42 }

Esprima is still in the development, for now please check the wiki documentation.

Since it is not comprehensive nor complete, refer to the issue tracker for known problems and future plans. Esprima is supported on many browsers: IE 6+, Firefox 1+, Safari 3+, Chrome 1+, and Opera 8+.

Feedback and contribution are welcomed! Please join the mailing list and read the contribution guide for further info.

License

Copyright (C) 2012, 2011 Ariya Hidayat (twitter: @ariyahidayat) and other contributors.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

FAQs

Last updated on 29 Mar 2012

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc