https://github.com/budgielang/ts-budgie

Converts TypeScript code to Budgie. 🦜
https://github.com/budgielang/ts-budgie

Last synced: about 1 month ago
JSON representation

Converts TypeScript code to Budgie. 🦜

• Host: GitHub
• URL: https://github.com/budgielang/ts-budgie
• Owner: budgielang
• License: mit
• Created: 2017-07-25T03:46:58.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2020-06-02T00:34:51.000Z (over 4 years ago)
• Last Synced: 2024-11-18T16:09:54.584Z (about 2 months ago)
• Language: TypeScript
• Homepage: https://budgielang.org
• Size: 667 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# ts-budgie 🦜

[![Build Status](https://travis-ci.org/budgielang/ts-budgie.svg?)](https://travis-ci.org/budgielang/ts-budgie)

[![NPM version](https://badge.fury.io/js/ts-budgie.svg)](http://badge.fury.io/js/ts-budgie)

[![Greenkeeper badge](https://badges.greenkeeper.io/budgielang/ts-budgie.svg)](https://greenkeeper.io/)

Compiles TypeScript code to Budgie.

Budgie is an abstract way to describe lines of code in real languages.

TypeScript is a gradually typed language, so a subset of well-typed TS code can generally be converted to Budgie.

## Caveats

It's impossible to _accurately_ convert TS code to Budgie.

Although large constructs such as classes and interfaces can be, there are edge cases around primitive literals not representable in TypeScript.

For example, ts-budgie has no way of knowing whether `age: number` is a Budgie `float` or `int`:

```typescript

export class AgePrinter {

    public printAge(name: string, age: number): void {

        console.log(`${name} is ${age} year(s) old.`);

    }

}

```

The TS `string` type also can't be statically determined to be a Budgie `char` or `string`.

Thus, ts-budgie will never be more than an experiment.

Only a completely strongly typed language with `int`s and `char`s, such as C# or Java, can truly be compiled to Budgie.

ts-budgie can only get code most of the way there.

## Usage

You can use ts-budgie on the command-line with `budgie-cli` or in code.

### CLI

```shell

budgie --language Java --tsconfig ./tsconfig *.ts

```

See [`budgie-cli`](https://github.com/budgielang/budgie-cli)

### Code

`createTransformer` creates a `Transformer` object that can transform source files to Budgie.

It requires all files at construction so it can create a TypeScript program.

```typescript

import * as ts from "typescript";

import { createTransformer } from "ts-budgie";

const sourceFile = ts.createSourceFile("_.ts", "let x = true;", ScriptTarget.Latest);

const transformer = createTransformer({

    sourceFiles: [sourceFile],

});

// ["variable : x boolean true"]

transformer.transformSourceFile(sourceFile)

```

## Development

To build from scratch, install Node.js and run the following commands:

```

npm install

npm run verify

```

Check `package.json` for the full list of commands.

To set up source file compiling in watch mode, use `tsc -p . -w`.

### Tests

Integration and end-to-end tests are done using BDD.

Folders under `/test/integration` and `/test/end-to-end` will contain a `.ts` file with TypeScript source code along with an equivalent `.bg` file with the expected Budgie compilation result.

These are verified during `npm run test test`.

You can run specific tests using their run task (`npm run test:run:integration` or `npm run test:run:end-to-end`).

Specify `--command`(s) to only run tests within groups that case-insensitive [minimatch](https://www.npmjs.com/package/minimatch) them (e.g. `npm run test:run:end-to-end -- --command *array* *list*`).