v5.1.0 (#63)

* consume vscode extension

* update languageMap

* update vscode README

* add vscode issue template

* ignore vscode from eslint as subrepo

* update NewlineMode option, remove itemCount

* update demo page, readme

* update vscode extension

* indent ; on tenSpace

* update newline short circuiting

* refresh license

* clean .vscode

* update linesBetweenQuery logic

* fix test tabbing

* add empty BigQueryFormatter class

* add bigquery keywords

* add test file

* use numeric for loop in Formatter

* add BigQuery specific tests

* update vscode file type

* add empty HiveFormatter class

* added language items and updated tests

* add ref link

* update vscode file type

* fix case test

* ♻️

* add dedupe with Set

* add vscode workspace

* rename linesBetweenStatements

* yo code reset

* move settings to util function

* add format selection command

* add settings to override vscode tab settings

* add command to format selection

* ♻️

* add error message on format fail

* add SQL flavour override

* rename tests to *.test.js schema

* rename Formatter classes to *.formatter.ts

* update README

* update issue templates

* update CONTRIBUTING

* update vscode README

* update CHANGELOG

* fix plsql filename

* update vscode CHANGELOG

Author: inferrinizzard

.eslintignore

@@ -2,4 +2,5 @@
 /lib
 /dist
 /coverage
+/vscode
 webpack.*.js

.eslintrc

@@ -9,9 +9,17 @@
 	},
 	"rules": {
 		"class-methods-use-this": "off",
+		"consistent-return": "off",
 		"curly": ["error", "all"],
 		"eqeqeq": "warn",
 		"func-names": "error",
+		"import/no-extraneous-dependencies": [
+			"error",
+			{
+				"devDependencies": ["test/**", "**/*.test.js", "**/*.test.ts", "vscode/src/test/**"],
+				"packageDir": ["./"]
+			}
+		],
 		"no-continue": "off",
 		"no-param-reassign": "off",
 		"no-plusplus": "off",

.github/ISSUE_TEMPLATE/formatting-bug-report.md

@@ -2,7 +2,7 @@
 name: Formatting Bug Report
 about: Raise an issue about the FORMATTING output
 title: '[FORMATTING] Issue Title Here'
-labels: bug
+labels: formatting
 assignees: ''
 ---
 

.github/ISSUE_TEMPLATE/vscode-bug-report.md

@@ -0,0 +1,33 @@
+---
+name: VSCode Bug Report
+about: Raise an issue with the VSCODE Extension
+title: '[VSCODE] Issue Title Here'
+labels: vscode
+assignees: ''
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Usage**
+
+- What SQL language(s) does this apply to? (Plese check the bottom right of your editor for the current VSCode language type)
+- What VSCode version are you using?
+- What are your currently configured VSCode settings for the `prettier-sql` extension, if relevant to the issue?
+
+**Additional context**
+Add any other context about the problem here.

CHANGELOG.md

@@ -1,6 +1,59 @@
 # CHANGELOG
 
-## NEXT [5.0.0] : 2021-11-22
+## [5.1.0] : 2021-12-21
+
+### Known Issues
+
+- `newline: number` does not work with `[foo]`, `[` and `]` both count as 1 token each so `[foo]` would be 3 items
+  - `array[0]` or `map[key]` do still work as they are parsed as WORD
+- BigQuery formatter fails a few tests (ALTER TABLE, tricky line comments) due to those tests not including valid BigQuery SQL, those tests are currently skipped
+
+### Added
+
+Source:
+
+- consumed VSCode Extension as subrepo
+- added support for Hive language
+- added support for BigQuery language
+- added keyword dedupe on Formatter classes via Set
+
+VSCode:
+
+- added command `prettier-sql-vscode.format-selection`
+  - Formats SQL selections
+- added settings to override user/workspace `tabSize` and `insertSpaces` settings
+- added error message on format fail
+- added setting to override formatting language for `sql` files when SQL flavour does not have a VSCode language ID (Microsoft PostgreSQL and MSSQL Extensions)
+
+Other:
+
+- demo page now deployed as git repo subtree, served from root/ (subtree of static/)
+
+### Updated
+
+- fixed handling of `newline` options
+- simplified `NewlineMode` config
+- fixed ; indentation when used with `semicolonNewline` and `tenSpace` configs
+- Formatter now uses numeric for loop to allow for index manipulation
+- updated `linesBetweenQueries` to add an extra newline (0 lines = 1 line break, no space in between)
+- renamed Formatter class files to `<flavour>.formatter.ts`
+- renamed test files to `<flavour>.test.js`
+
+### Removed
+
+- removed `newline: hybrid` config
+  - `newline: number` now acts like `hybrid`
+
+## [5.0.1] : 2021-11-24
+
+### Updated
+
+- fixed bug when using SELECT \* and `denseOperators`
+- fixed aliasAs option on demo page
+- fixed handling of tokens with `aliasAs` flag
+- demo page now prints stack trace in textarea on error
+
+## [5.0.0] : 2021-11-22
 
 ### Added
 

CONTRIBUTING.md

@@ -1,7 +1,7 @@
 ## Bugs
 
 Please submit bugs and issues here: https://github.com/inferrinizzard/prettier-sql/issues \
-There are issue templates available for FORMATTING or SCRIPT related bugs.
+There are issue templates available for FORMATTING, SCRIPT, or VSCODE related bugs.
 
 # Development
 
@@ -25,6 +25,7 @@ Please use one of the following prefixes: (ie. feature/new-feature)
 
 - feature/ - development towards a new feature
 - dev/ - misc development not tied to a key feature / refactoring
+- vscode/ - development related to the VSCode Extension
 - issue/ - fix specifically for a issue #
 - bug/ - misc bug fixes not tied to a public issue
 - repo/ - meta dev related changes (ie. typescript, CI/CD, dependencies)
@@ -43,6 +44,20 @@ It can be invoked via:
 Please add new tests for any new features and bug fixes. \
 Language-specific tests should be included in their respective Test files, tests that apply to all languages should be in `behavesLikeSqlFormatter.js`
 
+## VSCode
+
+For development on the VSCode Extension, open the vscode/ directory as the workspace folder in VSCode and you'll be able to launch the Extension Host from the Debug menu
+
+## Publish Flow
+
+For those who have admin access on the repo, the new release publish flow is as such:
+
+- `release-it` (bumps version, git tag, git release, npm release)
+- bump VSCode version + prettier-sql dependency version (can be done beforehand, must be done before push)
+- `git subtree push --prefix static origin gh-pages` && `gh pages deploy` (pushes demo page to GH pages)
+- `git dio develop` (moves origin/develop branch head to master)
+- `vscode deploy` (run within vscode/ subrepo, deploys VSCode Extension)
+
 # Contributors
 
 ## `prettier-sql`

LICENSE

@@ -1,7 +1,8 @@
 The MIT License (MIT)
 
 Copyright (c) 2016-2020 ZeroTurnaround LLC
-Copyright (c) 2020-present George Leslie-Waksman and other contributors
+Copyright (c) 2020-2021 George Leslie-Waksman and other contributors
+Copyright (c) 2021-Present inferrinizzard 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

@@ -1,4 +1,4 @@
-<img src="static/prettier-sql-clean.svg" width="128"/>
+<a href='https://github.com/inferrinizzard/prettier-sql'><img src="static/prettier-sql-clean.svg" width="128"/></a>
 
 # Prettier SQL [![NPM version](https://img.shields.io/npm/v/prettier-sql.svg)](https://npmjs.com/package/prettier-sql) ![GitHub Workflow Status (event)](https://img.shields.io/github/workflow/status/inferrinizzard/prettier-sql/coveralls/master?label=Build&logo=Github) ![Coveralls](https://img.shields.io/coveralls/github/inferrinizzard/prettier-sql?branch=master&label=Coverage&logo=coveralls&style=plastic)
 
@@ -9,12 +9,14 @@ It started as a port of a [PHP Library][], but has since considerably diverged.
 Prettier SQL supports the following dialects:
 
 - **sql** - [Standard SQL][]
+- **bigquery** - [GCP BigQuery][]
+- **db2** - [IBM DB2][]
+- **hive** - [Apache Hive][]
 - **mariadb** - [MariaDB][]
 - **mysql** - [MySQL][]
-- **postgresql** - [PostgreSQL][]
-- **db2** - [IBM DB2][]
-- **plsql** - [Oracle PL/SQL][]
 - **n1ql** - [Couchbase N1QL][]
+- **plsql** - [Oracle PL/SQL][]
+- **postgresql** - [PostgreSQL][]
 - **redshift** - [Amazon Redshift][]
 - **spark** - [Spark][]
 - **tsql** - [SQL Server Transact-SQL][tsql]
@@ -24,7 +26,7 @@ It does not support:
 - Stored procedures.
 - Changing of the delimiter type to something else than `;`.
 
-→ [Try the demo.](https://inferrinizzard.github.io/prettier-sql/static)
+→ [Try the demo.](https://inferrinizzard.github.io/prettier-sql)
 
 # Table of contents
 
@@ -116,7 +118,7 @@ prettier-sql -h
 
 ```
 usage: sqlfmt.js [-h] [-o OUTPUT] \
-[-l {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}] [-c CONFIG] [--version] [FILE]
+[-l {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}] [-c CONFIG] [--version] [FILE]
 
 Prettier SQL
 
@@ -127,7 +129,7 @@ optional arguments:
   -h, --help      show this help message and exit
   -o, --output    OUTPUT
                     File to write SQL output (defaults to stdout)
-  -l, --language  {db2,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}
+  -l, --language  {bigquery,db2,hive,mariadb,mysql,n1ql,plsql,postgresql,redshift,spark,sql,tsql}
                     SQL dialect (defaults to standard sql)
   -c, --config    CONFIG
                     Path to config json file (will use default configs if unspecified)
@@ -158,10 +160,7 @@ All fields are optional and all fields that are not specified will be filled wit
 	"indent": string,
 	"uppercase": boolean,
 	"keywordPosition": "standard" | "tenSpaceLeft" | "tenSpaceRight",
-	"newline": {
-		"mode": "always" | "itemCount" | "lineWidth" | "hybrid" | "never",
-		"itemCount"?: number // only used if newline.mode is itemCount or hybrid
-	},
+	"newline": "always" | "lineWidth" | "never" | number,
 	"breakBeforeBooleanOperator": boolean,
 	"aliasAs": "always" | "select" | "never",
 	"tabulateAlias": boolean,
@@ -197,12 +196,14 @@ Please see [CONTRIBUTING.md](CONTRIBUTING.md)
 
 [php library]: https://github.com/jdorn/sql-formatter
 [standard sql]: https://en.wikipedia.org/wiki/SQL:2011
-[couchbase n1ql]: http://www.couchbase.com/n1ql
+[gcp bigquery]: https://cloud.google.com/bigquery
 [ibm db2]: https://www.ibm.com/analytics/us/en/technology/db2/
+[apache hive]: https://hive.apache.org/
+[mariadb]: https://mariadb.com/
+[mysql]: https://www.mysql.com/
+[couchbase n1ql]: http://www.couchbase.com/n1ql
 [oracle pl/sql]: http://www.oracle.com/technetwork/database/features/plsql/index.html
+[postgresql]: https://www.postgresql.org/
 [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
-[postgresql]: https://www.postgresql.org/
-[mariadb]: https://mariadb.com/
-[mysql]: https://www.mysql.com/
 [tsql]: https://docs.microsoft.com/en-us/sql/sql-server/

package.json

@@ -95,7 +95,6 @@
 		"roots": [
 			"test"
 		],
-		"testRegex": ".*Test",
 		"collectCoverage": true
 	}
 }