Merge branch 'gwax-sql-formatter' into master

Author: nene

.babelrc

@@ -1,13 +1,4 @@
 {
-    "presets": [
-        ["es2015", {"loose": true}]
-    ],
-    "plugins": [
-        "add-module-exports",
-        "transform-class-properties",
-        "transform-function-bind",
-        "transform-object-rest-spread",
-        "transform-es3-member-expression-literals",
-        "transform-es3-property-literals"
-    ]
+  "presets": ["@babel/preset-env"],
+  "plugins": ["@babel/plugin-proposal-class-properties", "add-module-exports"]
 }

.editorconfig

@@ -6,8 +6,4 @@ charset = utf-8
 trim_trailing_whitespace = true
 insert_final_newline = true
 indent_style = space
-indent_size = 4
-
-[{package.json,.travis.yml}]
-indent_style = space
 indent_size = 2

.eslintignore

@@ -1,3 +1,5 @@
+/bin
 /lib
 /dist
 /coverage
+webpack.*.js

.eslintrc

@@ -1,6 +1,19 @@
 {
-    "extends": "zt/base",
-    "env": {
-        "jest": true
-    }
+  "parser": "babel-eslint",
+  "extends": ["airbnb-base", "prettier"],
+  "plugins": ["prettier"],
+  "rules": {
+    "prettier/prettier": ["error"],
+    "require-unicode-regexp": ["error"],
+    "func-names": "error",
+    "no-useless-concat": "off",
+    "class-methods-use-this": "off",
+    "no-param-reassign": "off",
+    "prefer-template": "off",
+    "no-plusplus": "off",
+    "no-else-return": "off"
+  },
+  "env": {
+    "jest": true
+  }
 }

.prettierignore

@@ -0,0 +1,4 @@
+/coverage
+/dist
+/lib
+/node_modules

.prettierrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "singleQuote": true
+}

CONTRIBUTORS

@@ -0,0 +1,28 @@
+Adrien Pyke <[email protected]>
+Adrien Pyke <[email protected]>
+Damon Davison <[email protected]>
+Davut Can Abacigil <[email protected]>
+Erik H <[email protected]>
+Erik Hirmo <[email protected]>
+George Leslie-Waksman <[email protected]>
+George Leslie-Waksman <[email protected]>
+Ian Campbell <[email protected]>
+Matheus Salmi <[email protected]>
+Matheus Teixeira <[email protected]>
+Nicolas Dermine <[email protected]>
+Offir Baron <[email protected]>
+Olexandr Sydorchuk <[email protected]>
+Rafael Pinto <[email protected]>
+Rahel Rjadnev-Meristo <[email protected]>
+Rahel Rjadnev-Meristo <[email protected]>
+Rene Saarsoo <[email protected]>
+Rene Saarsoo <[email protected]>
+Rene Saarsoo <[email protected]>
+Sasha Aliashkevich <[email protected]>
+Sergei Egorov <[email protected]>
+Tyler Jones <[email protected]>
+Uku Pattak <[email protected]>
+Uku Pattak <[email protected]>
+dependabot[bot] <dependabot[bot]@users.noreply.github.com>
+rahelest <[email protected]>
+yourname <[email protected]>

LICENSE

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-present ZeroTurnaround LLC
+Copyright (c) 2016-2020 ZeroTurnaround LLC
+Copyright (c) 2020-present George Leslie-Waksman and other contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -2,62 +2,118 @@
 
 **SQL Formatter** is a JavaScript library for pretty-printing SQL queries.
 It started as a port of a [PHP Library][], but has since considerably diverged.
