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

@speed-highlight/core 1.1.7 → 1.1.8

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 (127) hide show

package/README.md +56 -9
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/common.js +0 -1
package/dist/detect.js +0 -1
package/dist/index.js +0 -3
package/dist/languages/asm.js +0 -1
package/dist/languages/bash.js +0 -1
package/dist/languages/bf.js +0 -1
package/dist/languages/c.js +0 -1
package/dist/languages/css.js +0 -1
package/dist/languages/csv.js +0 -1
package/dist/languages/diff.js +0 -1
package/dist/languages/docker.js +0 -1
package/dist/languages/git.js +0 -1
package/dist/languages/go.js +0 -1
package/dist/languages/html.js +0 -1
package/dist/languages/http.js +0 -1
package/dist/languages/ini.js +0 -1
package/dist/languages/java.js +0 -1
package/dist/languages/js.js +0 -1
package/dist/languages/js_template_literals.js +0 -1
package/dist/languages/jsdoc.js +0 -1
package/dist/languages/json.js +0 -1
package/dist/languages/leanpub-md.js +0 -2
package/dist/languages/log.js +0 -1
package/dist/languages/lua.js +0 -1
package/dist/languages/make.js +0 -1
package/dist/languages/md.js +0 -2
package/dist/languages/pl.js +0 -1
package/dist/languages/plain.js +0 -1
package/dist/languages/py.js +0 -1
package/dist/languages/regex.js +0 -1
package/dist/languages/rs.js +0 -1
package/dist/languages/sql.js +0 -1
package/dist/languages/todo.js +0 -1
package/dist/languages/toml.js +0 -1
package/dist/languages/ts.js +0 -1
package/dist/languages/uri.js +0 -1
package/dist/languages/xml.js +0 -1
package/dist/languages/yaml.js +0 -1
package/dist/node/common.js +0 -1
package/dist/node/detect.js +0 -1
package/dist/node/index.js +0 -3
package/dist/node/languages/asm.js +0 -1
package/dist/node/languages/bash.js +0 -1
package/dist/node/languages/bf.js +0 -1
package/dist/node/languages/c.js +0 -1
package/dist/node/languages/css.js +0 -1
package/dist/node/languages/csv.js +0 -1
package/dist/node/languages/diff.js +0 -1
package/dist/node/languages/docker.js +0 -1
package/dist/node/languages/git.js +0 -1
package/dist/node/languages/go.js +0 -1
package/dist/node/languages/html.js +0 -1
package/dist/node/languages/http.js +0 -1
package/dist/node/languages/ini.js +0 -1
package/dist/node/languages/java.js +0 -1
package/dist/node/languages/js.js +0 -1
package/dist/node/languages/js_template_literals.js +0 -1
package/dist/node/languages/jsdoc.js +0 -1
package/dist/node/languages/json.js +0 -1
package/dist/node/languages/leanpub-md.js +0 -2
package/dist/node/languages/log.js +0 -1
package/dist/node/languages/lua.js +0 -1
package/dist/node/languages/make.js +0 -1
package/dist/node/languages/md.js +0 -2
package/dist/node/languages/pl.js +0 -1
package/dist/node/languages/plain.js +0 -1
package/dist/node/languages/py.js +0 -1
package/dist/node/languages/regex.js +0 -1
package/dist/node/languages/rs.js +0 -1
package/dist/node/languages/sql.js +0 -1
package/dist/node/languages/todo.js +0 -1
package/dist/node/languages/toml.js +0 -1
package/dist/node/languages/ts.js +0 -1
package/dist/node/languages/uri.js +0 -1
package/dist/node/languages/xml.js +0 -1
package/dist/node/languages/yaml.js +0 -1
package/dist/node/term.js +0 -1
package/dist/node/themes/default.js +0 -1
package/dist/term.js +0 -1
package/dist/themes/atom-dark.css +0 -1
package/dist/themes/dark.css +0 -1
package/dist/themes/default.css +0 -1
package/dist/themes/default.js +0 -1
package/dist/themes/github-dark.css +0 -1
package/dist/themes/github-dim.css +0 -1
package/dist/themes/github-light.css +0 -1
package/dist/themes/visual-studio-dark.css +0 -1
package/examples/dist.html +0 -26
package/src/term.js +0 -19

package/doc/term%0ATerminal%20adaptormodule_.html ADDED Viewed

@@ -0,0 +1,596 @@
+<!DOCTYPE html>
+<html lang='en'>
+<head>
+	<meta charset='utf-8'/>
+	<title>Module: term
+Terminal adaptor - 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>Modules</h3><ul><li><abbr title="Module">Mod</abbr> <a href="detect%250ALanguage%2520detectormodule_.html">detect
+Language detector</a></li><li><abbr title="Module">Mod</abbr> <a href="index%250ABase%2520scriptmodule_.html">index
+Base script</a></li><li><abbr title="Module">Mod</abbr> <a href="term%250ATerminal%2520adaptormodule_.html">term
+Terminal adaptor</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'>Module: term
+Terminal adaptor</h1>
+				</header>
+<article class='doc' data-kind='module' id='term
+Terminal adaptor'>
+<header>
+    <h2><a href='#term
+Terminal adaptor'>term
+Terminal adaptor</a></h2>
+</header>
+    <div class="container-overview">
+<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#line1">line 1</a>
+    </dd>
+</dl>
+  </div>
+        <h3 class="subsection-title">Methods</h3>
+<div id="~highlightText" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#~highlightText'>highlightText</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#line10">line 10</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="~printHighlight" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#~printHighlight'>printHighlight</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#line26">line 26</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="~setThemeChangethecurrentusedthemeforhighlighting" class='method member'>
+    <h4 class="name"><span class="type-signature"></span><a href='#~setThemeChangethecurrentusedthemeforhighlighting'>setTheme
+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#line34">line 34</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>
+</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>

package/doc/term.js.html ADDED Viewed

@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html lang='en'>
+<head>
+	<meta charset='utf-8'/>
+	<title>Source: term.js - 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>Modules</h3><ul><li><abbr title="Module">Mod</abbr> <a href="detect%250ALanguage%2520detectormodule_.html">detect
+Language detector</a></li><li><abbr title="Module">Mod</abbr> <a href="index%250ABase%2520scriptmodule_.html">index
+Base script</a></li><li><abbr title="Module">Mod</abbr> <a href="term%250ATerminal%2520adaptormodule_.html">term
+Terminal adaptor</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'>Source: term.js</h1>
+				</header>
+    <figure class='source-code-wrapper'>
+        <pre class="prettyprint source linenums"><code>/**
+ * @module term
+ * Terminal adaptor
+*/
+import { tokenize } from './index.js';
+let theme = import('./themes/default.js');
+/**
+ * @function highlightText
+ * @async
+ * Highlight a string passed as argument and return a string that can directly be printed
+ * @param {String} src The code
+ * @param {String} lang The language of the code
+ * @returns {String} The highlighted string
+ */
+export const highlightText = async (src, lang) => {
+	let res = '', themeMap = (await theme).default;
+	await tokenize(src, lang, (str, token) => res += token ? `${themeMap[token] ?? ''}${str}\x1b[0m` : str);
+	return res;
+};
+/**
+ * @function printHighlight
+ * @async
+ * Highlight and print a given string
+ * @param {String} code The code
+ */
+export const printHighlight = async (...arg) => console.log(await highlightText(...arg));
+/**
+ * @function setTheme
+ * Change the current used theme for highlighting
+ * @param {String} name The name of the theme
+ */
+export const setTheme = async name => theme = import(`./themes/${name}.js`);
+</code></pre>
+    </figure>
+			</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>