npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ts-gls

v0.3.1

Published

Converts TypeScript code to General Language Syntax (GLS).

Downloads

293

Readme

TS-GLS - TypeScript to GLS compiler

Build Status NPM version Greenkeeper badge

Compiles TypeScript code to General Language Syntax (GLS).

GLS 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 GLS.

Caveats

It's impossible to accurately convert TS code to GLS. Although large constructs such as classes and interfaces can be, there are edge cases around primitive literals not representable in TypeScript.

For example, TS-GLS has no way of knowing whether age: number is a GLS float or int:

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 GLS char or string.

Thus, TS-GLS will never be more than an experiment. Only a completely strongly typed language with ints and chars, such as C# or Java, can truly be compiled to GLS. TS-GLS can only get code most of the way there.

Usage

You can use TS-GLS on the command-line with gls-cli or in code.

CLI

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

See gls-cli

Code

createTransformer creates a Transformer object that can transform source files to GLS. It requires all files at construction so it can create a TypeScript program.

import * as ts from "typescript";
import { createTransformer } from "ts-gls";

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 install general-language-syntax --no-save
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 .gls file with the expected GLS 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 them (e.g. npm run test:run:end-to-end -- --command *array* *list*).