npm - @speed-highlight/core - Versions diffs - 1.1.7 → 1.1.9 - Mend

@speed-highlight/core 1.1.7 → 1.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (100) hide show

package/README.md +56 -9
package/dist/color.js +1 -0
package/dist/detect.js +1 -1
package/dist/index.js +3 -3
package/dist/languages/c.js +1 -1
package/dist/languages/go.js +1 -1
package/dist/languages/http.js +1 -1
package/dist/languages/java.js +1 -1
package/dist/languages/js.js +1 -1
package/dist/languages/leanpub-md.js +1 -1
package/dist/languages/md.js +2 -2
package/dist/languages/py.js +1 -1
package/dist/languages/rs.js +1 -1
package/dist/languages/ts.js +1 -1
package/dist/node/color.js +1 -0
package/dist/node/common.js +1 -1
package/dist/node/detect.js +1 -1
package/dist/node/index.js +3 -3
package/dist/node/languages/asm.js +1 -1
package/dist/node/languages/bash.js +1 -1
package/dist/node/languages/bf.js +1 -1
package/dist/node/languages/c.js +1 -1
package/dist/node/languages/css.js +1 -1
package/dist/node/languages/csv.js +1 -1
package/dist/node/languages/diff.js +1 -1
package/dist/node/languages/docker.js +1 -1
package/dist/node/languages/git.js +1 -1
package/dist/node/languages/go.js +1 -1
package/dist/node/languages/html.js +1 -1
package/dist/node/languages/http.js +1 -1
package/dist/node/languages/ini.js +1 -1
package/dist/node/languages/java.js +1 -1
package/dist/node/languages/js.js +1 -1
package/dist/node/languages/js_template_literals.js +1 -1
package/dist/node/languages/jsdoc.js +1 -1
package/dist/node/languages/json.js +1 -1
package/dist/node/languages/leanpub-md.js +2 -2
package/dist/node/languages/log.js +1 -1
package/dist/node/languages/lua.js +1 -1
package/dist/node/languages/make.js +1 -1
package/dist/node/languages/md.js +2 -2
package/dist/node/languages/pl.js +1 -1
package/dist/node/languages/plain.js +1 -1
package/dist/node/languages/py.js +1 -1
package/dist/node/languages/regex.js +1 -1
package/dist/node/languages/rs.js +1 -1
package/dist/node/languages/sql.js +1 -1
package/dist/node/languages/todo.js +1 -1
package/dist/node/languages/toml.js +1 -1
package/dist/node/languages/ts.js +1 -1
package/dist/node/languages/uri.js +1 -1
package/dist/node/languages/xml.js +1 -1
package/dist/node/languages/yaml.js +1 -1
package/dist/node/terminal.js +1 -0
package/dist/node/themes/atom-dark.js +1 -0
package/dist/node/themes/default.js +1 -1
package/dist/terminal.js +1 -0
package/dist/themes/atom-dark.js +1 -0
package/dist/themes/default.js +1 -1
package/doc/common.js.html +87 -0
package/doc/css/jsdoc-template.css +1 -0
package/doc/css/tomorrow.min.css +2 -0
package/doc/detect%0ALanguage%20detectormodule_.html +309 -0
package/doc/detect.js.html +113 -0
package/doc/global.html +1826 -0
package/doc/index%0ABase%20scriptmodule_.html +1179 -0
package/doc/index.html +402 -0
package/doc/index.js.html +209 -0
package/doc/js/jsdoc-template.js +2 -0
package/doc/js/jsdoc-template.js.map +1 -0
package/doc/js/prettify.min.js +47 -0
package/doc/term%0ATerminal%20adaptormodule_.html +596 -0
package/doc/term.js.html +108 -0
package/examples/{helper/data.js → data.js} +28 -16
package/examples/deno.js +53 -7
package/examples/index.html +10 -7
package/examples/languages/test.c +1 -1
package/examples/languages/test.go +4 -4
package/examples/languages/test.java +3 -3
package/examples/node.js +1 -1
package/jsdoc.json +16 -0
package/package.json +42 -38
package/src/color.js +11 -0
package/src/detect.js +21 -5
package/src/index.js +44 -38
package/src/languages/c.js +1 -1
package/src/languages/go.js +1 -1
package/src/languages/java.js +1 -1
package/src/languages/js.js +1 -1
package/src/languages/py.js +1 -1
package/src/languages/rs.js +1 -1
package/src/terminal.js +42 -0
package/src/themes/atom-dark.js +18 -0
package/src/themes/default.js +16 -24
package/typedef.js +34 -0
package/assets/screenshot.png +0 -0
package/dist/node/term.js +0 -1
package/dist/term.js +0 -1
package/examples/dist.html +0 -26
package/src/term.js +0 -19

package/doc/global.html ADDED Viewed