-It supports [Standard SQL][], [Couchbase N1QL][], [IBM DB2][] and [Oracle PL/SQL][]  dialects.
+
+SQL Formatter supports [Standard SQL][], [Couchbase N1QL][], [IBM DB2][],
+[Oracle PL/SQL][], [Amazon Redshift][], and [Spark][] dialects.
 
 → [Try the demo.](https://zeroturnaround.github.io/sql-formatter/)
 
 ## Install
 
 Get the latest version from NPM:
 
-```
+```sh
 npm install sql-formatter
 ```
 
+## Command Line Interface
+
+The CLI tool will be installed under `sql-formatter`
+and may be invoked via `npx sql-formatter`:
+
+```sh
+sql-formatter -h
+```
+
+```
+usage: sql-formatter [-h] [-v] [-f FILE] [-o OUTPUT]
+                     [-l {db2,n1ql,pl/sql,plsql,redshift,spark,sql}]
+                     [-i N | -t] [-u] [--lines-between-queries N]
+
+
+SQL Formatter
+
+Optional arguments:
+  -h, --help            Show this help message and exit.
+  -v, --version         Show program's version number and exit.
+  -f FILE, --file FILE  Input SQL file (defaults to stdin)
+  -o OUTPUT, --output OUTPUT
+                        File to write SQL output (defaults to stdout)
+  -l {db2,n1ql,pl/sql,plsql,redshift,spark,sql}, --langauge {db2,n1ql,pl/sql,plsql,redshift,spark,sql}
+                        SQL Formatter dialect (defaults to basic sql)
+  -i N, --indent N      Number of spaces to indent query blocks (defaults to
+                        2)
+  -t, --tab-indent      Indent query blocks with tabs instead of spaces
+  -u, --uppercase       Capitalize language keywords
+  --lines-between-queries N
+                        How many newlines to insert between queries
+                        (separated by ";")
+```
+
+By default, the tool takes queries from stdin and processes them to stdout but
+the `-f`/`--file` and `-o`/`--output` flags can be used to alter this behavior.
+
+```sh
+echo 'select * from tbl where id = 3' | sql-formatter -u
+```
+
+```sql
+SELECT
+  *
+FROM
+  tbl
+WHERE
+  id = 3
+```
+
 ## Usage
 
 ```js
-import sqlFormatter from "sql-formatter";
+import sqlFormatter from 'sql-formatter';
 
-console.log(sqlFormatter.format("SELECT * FROM table1"));
+console.log(sqlFormatter.format('SELECT * FROM tbl'));
 ```
 
 This will output:
 
-```
+```sql
 SELECT
   *
 FROM
-  table1
+  tbl
 ```
 
 You can also pass in configuration options:
 
 ```js
-sqlFormatter.format("SELECT *", {
-    language: "n1ql", // Defaults to "sql"
-    indent: "    "   // Defaults to two spaces
+sqlFormatter.format('SELECT * FROM tbl', {
+  language: 'spark', // Defaults to "sql"
+  indent: '    ', // Defaults to two spaces
+  uppercase: bool, // Defaults to false
+  linesBetweenQueries: 2, // Defaults to 1
 });
 ```
 
-Currently just four SQL dialects are supported:
+Currently six SQL dialects are supported:
 
 - **sql** - [Standard SQL][]
 - **n1ql** - [Couchbase N1QL][]
 - **db2** - [IBM DB2][]
 - **pl/sql** - [Oracle PL/SQL][]
+- **redshift** - [Amazon Redshift][]
+- **spark** - [Spark][]
 
 ### Placeholders replacement
 
 ```js
 // Named placeholders
 sqlFormatter.format("SELECT * FROM tbl WHERE foo = @foo", {
-    params: {foo: "'bar'"}
+  params: {foo: "'bar'"}
 }));
 
 // Indexed placeholders
 sqlFormatter.format("SELECT * FROM tbl WHERE foo = ?", {
-    params: ["'bar'"]
+  params: ["'bar'"]
 }));
 ```
 
@@ -79,9 +135,10 @@ This makes SQL Formatter available as a global variable `window.sqlFormatter`.
 
 ## Contributing
 
-```bash
-# run linter and tests
-$ npm run check
+Make sure to run all checks:
+
+```sh
+npm run check
 ```
 
 ...and you're ready to poke us with a pull request.
@@ -90,8 +147,10 @@ $ npm run check
 
 [MIT](https://github.com/zeroturnaround/sql-formatter/blob/master/LICENSE)
 
-[PHP library]: https://github.com/jdorn/sql-formatter
-[Standard SQL]: https://en.wikipedia.org/wiki/SQL:2011
-[Couchbase N1QL]: http://www.couchbase.com/n1ql
-[IBM DB2]: https://www.ibm.com/analytics/us/en/technology/db2/
-[Oracle PL/SQL]: http://www.oracle.com/technetwork/database/features/plsql/index.html
+[php library]: https://github.com/jdorn/sql-formatter
+[standard sql]: https://en.wikipedia.org/wiki/SQL:2011
+[couchbase n1ql]: http://www.couchbase.com/n1ql
+[ibm db2]: https://www.ibm.com/analytics/us/en/technology/db2/
+[oracle pl/sql]: http://www.oracle.com/technetwork/database/features/plsql/index.html
+[amazon redshift]: https://docs.aws.amazon.com/redshift/latest/dg/cm_chap_SQLCommandRef.html
+[spark]: https://spark.apache.org/docs/latest/api/sql/index.html

bin/sqlfmt.js

@@ -0,0 +1,98 @@
+#!/usr/bin/env node
+
+'use strict';
+
+const { format, FORMATTERS } = require('../lib/sqlFormatter');
+const fs = require('fs');
+const { version } = require('../package.json');
+const { ArgumentParser } = require('argparse');
+
+const formatterKeys = Object.keys(FORMATTERS);
+
+function getArgs() {
+  const parser = new ArgumentParser({
+    version,
+    addHelp: true,
+    description: 'SQL Formatter',
+  });
+
+  parser.addArgument(['-f', '--file'], {
+    help: 'Input SQL file (defaults to stdin)',
+  });
+  parser.addArgument(['-o', '--output'], {
+    help: 'File to write SQL output (defaults to stdout)',
+  });
+
+  parser.addArgument(['-l', '--language'], {
+    help: 'SQL Formatter dialect (defaults to basic sql)',
+    choices: formatterKeys,
+    defaultValue: 'sql',
+  });
+
+  const indentationGroup = parser.addMutuallyExclusiveGroup();
+  indentationGroup.addArgument(['-i', '--indent'], {
+    help: 'Number of spaces to indent query blocks (defaults to 2)',
+    metavar: 'N',
+    type: 'int',
+    defaultValue: 2,
+  });
+  indentationGroup.addArgument(['-t', '--tab-indent'], {
+    help: 'Indent query blocks with tabs instead of spaces',
+    action: 'storeTrue',
+  });
+
+  parser.addArgument(['-u', '--uppercase'], {
+    help: 'Capitalize language keywords',
+    action: 'storeTrue',
+  });
+
+  parser.addArgument(['--lines-between-queries'], {
+    help: 'How many newlines to insert between queries (separated by ";")',
+    metavar: 'N',
+    type: 'int',
+    default: 1,
+  });
+
+  return parser.parseArgs();
+}
+
+function configFromArgs(args) {
+  return {
+    language: args.language,
+    indent: args.tab_indent ? '\t' : ' '.repeat(args.indent),
+    uppercase: args.uppercase,
+    linesBetweenQueries: args.lines_between_queries,
+  };
+}
+
+function getInput(file) {
+  const infile = file || process.stdin.fd;
+  try {
+    return fs.readFileSync(infile, 'utf-8');
+  } catch (e) {
+    if (e.code === 'EAGAIN') {
+      console.error('Error: no file specified and no data in stdin');
+      process.exit(1);
+    }
+    if (e.code === 'ENOENT') {
+      console.error(`Error: could not open file ${infile}`);
+      process.exit(1);
+    }
+    throw e;
+  }
+}
+
+function writeOutput(file, query) {
+  if (file === null) {
+    // No output file, write to console
+    console.log(query);
+  } else {
+    fs.writeFileSync(file, query);
+  }
+}
+
+const args = getArgs();
+const cfg = configFromArgs(args);
+const query = getInput(args.file);
+const formattedQuery = format(query, cfg).trim() + '\n';
+writeOutput(args.output, formattedQuery);