Git Product home page Git Product logo

estel-estree-builder's Introduction

estel-estree-builder

ESTree compatible AST builder for Javascript and Typescript.

All builder code was fully-generated from ESTree spec

Install

npm install estel-estree-builder

Usage

const builder = require('estel-estree-builder');
const escodegen = require('escodegen');

const ast = builder.functionDeclaration(
    builder.identifier('helloWorld'),
    [builder.identifier('name')],
    builder.functionBody([
        builder.returnStatement(
            builder.binaryExpression(
                '+',
                builder.literal('Hello'),
                builder.identifier('name')
            )
        )
    ])
)

console.log(escodegen.generate(ast));

This example generates the following code:

function helloWorld(name) {
    return 'Hello' + name;
}

Using another version of ES

By default, the builder can generate AST with ES2018-features (inclusive ES5/2015/2016/2017 features), but you can choose ES-version:

const es2018builder = require('estel-estree-builder/generated/es2018'); // es5-es2018
const es2015builder = require('estel-estree-builder/generated/es2015'); // es5-es2015
const es5builder = require('estel-estree-builder/generated/es5'); // es5

Using Typescript

You can also use builder in Typescript:

import es2018builder from 'estel-estree-builder/generated/es2018.ts'; // es5-es2018
import es2015builder from 'estel-estree-builder/generated/es2015.ts'; // es5-es2015
import es5builder from 'estel-estree-builder/generated/es5.ts'; // es5

Generator

The generator is a script that parses ESTree spec and generates the builder source files (JS or/and TS).

git clone https://github.com/smelukov/estel-estree-builder
cd estel-estree-builder
git submodule init
git submodule update

npm install
npm run generate

This will create generated directory and put a generated builder sources to it.

Generator options

There are some options for generator:

-t - target source type (default is [js, ts])

  • js
  • ts

-es - es-features that will be support generated builder (default is [es2018])

  • es5
  • es2015
  • es2016
  • es2017
  • es2018

-o - output folder (default is generated)

For exmaple, npm run generate -- -es es5 es2015 es2018 -t ts -o types will generate builder typescript-sources in types directory that support all es5+ features.

estel-estree-builder's People

Contributors

smelukov avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

estel-estree-builder's Issues

Node types aren't typechecked

I noticed that the generated interfaces you have don't properly set the type field. The DefinitelyTyped repo goes out of its way to do let the user make runtime checks on such things, but here every single node has its type listed as string. Is this intentional?

Express related types as discriminated unions

Have you had a chance to think about expressing 'base' types as discriminated unions rather than just the straight inheritance model? So for example:

type Expression = EmptyExpression | ArrowFunctionExpression | ...

This would make it amazing for using the types for working with ASTs.

The basic task of working out the relationships shouldn't be too tricky, using interface extensions. But working out which types to express as a union seems like a hard problem. For example, no one is creating a raw Node instance, so that would be fine to express as a union type, but 'middle tier' types might be a bit trickier.

The other piece to it is that any type that is part of a union, needs to define their type parameter as a the explicit type name string, not just of type 'string'. For example,

export interface ReturnStatement {
    type: "ReturnStatement",
    argument?: Expression,
    loc?: SourceLocation,
}

Export declared interfaces

Hey there,

Just wondering if you would consider a PR to make the generated interfaces in the ts output to be exported.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.