JavaScript CSS HTML Shell
Latest commit ca04101 Feb 24, 2017 @fkling Bump cache breaker

README.md

AST explorer

Join the chat at https://gitter.im/astexplorer/Lobby

Paste or drop code into the editor and inspect the generated AST.

The AST explorer provides following code parsers:

Depending on the parser settings, it not only supports ES5/CSS3 but also

Since future syntax is supported, the JavaScript AST explorer is a useful tool for developers who want to create AST transforms.

In fact, following transformers are included so you can prototype your own plugins:

Features

  • Save and fork code snippets. Copy the URL to share them.
  • Copying an AST or dropping a file containing an AST into the window will parse the AST and update the code using escodegen.
  • Otherwise, the content of texteditor will be replaced with the content of the file (i.e. you can drag and drop JS files).
  • Choose between multiple parsers and configure them.
  • Toggle Transform mode with jscodeshift and babel.
  • shift+click on a node expands the full subtree.
  • Hovering over a node highlights the corresponding text in the source code: source highlight
  • Editing the source or moving the cursor around will automatically highlight the corresponding AST node (or its ancestors of it isn't expanded): source highlight
  • You can use $node in the console to refer to the last opened/toggled AST node.

Contributions

I'm happy about any feedback, feature request or PR to make this tool as useful as possible!

How to add a new parser

  1. Install the new parser as dependency: yarn add theParser (or npm install -S theParser)
  2. Copy one of the existing examples in src/parsers/{language}.
  3. Adjust the code as necessary:
    • Update metadata.
    • Load the right parser (loadParser).
    • Call the right parsing method with the right/necessary options in parse.
    • Implement the nodeToRange method (this is for highlighting).
    • Implement the getNodeName method (this is for quick look through the tree).
    • Implement opensByDefault method for auto-expansion of specific properties.
    • Define _ignoredProperties set or implement forEachProperty generator method for filtering.
    • Provide a renderSettings method if applicable.

How to add a new transformer

  1. Install the new transformer as dependency.
  2. Copy one of the existing examples in src/parsers/{language}/transformers.
  3. Adjust the code as necessary:
    • Update metadata and defaultParserID.
    • Load the right transformer (loadTransformer).
    • Call the transformation method in transform.
    • Change sample transformation code in codeExample.txt.

Build your own version for development

  1. Clone the repository.
  2. Run git submodule update --init to initialize / update all submodules.
  3. Install all dependencies with yarn install (you can run npm install as well).

Run yarn run build for the final minimized version.
Run yarn run watch for incremental builds.

Run yarn start to start a simple static webserver.