v5.1.1 (#81)

Author: inferrinizzard

CHANGELOG.md

@@ -1,5 +1,22 @@
 # CHANGELOG
 
+## [5.1.1] : 2022-04-06
+
+### Updated
+
+- restored itemCount setting for VScode extension
+- added JSDocs for all files
+- added conditional skips for Jest tests
+- added missing BigQuery, hive from demo page language dropdown
+
+### Fixed
+
+- fixed bug with CASE and Inline Block interaction
+- fixed bug with END not adding spacings before END
+- fixed bug with CommaPosition.before when the line had no preceding whitespace
+- fixed bug where AS in CAST functions would get deleted when AliasAs.never
+- fixed bug where AS would get deleted in CTE definition when AliasAs.never
+
 ## [5.1.0] : 2021-12-21
 
 ### Known Issues

CONTRIBUTING.md

@@ -54,9 +54,11 @@ For those who have admin access on the repo, the new release publish flow is as
 
 - `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 subtree push --prefix static origin gh-pages` (pushes demo page to GH pages)
 - `git dio develop` (moves origin/develop branch head to master)
+  - alias for `git push --force-with-lease origin HEAD:develop`
 - `vscode deploy` (run within vscode/ subrepo, deploys VSCode Extension)
+  - `npx vsce publish` (required authenticated PAT (Personal Access Token))
 
 # Contributors
 

DOC.md

@@ -0,0 +1,40 @@
+# Prettier-SQL
+
+## Overview:
+
+This formatter generally follows this flow:
+
+- `<sql>.formatter.ts` files are created for each support dialect that defined a mostly exhaustive list of Reserved Keywords\*
+- this formatter class is then passed to the lexer, which tokenises the SQL input string and produces a token stream\*\*
+- the token stream is then directly formatted sequentially by the `format()` method, without a parsing step\*\*\*
+
+\*some more edge case work needs to be done regarding identifying keywords that are multiple words instead of single words
+
+\*\*this tokenizer is set to be replaced in the v5.2 release (Moo)
+
+\*\*\*a parser is set to be added in the future with the v6 release (Nearley)
+
+## Tokenizer:
+
+The tokenizer consumes the lists of tokens from the formatter class files, joined them into respective regular expressions. \
+These regular expressions are then tested in order of priority, allowing Reserved Keywords and Reserved Commands to be matched before common identifiers or operators.
+
+The current priority order is:
+
+- Line Comment (denotes comments across the entire line)
+- Block Comment (denotes comments within a block)
+- Strings (only specific tokens beginning and ending with the supported string delimiters)
+- Block Start tokens (such as Left Parenthesis, Left Bracket, Left Brace, and CASE)
+- Block End tokens (such as Right Parenthesis, Right Bracket, Right Brace, and END)
+- Placeholder tokens (used for variable substitution)
+- Numbers (must match a common numeric format, such as floats or scientific notation)
+- Reserved words (denotes words that are reserved in the SQL dialect)
+
+  - Reserved Commands (begins its own clause, such as `SELECT`)
+  - Reserved Binary Commands (connect two adjacent clauses, such as joins or set operations)
+  - Reserved Dependent Clauses (keywords that are dependent on the previous clause, such as `ON` for joins or `WHEN` and `THEN` for CASE)
+  - Reserved Logical Operator (boolean operators such as `AND` and `OR`)
+  - Reserved Keywords/Functions (other reserved words)
+
+- Word tokens (aka common identifiers)
+- Operators (any supported operators comprised of special characters)

README.md

@@ -1,6 +1,6 @@
 <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)
+# 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) [![VSCode](https://img.shields.io/visual-studio-marketplace/v/inferrinizzard.prettier-sql-vscode?label=vscode)](https://marketplace.visualstudio.com/items?itemName=inferrinizzard.prettier-sql-vscode)
 
 ## **Prettier SQL** is a JavaScript library for pretty-printing SQL queries.
 
@@ -31,6 +31,7 @@ It does not support:
 # Table of contents
 
 - [Install](#install)
+- [Documentation](#documentation)
 - [Usage](#usage)
   - [Usage as library](#usage-as-library)
   - [Usage from command line](#usage-from-command-line)
@@ -52,6 +53,10 @@ Also available with yarn:
 yarn add prettier-sql
 ```
 
+## Documentation
+
+You can read more about how the library works in [DOC.md](DOC.md)
+
 ## Usage
 
 ### Usage as library

package.json

@@ -66,6 +66,7 @@
 		"@babel/plugin-proposal-class-properties": "^7.10.4",
 		"@babel/preset-env": "^7.10.4",
 		"@babel/preset-typescript": "^7.15.0",
+		"@jest/globals": "^27.5.1",
 		"@types/babel__core": "^7.1.15",
 		"@typescript-eslint/eslint-plugin": "^4.31.2",
 		"@typescript-eslint/parser": "^4.32.0",