Sparser - https://sparser.io

License

Creative Commons Zero v1.0 Universal (cc0-1.0)

Version 1.4.12

Play around with this application in your browser.

Contents

1. Overview
2. Technical Documentation
3. Build
   1. Dependencies
   2. Get the Code
   3. TypeScript Build
   4. Validation Build
4. Contributing
5. FAQ

Overview

A simplified uniform parser tree capable of describing every programming language. This provides two immediate benefits:

1. All languages are described using an identical data structure.
2. An entire file can be described in a single parse tree even if comprised of various different languages.

Standard Format

I call the standard output format the Universal Parse Model. It is a simple means to describe any structured programming language.

Before diving into this application it might help to have a quick background in what parsers are and their related terminology.

Technical Documentation

Please review the technical documentation to learn how to execute, embed, format input, and interpret output.

Supported Languages

A list of supplied lexers and their various dedicated language support as indicated through use of logic with options.language. Other languages may be supported without dedicated logic.

• markdown
  • markdown
• markup
  • Apache Velocity
  • ASP Inline Expression
  • CFML (ColdFusion Markup Language)
  • Django Inline HTML
  • Dust.js
  • EEX Elixir Templates
  • EJS (Embedded JavaScript) Templates
  • ERB (Embedded Ruby)
  • FreeMarker
  • Genshi
  • Handlebars
  • HTL (HTML Templating Language)
  • HTML
  • Jekyll
  • Jinja
  • JSTL (Java Standard Tag Library)
  • Liquid
  • Mustache
  • Nunjucks
  • SGML
  • SilverStripe
  • Spacebars templates
  • ThymeLeaf
  • Underscore Templates (TPL)
  • Twig
  • Vapor Leaf
  • Vash
  • Volt
  • XML
  • XSLT
• script
  • Flow
  • JavaScript / ECMAScript
  • JSON
  • QML
  • React JSX
  • styled-components
  • styled-jsx
  • TSS (Titanium Style Sheets)
  • TSX
  • TypeScript
• style
  • CSS
  • LESS
  • PostCSS
  • SCSS (Sass)

45 total languages.

Build

Dependencies

This application is written in TypeScript, which requires NodeJS and a global installation of TypeScript. The optional validation build also requires ESLint. First, let's install these:

npm install -g typescript
npm install -g eslint

Get the Code

Second, we need to get the code. We can get this directly from Github:

git clone https://github.com/Unibeautify/sparser.git
cd sparser

Or, we can get the code from NPM:

npm install sparser
cd node_modules/sparser

Please note the NPM package contains both the TypeScript and the built JavaScript files, so it is ready to execute immediately without any additional build or compile step.

TypeScript Build

Finally, we need to run the TypeScript build to convert the code from TypeScript to JavaScript:

tsc --pretty
node js/services build

Tests

If you wish to run the test suite:

node js/services test

Or simply:

npm test