add yaml support

iuyoy · iuyoy · commit 87d32ff240dc · 2019-12-15T13:38:06.000+08:00
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -1,18 +1,15 @@
 {
   "version": "0.1.0",
   "configurations": [
+
       {
           "type": "extensionHost",
           "request": "launch",
           "name": "Launch Extension",
           "runtimeExecutable": "${execPath}",
           "args": [
               "--extensionDevelopmentPath=${workspaceFolder}"
-          ],
-          "outFiles": [
-              "${workspaceFolder}/out/**/*.js"
-          ],
-          "preLaunchTask": "npm run build"
+          ]
       }
   ]
 }
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,10 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how
 
 ## [Realease]
 
+### [v0.4.2]
+- Add yaml support
+- Fix typos.
+
 ### [v0.4.2]
 - Add sign pair snippets for highlighting block.
 - Fix some typos.
diff --git a/README.md b/README.md
@@ -22,7 +22,7 @@ Highlight string as SQL, HTML, CSS or JavaScript in most languages.
 ## Usages
 
 | Language | Sign pair                     | Snippets                      | Comment|
-| -------- | ----------------------------- | ----------------------------- |-|
+| -------- | ----------------------------- | ----------------------------- | -------|
 | SQL      | `--sql`, `;`                  | -                             |
 | SQL      | `--beginsql`, `--endsql`      | `hsql`, `highlight-sql`       |
 | SQL      | `--begin-sql`, `--end-sql`    | -                             |
@@ -31,6 +31,7 @@ Highlight string as SQL, HTML, CSS or JavaScript in most languages.
 | HTML     | `<!--html-->`, `<!--!html-->` | `hhtml`, `highlight-html`     |
 | CSS      | `/*css*/`, `/*!css*/`         | `hcss`, `highlight-css`       |
 | JS       | `//js`, `//!js`               | `hjs`, `highlight-javascript` |
+| Yaml     | `--- #yaml`, `#!yaml`         | `hyaml`, `highlight-yaml`     |
 
 - SQL
   1. Insert sign pair `--sql` and `;` to highlight single SQL sequence.<br>
@@ -42,6 +43,8 @@ Highlight string as SQL, HTML, CSS or JavaScript in most languages.
 - HTML, CSS, JS
   - Insert sign pairs `<!--html-->` and `<!--!html-->`, `/*css*/` and `/*!css*/`, `//js` and `//!js` to highlight one and more HTML, CSS or JS suquences. Other comments can be added after *language name*.<br>
   ![HTML with Sign](./docs/HTML_with_Sign.png)
+- Yaml
+  - Insert sign pairs `--- #yaml` and `#!yaml` to highlight YAML suquences.
 - Other
   - Highlight Variables between `{` and `}` in *highlighted* string code for `SQL` and `HTML` string. The idea is for `python` and `shell`, but works for any language now.<br>
   ![Variables](./docs/SQL_with_variable.png)
@@ -57,10 +60,13 @@ Highlight string as SQL, HTML, CSS or JavaScript in most languages.
 
 ## Release Notes
 
-See [CHANGELOG.md](./CHANGELOG.md)
+### [v0.4.2]
+- support Yaml
+
+Please see [CHANGELOG.md](./CHANGELOG.md) for more information.
 
 ## Issues
