mass updates before release

Author: iuyoy

.gitignore

@@ -1 +1,7 @@
+out
 node_modules
+.vscode-test/
+*.vsix
+releases/
+.DS_Store
+.vscode/settings.json

CHANGELOG.md

@@ -1,17 +1,13 @@
-# Changelog
-All notable changes to this project will be documented in this file.
+# Change Log
 
-The format is based on [Keep a Changelog] (http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+All notable changes to the "highlight-string-code" extension will be documented in this file.
 
-### [1.1.0] - 2019-06-04
-- Added support for f-strings
+Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
 
-### [1.0.0] - 2019-03-29
-- Added snippet and keybinding
-
-### [0.1.0] - 2019-03-28
-- Published on VS Code marketplace
-
-## [0.0.1] - 2018-03-28
-### Added
-- First working version
+## [Unreleased]
+- Keep variables highlighter between `{` and `}` in string code.
+- Add usages
+- Add HTML highlighter
+- Add SQL highlighter
+- Initial
+- Forked from [ptweir/python-string-sql](https://github.com/ptweir/python-string-sql)

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2018 ptweir
+Copyright (c) 2018
 
 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,58 +1,45 @@
-# SQL highlighting in Python multiline strings for VS Code 
+# Highlight String Code
 
-Adds syntax highlight support for python multiline SQL strings in VS Code.
+Syntax highlighting support for some specific language code in string.
 
-## Installation
-
-Install `python-string-sql` from extensions (`ctrl + shift + x` or `cmd + shift + x` on mac).
-> Also available on [marketplace.visualstudio.com](https://marketplace.visualstudio.com/items?itemName=ptweir.python-string-sql)
-
-## Example
-
-[![Example](docs/demo.png)](docs/demo.py)
-
-## Usage
-
-Insert `--sql`, `--beginsql`, or `--begin-sql` at the beginning of the part of the string you would like highlighted and a semicolon, `--endsql`, or `--end-sql` at the end of the highlighted section.
+## Requirements
 
-### Snippets
-begin typing `sql` and the autocomplete snippet will appear:
+- Visual Studio Code v1.32.0 and above is recommended
 
-![Snippet](docs/snippet.gif)
+## Installation
 
-### Keybindings
+- Install from [VSIX](https://github.com/iuyoy/highlight-string-code/releases) manually.
 
-cmd+s (or ctrl+s on mac) - Insert the following snippet:
-```
-"""
---sql
-SELECT
-;
-"""
-```
+## Features & Usages
 
-## Requirements
+- SQL
+  1. Insert sign pair `--sql` and `;` to highlight one SQL sequence.
+  ![single SQL stirng with Sign](./docs/single_SQL_with_Sign.png)
+  2. Insert sign pair `--beginsql` or `--begin-sql` and `--endsql` or `--end-sql` to highlight one and more SQL suquences.
+  ![multi SQL stirng with Sign](./docs/multi_SQL_with_Sign.png)
+  3. Any SQL sequence starts with **UPPERCASE** keyword (such as `SELECT`, `INSERT`, `UPDATE` and etc), and ends with `;` will be highlighted automatically.
+  ![SQL stirng no Sign](./docs/SQL_without_Sign.png)
+- HTML
+  - Insert sign pair `<!--html-->` and `<!--!html-->` to highlight one and more HTML suquences. Other comments can be added after `html` and `-->`.
+  ![HTML with Sign](./docs/HTML_with_Sign.png)
+- Other
+  - Highlight Variables in *highlighted* string code.
+  ![Variables](./docs/SQL_with_variable.png)
 
-- Visual Studio Code v1.32.0 recommended
-- Comments at beginning and end of highlighted section in the string (see Usage section).
+## TODO Notes
 
-## Community
-- 2018-09-04 forked from [es6-string-css](https://github.com/bashmish/es6-string-css)
+- [ ] Publish extension
+- [ ] Add switches for Highlight Signs
 
 ## Release Notes
 
-### [1.1.0] - 2019-06-04
-- Added support for f-strings
-
-### [1.0.0] - 2019-03-29
-- Added snippet and keybinding
-
-### [0.1.0] - 2019-03-28
-- Published on VS Code marketplace
-
-### [0.0.1] - 2019-03-28
-- Got it working based on [these instructions](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide)
+See [CHANGELOG.md](./CHANGELOG.md)
 
-### [0.0.0] - 2018-09-04
-- Forked from es6-string-html
+## References
 
+- Forked from [bashmish/es6-string-css](https://github.com/bashmish/es6-string-css) > [ptweir/python-string-sql](https://github.com/ptweir/python-string-sql)
+- Visual Studio Code Extension API
+  - [syntax-highlight-guide](https://code.visualstudio.com/api/language-extensions/syntax-highlight-guide)
+- TextMate Manual
+  - [Language Grammars](https://macromates.com/manual/en/language_grammars)
+  - [Scope Selectors](https://macromates.com/manual/en/scope_selectors)

docs/HTML_with_Sign.png

@@ -0,0 +1,70 @@
+single_SQL_with_Sign = """
+--sql Highlight
+select `last_name`, start_day, COUNT(*) AS num_entries
+FROM schema_name.table_name
+WHERE start_day >= '2019-01-01'
+GROUP BY last_name, start_day
+ORDER BY num_entries DESC
+LIMIT 10;
+-- Not Highlight
+select column_name from schema_name.table_name;
+"""
+
+multi_SQL_with_Sign = '''
+--beginsql Highlight
+drop TABLE schema_name.table_name;
+insert INTO schema_name.table_name(id, grade) VALUES(1, 100);
+select `last_name`, start_day FROM schema_name.table_name;
+--endsql
+-- Not Highlight
+drop TABLE schema_name.table_name;
+insert INTO schema_name.table_name(id, grade) VALUES(1, 100);
+'''
+
+SQL_without_Sign = """
+-- Highlight
+DROP TABLE schema_name.table_name;
+INSERT INTO schema_name.table_name(id, grade) VALUES(1, 100);
+SELECT `last_name`, start_day
+FROM (SELECT * from schema_name.table_name) tmp;
+-- Not Highlight
+drop TABLE schema_name.table_name;
+insert INTO schema_name.table_name(id, grade) VALUES(1, 100);
+select column_name from schema_name.table_name;
+"""
+
+# 
+# --beginsql
+# DROP TABLE schema_name.table_name;
+# INSERT INTO schema_name.table_name(id, grade) VALUES(1, 100);
+# SELECT `last_name`, start_day
+# FROM schema_name.table_name
+# ;
+# --endsql
+#
+
+sql = 'SELECT * FROM schema_name.table_name;'
+
+HTML = """
+<!--html-->
+<h1>I am a lighlighted html</h1>
+hello
+<p>world</p>
+<!--!html-->
+<!--htmlcomment-->
+<h1>I am also a lighlighted html</h1>
+<!--!htmlcomment-->
+<h1>I amd not a lighlighted html</h1>
+"""
+
+# ANCHOR variable test
+SQL_with_Variable = """
+SELECT 
+    `name`, birth 
+FROM 
+    users
+WHERE birth > '{date}'
+    AND `name` != '{banned}man'
+;
+""".format(banned='bat', date='2019-09-26')
+