Added support for deno

Author: luvies

.npmignore

@@ -1,5 +1,5 @@
 .vscode/
-src/
+docs/
 test/
 types/
 .editorconfig

README.md

@@ -1,7 +1,17 @@
 # Format Tree
-This library allows complete formatting of trees with guides and configurability that look similar to how npm and yarn dispay trees. The functions expect the predefined structure as defined in [index.ts](src/index.ts), and the full documentation for that format is also described there. However, some examples are show here (which are taken from the [test file](test/test.ts))
+This library allows complete formatting of trees with guides and configurability that look similar to how npm and yarn dispay trees. The functions expect the predefined structure as defined in [mod.ts](lib/mod.ts), and the full documentation for that format is also described there. However, some examples are shown here (which are taken from the [test file](test/test.ts))
 
-## Node-based
+This library is compatible with [deno](https://github.com/denoland/deno) via the following direct import:
+
+`https://raw.githubusercontent.com/luvies/format-tree/{tag}/lib/mod.ts`
+
+or by using the slightly nicer:
+
+`https://denopkg.com/luvies/format-tree@{tag}/lib/mod.ts`
+
+In both cases, the `{tag}` identifier is the release version you are targeting. I would recommend against using master directly (as, in general, the master branch is not guaranteed to be stable).
+
+## With first item
 Source:
 
 ```ts
@@ -66,7 +76,7 @@ Output:
 
 ![node-stype output](docs/img/node-style.png)
 
-## List-style
+## Without first item
 Source:
 
 ```ts

lib/mod.ts

@@ -1,5 +1,24 @@
-import stringLength from 'string-length';
+// These snippets are taken from the source to bypass the NPM system, and allow Deno support.
 
+// Taken from https://github.com/chalk/strip-ansi/blob/master/index.js
+const ansiPatterns = [
+  '[\\u001B\\u009B][[\\]()#;?]*(?:(?:(?:[a-zA-Z\\d]*(?:;[a-zA-Z\\d]*)*)?\\u0007)',
+  '(?:(?:\\d{1,4}(?:;\\d{0,4})*)?[\\dA-PR-TZcf-ntqry=><~]))',
+].join('|');
+
+const ansiRegex = new RegExp(ansiPatterns, 'g');
+
+// Taken from https://github.com/kevva/astral-regex/blob/master/index.js
+const astralRegex = /[\uD800-\uDBFF][\uDC00-\uDFFF]/g;
+
+// Taken from https://github.com/sindresorhus/string-length/blob/master/index.js
+function stringLength(str: string): number {
+  return str.replace(ansiRegex, '').replace(astralRegex, ' ').length;
+}
+
+/**
+ * The options to configure the formatting of the tree.
+ */
 export interface Options {
   /**
    * The function used to format the guides. Mainly used for adding
@@ -98,13 +117,13 @@ export function formatTree(tree: TreeNode | TreeNode[], options: Options = {}):
   let shouldFirstCap = true;
   const inset = options.inset || 0;
 
-  // process nodes function
+  // Process nodes function.
   const processNodes = (nodes: TreeNode[], prefix: string) => {
     for (let i = 0; i < nodes.length; i++) {
-      // shorthands
+      // Shorthands.
       const node = nodes[i];
 
-      // set up guide for current node
+      // Set up guide for current node.
       let guide: string;
       const last = i === nodes.length - 1;
       const hasChildren = node.children && node.children.length;
@@ -134,18 +153,18 @@ export function formatTree(tree: TreeNode | TreeNode[], options: Options = {}):
       }
       guide += ' ';
 
-      // apply format function
+      // Apply format function.
       if (options.guideFormat) {
         guide = options.guideFormat(guide);
       }
 
-      // build current line
+      // Build current line.
       toBuild.push({
         line: prefix + guide + node.text,
         extra: node.extra,
       });
 
-      // build children
+      // Build children.
       if (hasChildren) {
         let nprefix = `${prefix}${last ? ' ' : '│'} ${inset === 1 ? ' ' : ''}`;
         if (options.guideFormat) {
@@ -159,7 +178,7 @@ export function formatTree(tree: TreeNode | TreeNode[], options: Options = {}):
     }
   };
 
-  // start tree formatting
+  // Start tree formatting.
   let tr: TreeNode[] | undefined;
   if (Array.isArray(tree)) {
     tr = tree;
@@ -175,13 +194,13 @@ export function formatTree(tree: TreeNode | TreeNode[], options: Options = {}):
     processNodes(tr, '');
   }
 
-  // get the longest name so we can format the extra text occordingly
+  // Get the longest name so we can format the extra text occordingly.
   let maxLen = 0;
   for (const item of toBuild) {
     maxLen = Math.max(maxLen, stringLength(item.line));
   }
 
-  // add extra text and build full output
+  // Add extra text and build full output.
   const output: string[] = [];
   const extraSplit = typeof options.extraSplit === 'undefined' ? ' | ' : options.extraSplit;
   for (const item of toBuild) {

test/deno_test.ts

@@ -0,0 +1,14 @@
+// @ts-ignore
+import { formatTreeString } from '../lib/mod.ts';
+
+// tslint:disable-next-line:no-console
+console.log(formatTreeString({
+  text: 'first',
+  extra: 'extra',
+  children: [
+    {
+      text: 'second',
+      extra: 'another',
+    },
+  ],
+}));