-If you have any suggestion or issue, please feel free to subbmit it at [Github Issues](https://github.com/iuyoy/highlight-string-code/issues) page.
+If you have any suggestion or issue, please feel free to submit it at [Github Issues](https://github.com/iuyoy/highlight-string-code/issues) page.
 
 ## References
 
diff --git a/build/generateSnippets.js b/build/generateSnippets.js
@@ -5,7 +5,7 @@ const { embedded_languages } = require('./languages');
 
 const generateSnippets = () => {
     return embedded_languages.reduce((out, embedded_languages) => {
-        out[`Highlisht ${embedded_languages.language}`] = {
+        out[`Highlight ${embedded_languages.language}`] = {
             "prefix": [
                 `h${embedded_languages.attr}`,
                 `highlight-${embedded_languages.language}`
@@ -31,7 +31,7 @@ exports.updateSnippets = () => {
 /*
 Snippet Template
 {
-    "Highlisht js": {
+    "Highlight js": {
         "prefix": [
             "hjs",
             "highlight-js"
diff --git a/build/languages.js b/build/languages.js
@@ -4,7 +4,7 @@ const embedded_languages = [
     {attr:'css', name: 'css', language: 'css', identifiers: ['css', 'css.erb'], source: 'source.css', block_begin: '/* css */', block_end: '/* !css */' },
     {attr:'sql', name: 'sql', language: 'sql', identifiers: ['sql', 'ddl', 'dml'], source: 'source.sql', block_begin: '-- beginsql', block_end: '-- endsql' },
     {attr:'hql', name: 'hive-sql', language: 'hive-sql', identifiers: ['sql', 'hql', 'hiveql'], source: 'source.hive-sql', block_begin: '-- hive', block_end: '-- !hive' },
+    {attr:'yaml', name: 'yaml', language: 'yaml', identifiers: ['yaml'], source: 'source.yaml', block_begin: '--- #yaml', block_end: '#!yaml' }
 ]
 
 exports.embedded_languages = embedded_languages;
-
diff --git a/docs/README_CN.md b/docs/README_CN.md
@@ -31,6 +31,7 @@ Highlight string as SQL, HTML, CSS or JavaScript in most languages.
 | HTML     | `<!--html-->`, `<!--!html-->` | `hhtml`, `highlight-html`     |
 | CSS      | `/*css*/`, `/*!css*/`         | `hcss`, `highlight-css`       |
 | JS       | `//js`, `//!js`               | `hjs`, `highlight-javascript` |
+| Yaml     | `--- #yaml`, `#!yaml`         | `hyaml`, `highlight-yaml`     |
 
 - SQL
   1. 在 `--sql` 和 `;` 中插入单条SQL语句。<br>
@@ -42,6 +43,8 @@ Highlight string as SQL, HTML, CSS or JavaScript in most languages.
 - HTML, CSS, JS
   - 出现在标志 `<!--html-->` 和 `<!--!html-->`、 `/*css*/` 和 `/*!css*/` 以及 `//js` 和 `//!js` 中的代码会分别被高亮为 HTML、 CSS 或者 JS。其他注释可以出现在 *标志语言* 之后。<br>
   ![HTML with Sign](./HTML_with_Sign.png)
+- Yaml
+  - 出现在 `--- #yaml` 和 `#!yaml` 中的代码会被高亮为YAML。
 - 其他
   - 在嵌套语言是 `SQL` 和 `HTML` 的代码中，高亮 `{` 和 `}` 中出现的变量。本意是给 PYTHON 和 SHELL 用的，但是目前对所有的语言都生效。<br>
   ![Variables](./SQL_with_variable.png)
@@ -56,7 +59,10 @@ Highlight string as SQL, HTML, CSS or JavaScript in most languages.
 
 ## 更新日志
 
-见 [CHANGELOG.md](./CHANGELOG.md)
+### [v0.4.2]
+- 支持高亮 Yaml
+
+更多信息请见 [CHANGELOG.md](./CHANGELOG.md)
 
 ## 疑问？
 
diff --git a/docs/demo.py b/docs/demo.py
@@ -101,3 +101,14 @@
     AND `name` != '{banned}man'
 ;
 """.format(banned='bat', day='2019-09-26')
+
+# ANCHOR yaml test
+"""
+--- #yaml
+name: test
+values: 
+  - good
+  - better
+  # comment
+#!yaml
+"""
diff --git a/docs/demo.sh b/docs/demo.sh
@@ -104,4 +104,15 @@ FROM
 WHERE birth > "'${day}'"
     AND name != "'${banned}man'"
 ;
-'
+'
+
+# ANCHOR yaml test
+"
+--- #yaml
+name: test
+values: 
+  - good
+  - better
+  # comment
+# !yaml
+"
diff --git a/package.json b/package.json
@@ -2,7 +2,7 @@
     "name": "highlight-string-code",
     "displayName": "Highlight String Code",
     "description": "Highlight string as SQL, HTML, CSS or JS in most languages. 高亮内嵌的SQL，HTML， CSS或者JS",
-    "version": "0.4.2",
+    "version": "0.4.3",
     "publisher": "iuyoy",
     "author": {
         "name": "iuyoy"
@@ -29,6 +29,7 @@
         "html",
         "sql",
         "hive",
+        "yaml",
         "highlight",
         "hightlight",
         "embedded language"
diff --git a/snippets/highlight-blocks.code-snippets b/snippets/highlight-blocks.code-snippets
@@ -1,5 +1,5 @@
 {
-    "Highlisht javascript": {
+    "Highlight javascript": {
         "prefix": [
             "hjs",
             "highlight-javascript"
@@ -11,7 +11,7 @@
         ],
         "description": "Sign pair for highlighting javascript code."
     },
-    "Highlisht html": {
+    "Highlight html": {
         "prefix": [
             "hhtml",
             "highlight-html"
@@ -23,7 +23,7 @@
         ],
         "description": "Sign pair for highlighting html code."
     },
-    "Highlisht css": {
+    "Highlight css": {
         "prefix": [
             "hcss",
             "highlight-css"
@@ -35,7 +35,7 @@
         ],
         "description": "Sign pair for highlighting css code."
     },
-    "Highlisht sql": {
+    "Highlight sql": {
         "prefix": [
             "hsql",
             "highlight-sql"
@@ -47,7 +47,7 @@
         ],
         "description": "Sign pair for highlighting sql code."
     },
-    "Highlisht hive-sql": {
+    "Highlight hive-sql": {
         "prefix": [
             "hhql",
             "highlight-hive-sql"
@@ -58,5 +58,17 @@
             "-- !hive"
         ],
         "description": "Sign pair for highlighting hive-sql code."
+    },
+    "Highlight yaml": {
+        "prefix": [
+            "hyaml",
+            "highlight-yaml"
+        ],
+        "body": [
+            "--- #yaml",
+            "$0",
+            "#!yaml"
+        ],
+        "description": "Sign pair for highlighting yaml code."
     }
 }
diff --git a/syntaxes/highlight-string-code.json b/syntaxes/highlight-string-code.json
@@ -17,6 +17,9 @@
         },
         {
             "include": "#highlight-string-hive"
+        },
+        {
+            "include": "#highlight-string-yaml"
         }
     ],
     "repository": {
@@ -206,6 +209,27 @@
                     "include": "source.hive"
                 }
             ]
+        },
+        "highlight-string-yaml": {
+            "begin": "( *--- *#yaml)",
+            "end": "( *# *!yaml)",
+            "captures": {
+                "1": {
+                    "name": "comment.line.double-slash.asciidoc"
+                },
+                "2": {
+                    "name": "entity.name.function"
+                }
+            },
+            "contentName": "meta.embedded.block.yaml",
+            "patterns": [
+                {
+                    "include": "#keep-variables"
+                },
+                {
+                    "include": "source.yaml"
+                }
+            ]
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,18 +1,15 @@`
`1`	`1`	`{`
`2`	`2`	`"version": "0.1.0",`
`3`	`3`	`"configurations": [`
	`4`	`+`
`4`	`5`	`{`
`5`	`6`	`"type": "extensionHost",`
`6`	`7`	`"request": "launch",`
`7`	`8`	`"name": "Launch Extension",`
`8`	`9`	`"runtimeExecutable": "${execPath}",`
`9`	`10`	`"args": [`
`10`	`11`	`"--extensionDevelopmentPath=${workspaceFolder}"`
`11`		`- ],`
`12`		`- "outFiles": [`
`13`		`- "${workspaceFolder}/out/*/.js"`
`14`		`- ],`
`15`		`- "preLaunchTask": "npm run build"`
	`12`	`+ ]`
`16`	`13`	`}`
`17`	`14`	`]`
`18`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ const embedded_languages = [`
`4`	`4`	`{attr:'css', name: 'css', language: 'css', identifiers: ['css', 'css.erb'], source: 'source.css', block_begin: '/* css /', block_end: '/ !css */' },`
`5`	`5`	`{attr:'sql', name: 'sql', language: 'sql', identifiers: ['sql', 'ddl', 'dml'], source: 'source.sql', block_begin: '-- beginsql', block_end: '-- endsql' },`
`6`	`6`	`{attr:'hql', name: 'hive-sql', language: 'hive-sql', identifiers: ['sql', 'hql', 'hiveql'], source: 'source.hive-sql', block_begin: '-- hive', block_end: '-- !hive' },`
	`7`	`+ {attr:'yaml', name: 'yaml', language: 'yaml', identifiers: ['yaml'], source: 'source.yaml', block_begin: '--- #yaml', block_end: '#!yaml' }`
`7`	`8`	`]`
`8`	`9`
`9`	`10`	`exports.embedded_languages = embedded_languages;`
`10`		`-`