Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mrdziuban/sql-formatter

Polyglot SQL formatter
https://github.com/mrdziuban/sql-formatter

formatter polyglot sql whitespace

Last synced: about 2 months ago
JSON representation

Polyglot SQL formatter

Host: GitHub
URL: https://github.com/mrdziuban/sql-formatter
Owner: mrdziuban
Created: 2017-02-08T21:12:40.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2018-10-21T14:23:40.000Z (almost 6 years ago)
Last Synced: 2024-06-28T02:43:37.670Z (3 months ago)
Topics: formatter, polyglot, sql, whitespace
Language: JavaScript
Homepage: http://mattdziuban.com/sql-formatter/
Size: 2.53 MB
Stars: 28
Watchers: 1
Forks: 3
Open Issues: 2
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # SQL Formatter

[![Build Status](https://travis-ci.org/mrdziuban/sql-formatter.svg?branch=master)](https://travis-ci.org/mrdziuban/sql-formatter)

- [Setup](#setup)

  - [Dart](#dart)

  - [ElixirScript](#elixirscript)

  - [Elm](#elm)

  - [ES6](#es6)

  - [Fable](#fable)

  - [GopherJS](#gopherjs)

  - [Opal](#opal)

  - [PHP](#php)

  - [PureScript](#purescript)

  - [Rust](#rust)

  - [Scala.js](#scalajs)

- [Development](#development)

  - [Compile](#compile)

    - [Compile certain languages](#compile-certain-languages)

  - [Run](#run)

  - [Test](#test)

  - [Build for production](#build-for-production)

- [Deployment](#deployment)

This is a simple SQL formatter that handles formatting whitespace and capitalization of keywords. I originally wrote

it for the purpose of learning Elm, but it soon became a project where I could try out languages that I'm

unfamiliar with and see how many different languages can be compiled down to JavaScript. Most of the languages used,

plus a lot of others, can be

[found here](https://github.com/jashkenas/coffeescript/wiki/list-of-languages-that-compile-to-js).

The app logic in each language is compiled to JavaScript using various Webpack loaders,

[some of which I implemented as wrappers around shell commands](https://github.com/mrdziuban?utf8=%E2%9C%93&tab=repositories&q=-loader&type=&language=).

The current languages are:

- [Dart](#dart)

- [ElixirScript](#elixirscript)

- [Elm](#elm)

- [ES6](#es6)

- [Fable](#fable)

- [GopherJS](#gopherjs)

- [Opal](#opal)

- [PHP](#php)

- [PureScript](#purescript)

- [Rust](#rust)

- [Scala.js](#scalajs)

Check it out at [http://mattdziuban.com/sql-formatter/](http://mattdziuban.com/sql-formatter/).

![demo](https://cloud.githubusercontent.com/assets/4718399/22834351/d7d838ee-ef82-11e6-8556-ef36db229229.gif)

## Setup

Install npm dependencies first with `npm install`, then follow the steps for each language below.

### Dart

[Find the correct Dart SDK URL for the desired version and OS here](https://www.dartlang.org/install/archive),

then run the following:

```bash

mkdir -p "$HOME/.dart"

curl -L  -o "$HOME/.dart/dart.zip"

unzip -q "$HOME/.dart/dart.zip" -d "$HOME/.dart"

export PATH="$HOME/.dart/dart-sdk/bin:$PATH"

pub get

```

### ElixirScript

First, install Erlang and Elixir. On Mac, you can install Erlang with `brew install erlang`. To install Elixir, I

recommend using [Kiex](https://github.com/taylor/kiex).

Then install ElixirScript:

```bash

export EXS_VERSION=56cb2c5

mkdir -p "$HOME/.elixirscript/$EXS_VERSION"

curl -o- -L https://s3.amazonaws.com/mrdziuban-resources/elixirscript-$EXS_VERSION.tar.gz -o "$HOME/.elixirscript/elixirscript-$EXS_VERSION.tar.gz" | tar xvzf - -C "$HOME/.elixirscript/$EXS_VERSION"

export PATH="$HOME/.elixirscript/$EXS_VERSION/dist/elixirscript/bin:$PATH"

```

### Elm

Install Elm packages:

```bash

$(npm bin)/elm-package install

```

### ES6

The ES6 build doesn't require any additional dependencies!

### Fable

Install F#. On Mac, you can run `brew install mono`. On Linux, [check out the docs](http://fsharp.org/use/linux/).

### GopherJS

First, [install Go 1.8](https://golang.org/dl/), then run:

```bash

go get -u github.com/gopherjs/gopherjs

```

### Opal

First, install Ruby if you don't already have it. I recommend using [RVM](https://rvm.io/). Then run:

```bash

bundle install

```

### PHP

Install PHP (any version 5.3-5.6 should work fine), then install PHPUnit:

```bash

mkdir -p "$HOME/.phpunit/bin"

curl -sL https://phar.phpunit.de/phpunit-4.8.phar -o "$HOME/.phpunit/bin/phpunit"

chmod +x "$HOME/.phpunit/bin/phpunit"

export PATH="$HOME/.phpunit/bin:$PATH"

```

### PureScript

Install psc-package and install dependencies:

```bash

export PSC_PACKAGE_VERSION=0.2.5

mkdir -p "$HOME/.psc-package/$PSC_PACKAGE_VERSION"

# Replace macos with linux64 if necessary

curl -o- -sL https://github.com/purescript/psc-package/releases/download/v$PSC_PACKAGE_VERSION/macos.tar.gz | tar xzf - -C "$HOME/.psc-package/$PSC_PACKAGE_VERSION" --strip-components 1

export PATH="$HOME/.psc-package/$PSC_PACKAGE_VERSION:$PATH"

psc-package update

```

### Rust

Rust has the most experimental compilation process, using

[support for WebAssembly via nightly builds](https://www.hellorust.com/news/native-wasm-target.html). Run the following:

```bash

# Install Rust

curl -L https://sh.rustup.rs | sh -s -- -y --default-toolchain=nightly

source ~/.cargo/env

rustup target add wasm32-unknown-unknown

cargo install cargo-web

```

### Scala.js

Run the following to setup SBT:

```bash

export SBT_VERSION=0.13.15

mkdir -p "$HOME/.sbt-bin/$SBT_VERSION"

curl -o- -L https://dl.bintray.com/sbt/native-packages/sbt/$SBT_VERSION/sbt-$SBT_VERSION.tgz | tar xvzf - -C "$HOME/.sbt-bin/$SBT_VERSION" --strip-components 1

export PATH="$HOME/.sbt-bin/$SBT_VERSION/bin:$PATH"

```

## Development

### Compile

Compile all code to JavaScript:

```bash

npm run compile

```

#### Compile certain languages

The `compile` command accepts comma-separated `only` and `exclude` arguments to filter what languages are compiled,

e.g.

```bash

# Only compile ES6 and Opal

npm run compile -- --env.only es6,opal

# Compile everything but GopherJS and Dart

npm run compile -- --env.exclude gopherjs,dart

```

### Run

Run the Webpack dev server:

```bash

npm run dev

```

*Note: The `dev` command also accepts the `only` and `exclude` arguments mentioned above*

Then visit [http://localhost:8000](http://localhost:8000) in your browser.

### Test

Tests are run using a variety tools to match the different languages. To run them:

```bash

npm run test

```

### Build for production

```bash

npm run dist

```

*Note: The `dist` command also accepts the `only` and `exclude` arguments mentioned above*

## Deployment

Deployment to GitHub pages is [scripted](bin/deploy).