aboutsummaryrefslogtreecommitdiff
path: root/node_modules/@babel/highlight/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/@babel/highlight/README.md')
-rw-r--r--node_modules/@babel/highlight/README.md41
1 files changed, 41 insertions, 0 deletions
diff --git a/node_modules/@babel/highlight/README.md b/node_modules/@babel/highlight/README.md
new file mode 100644
index 00000000..36143844
--- /dev/null
+++ b/node_modules/@babel/highlight/README.md
@@ -0,0 +1,41 @@
+# @babel/highlight
+
+> Syntax highlight JavaScript strings for output in terminals.
+
+## Install
+
+```sh
+npm install --save @babel/highlight
+```
+
+## Usage
+
+```js
+import highlight from "@babel/highlight";
+
+const code = `class Foo {
+ constructor()
+}`;
+
+const result = highlight(code);
+
+console.log(result);
+```
+
+```js
+class Foo {
+ constructor()
+}
+```
+
+By default, `highlight` will not highlight your code if your terminal does not support color. To force colors, pass `{ forceColor: true }` as the second argument to `highlight`.
+
+```js
+import highlight from "@babel/highlight";
+
+const code = `class Foo {
+ constructor()
+}`;
+
+const result = highlight(code, { forceColor: true });
+```