1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-12-25 17:40:29 +00:00
TiddlyWiki5/node_modules/esprima/README.md
2012-05-07 09:43:29 +01:00

3.3 KiB

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.