@@ -0,0 +1,1826 @@
+<!DOCTYPE html>
+<html lang='en'>
+<head>
+	<meta charset='utf-8'/>
+	<title>Global - JSDoc</title>
+	<link type='text/css' rel='stylesheet' href='css/jsdoc-template.css'/>
+	<meta name="viewport" content="width=device-width,
+                        initial-scale=1"/>
+</head>
+<body data-gs='{"openPageHeader": "is-page-header-open", "searching": "is-searching"}'>
+	<div id='page-wrapper'>
+		<header id='page-header' data-gs-target='openPageHeader'>
+			<h1 id='page-title'>
+				<a href="/">JSDoc</a>
+			</h1>
+			<nav id='content-nav'>
+				<header>
+					<div id='search'>
+						<div class='textfield-wrapper'>
+							<input type='search' name='q' placeholder='Search...' data-internal-search='#content-nav li a' data-gs-search='searching'/>
+						</div>
+					</div>
+				</header>
+				<h2><a href="index.html">Home</a></h2><h3>Global</h3><ul><li><abbr title="Global">Glo</abbr> <a href="global.html#CallhighlightElementonelementwithacssclassstartingwith%2560shj-lang-%2560">Call highlightElement on element with a css class starting with `shj-lang-`</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#Changethecurrentusedthemeforhighlighting">Change the current used theme for highlighting</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#Findthetokensinthegivencodeandcallthecallback">Find the tokens in the given code and call the callback</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#HighlightaDOMelementbygettingthenewinnerHTMLwithhighlightText">Highlight a DOM element by getting the new innerHTML with highlightText</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#Highlightastringpassedasargumentandreturnastringthatcandirectlybeprinted">Highlight a string passed as argument and return a string that can directly be printed</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#Highlightastringpassedasargumentandreturnit">Highlight a string passed as argument and return it</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#Highlightandprintagivenstring">Highlight and print a given string</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#languages">languages</a></li><li><abbr title="Global">Glo</abbr> <a href="global.html#Trytofindthelanguagethegivencodebelongto">Try to find the language the given code belong to</a></li></ul>
+			</nav>
+		</header>
+		<div id='main-wrapper'>
+			<button id='page-header-opener' title='Toggle left bar' class='has-icon' data-css-icon='menu' type='button' data-gs-toggle='openPageHeader'>Toggle left bar</button>
+			<main id='content'>
+				<header>
+					<h1 id='content-title'>Global</h1>
+				</header>
+<article class='doc' data-kind='globalobj' >
+<header>
+  <h2>Global scope</h2>
+</header>
+    <div class="container-overview">
+<dl class="details">
+</dl>
+  </div>
+        <h3 class="subsection-title">Members</h3>
+<div id="languages" class='member'>
+<h4 class="name"><span class="type-signature"></span><a href='#languages'>languages</a><span class="type-signature"></span></h4>
+<div class="description">
+    Language detector
+</div>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="detect.js.html">detect.js</a>, <a href="detect.js.html#line5">line 5</a>
+    </dd>
+</dl>
+</div>
+        <h3 class="subsection-title">Methods</h3>
+<div id="CallhighlightElementonelementwithacssclassstartingwith%60shj-lang-%60" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#CallhighlightElementonelementwithacssclassstartingwith%60shj-lang-%60'>Call highlightElement on element with a css class starting with `shj-lang-`</a><span class="signature">(opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line130">line 130</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>opt</var>
+                <br/>
+                    <sub class="attributes">
+                        [optional]
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type"><a href="global.html#HighlightOptions">HighlightOptions</a></span>
+            </td>
+                <td class="default">
+                    {}
+                </td>
+            <td class="description last">Customization options</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+</div>
+<div id="Changethecurrentusedthemeforhighlighting" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#Changethecurrentusedthemeforhighlighting'>Change the current used theme for highlighting</a><span class="signature">(name)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="term.js.html">term.js</a>, <a href="term.js.html#line33">line 33</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>name</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">The name of the theme</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+</div>
+<div id="Findthetokensinthegivencodeandcallthecallback" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#Findthetokensinthegivencodeandcallthecallback'>Find the tokens in the given code and call the callback</a><span class="signature">(src, lang, token)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line20">line 20</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>src</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">The code</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>lang</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+ or
+<span class="param-type">Object</span>
+            </td>
+            <td class="description last">The language of the code</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>token</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">function</span>
+            </td>
+            <td class="description last">The callback function
+this function will be given
+* the text of the token
+* the type of the token</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+</div>
+<div id="HighlightaDOMelementbygettingthenewinnerHTMLwithhighlightText" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#HighlightaDOMelementbygettingthenewinnerHTMLwithhighlightText'>Highlight a DOM element by getting the new innerHTML with highlightText</a><span class="signature">(elm, lang<span class="signature-attributes">opt</span>, mode<span class="signature-attributes">opt</span>, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line110">line 110</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>elm</var>
+                <br/>
+                    <sub class="attributes">
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type">HTMLElement</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">The DOM element</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>lang</var>
+                <br/>
+                    <sub class="attributes">
+                        [optional]
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">The language of the code (seaching by default on `elm` for a 'shj-lang-' class)</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>mode</var>
+                <br/>
+                    <sub class="attributes">
+                        [optional]
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">The display mode (guessed by default)
+* inline inside `code` element
+* oneline inside `div` element and containing only one line
+* multiline inside `div` element</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>opt</var>
+                <br/>
+                    <sub class="attributes">
+                        [optional]
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type"><a href="global.html#HighlightOptions">HighlightOptions</a></span>
+            </td>
+                <td class="default">
+                    {}
+                </td>
+            <td class="description last">Customization options</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+</div>
+<div id="Highlightastringpassedasargumentandreturnastringthatcandirectlybeprinted" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#Highlightastringpassedasargumentandreturnastringthatcandirectlybeprinted'>Highlight a string passed as argument and return a string that can directly be printed</a><span class="signature">(src, lang)</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="term.js.html">term.js</a>, <a href="term.js.html#line9">line 9</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>src</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">The code</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>lang</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">The language of the code</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    The highlighted string
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+</div>
+<div id="Highlightastringpassedasargumentandreturnit" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#Highlightastringpassedasargumentandreturnit'>Highlight a string passed as argument and return it</a><span class="signature">(src, lang, multiline<span class="signature-attributes">opt</span>, opt<span class="signature-attributes">opt</span>)</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line89">line 89</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>src</var>
+                <br/>
+                    <sub class="attributes">
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">The code</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>lang</var>
+                <br/>
+                    <sub class="attributes">
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+                <td class="default">
+                </td>
+            <td class="description last">The language of the code</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>multiline</var>
+                <br/>
+                    <sub class="attributes">
+                        [optional]
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type">Boolean</span>
+            </td>
+                <td class="default">
+                    true
+                </td>
+            <td class="description last">If it is multiline, it will add a wrapper for the line numbering and header</td>
+        </tr>
+        <tr>
+                <th class="name" scope='row'><var>opt</var>
+                <br/>
+                    <sub class="attributes">
+                        [optional]
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type"><a href="global.html#HighlightOptions">HighlightOptions</a></span>
+            </td>
+                <td class="default">
+                    {}
+                </td>
+            <td class="description last">Customization options</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    The highlighted string
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+    <h5>Example</h5>
+    <div class='example-wrapper'>
+    <figure class='example'>
+        <figcaption class="code-caption" hidden><b>Example 1.</b></figcaption>
+        <pre class="prettyprint"><code>elm.innerHTML = await highlightText(code, 'js');</code></pre>
+    </figure>
+    </div>
+</div>
+<div id="Highlightandprintagivenstring" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#Highlightandprintagivenstring'>Highlight and print a given string</a><span class="signature">(code)</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="term.js.html">term.js</a>, <a href="term.js.html#line25">line 25</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>code</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">The code</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+</div>
+<div id="Trytofindthelanguagethegivencodebelongto" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#Trytofindthelanguagethegivencodebelongto'>Try to find the language the given code belong to</a><span class="signature">(code)</span><span class="type-signature"> &rarr; {String}</span></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="detect.js.html">detect.js</a>, <a href="detect.js.html#line29">line 29</a>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<div class='table-wrapper'>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>code</var>
+                <br/>
+                </th>
+            <td class="type">
+<span class="param-type">String</span>
+            </td>
+            <td class="description last">The code</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+<h5>Returns:</h5>
+<div class="param-desc">
+    The language of the code
+</div>
+<dl>
+    <dt>
+        Type
+    </dt>
+    <dd>
+<span class="param-type">String</span>
+    </dd>
+</dl>
+</div>
+        <h3 class="subsection-title">Type Definitions</h3>
+<div id="HighlightOptions" class='member'>
+<h4 class="name"><a href='#HighlightOptions'>HighlightOptions</a></h4>
+<dl class="details">
+    <dt class="tag-source">Source:</dt>
+    <dd class="tag-source">
+        <a href="index.js.html">index.js</a>, <a href="index.js.html#line84">line 84</a>
+    </dd>
+</dl>
+    <h5 class="subsection-title">Properties:</h5>
+<div class='table-wrapper'>
+<table class="props">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Default</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <th class="name" scope='row'><var>hideLineNumbers</var>
+                <br/>
+                    <sub class="attributes">
+                        [optional]
+                    </sub>
+                </th>
+            <td class="type">
+<span class="param-type">Boolean</span>
+            </td>
+                <td class="default">
+                    false
+                </td>
+            <td class="description last">Indicates whether to hide line numbers</td>
+        </tr>
+    </tbody>
+</table>
+</div>
+    <h5>Type:</h5>
+    <p>
+<span class="param-type">Object</span>
+</p>
+</div>
+</article>
+			</main>
+			<footer id='page-footer'>
+				<small>Documentation generated by <a href='https://github.com/jsdoc/jsdoc' rel='noreferrer noopener' target='_blank'>JSDoc 3.6.7</a>.</small>
+				<small style='margin-left: 1em;'>Design by <a
+                        href='https://github.com/AlexisPuga'
+                        target='_blank'
+                        rel="noopener noreferrer">Alexis Puga</a>.</small>
+			</footer>
+		</div>
+	</div>
+	<script src='js/jsdoc-template.js' async></script>
+	<script src='js/prettify.min.js' async></script>
+	<link rel='stylesheet' type='text/css' href='css/tomorrow.min.css'/>
+</body>
+</html>