toml parser

test.ts

@@ -15,6 +15,7 @@ import "./prettier/test.ts";
 import "./strings/test.ts";
 import "./testing/test.ts";
 import "./textproto/test.ts";
+import "./toml/test.ts";
 import "./ws/test.ts";
 
 import "./testing/main.ts";

toml/README.md

@@ -0,0 +1,56 @@
+# TOML
+
+This module parse TOML files. It follows as much as possible the [TOML specs](https://github.com/toml-lang/toml). Be sure to read the supported types as not every specs is supported at the moment and the handling in TypeScript side is a bit different.
+
+## Supported types and handling
+
+- :heavy_check_mark: [Keys](https://github.com/toml-lang/toml#string)
+- :exclamation: [String](https://github.com/toml-lang/toml#string)
+- :heavy_check_mark: [Multiline String](https://github.com/toml-lang/toml#string)
+- :heavy_check_mark: [Literal String](https://github.com/toml-lang/toml#string)
+- :exclamation: [Integer](https://github.com/toml-lang/toml#integer)
+- :heavy_check_mark: [Float](https://github.com/toml-lang/toml#float)
+- :heavy_check_mark: [Boolean](https://github.com/toml-lang/toml#boolean)
+- :heavy_check_mark: [Offset Date-time](https://github.com/toml-lang/toml#offset-date-time)
+- :heavy_check_mark: [Local Date-time](https://github.com/toml-lang/toml#local-date-time)
+- :heavy_check_mark: [Local Date](https://github.com/toml-lang/toml#local-date)
+- :exclamation: [Local Time](https://github.com/toml-lang/toml#local-time)
+- :heavy_check_mark: [Table](https://github.com/toml-lang/toml#table)
+- :exclamation: [Inline Table](https://github.com/toml-lang/toml#inline-table)
+- :x: [Array of Tables](https://github.com/toml-lang/toml#array-of-tables)
+
+:exclamation: _Supported with warnings see [Warning](#Warning)._
+
+### :warning: Warning
+
+#### String
+
+- Regex : Due to the spec, there is no flag to detect regex properly in a TOML declaration. So the regex is stored as string.
+
+#### Integer
+
+For **Binary** / **Octal** / **Hexadecimal** numbers, they are stored as string to be not interpreted as Decimal.
+
+#### Local Time
+
+Because local time does not exist in JavaScript, the local time is stored as a string.
+
+#### Inline Table
+
+Inline tables are supported but nested inline property name are **not**. See below:
+
+```toml
+animal = { type = { name = "pug" } } # Supported
+animal = { type.name = "pug" } # not supported. Will output { "animal" : {"type.name":"pug"} }
+```
+
+## Usage
+
+```ts
+import { parseFile, parse } from "./parser.ts";
+
+const tomlObject = parseFile("file.toml");
+
+const tomlString = 'foo.bar = "Deno"';
+const tomlObject22 = parse(tomlString);
+```

toml/parser.ts

@@ -0,0 +1,298 @@
+// Copyright 2018-2019 the Deno authors. All rights reserved. MIT license.
+import { existsSync } from "../fs/exists.ts";
+import { deepAssign } from "../util/deep_assign.ts";
+
+const regGroup = /\[.*\]/;
+class KeyValuePair {
+  key: string;
+  value: unknown;
+}
+class ParserGroup {
+  type: string;
+  name: string;
+  arrValues: unknown[] = [];
+  objValues: object = {};
+}
+class ParserContext {
+  currentGroup?: ParserGroup;
+  output: object = {};
+}
+class Parser {
+  tomlLines: string[];
+  context: ParserContext;
+  constructor(tomlString: string) {
+    this.tomlLines = this._split(tomlString);
+    this.context = new ParserContext();
+  }
+  _sanitize(): void {
+    const out = [];
+    for (let i = 0; i < this.tomlLines.length; i++) {
+      const s = this.tomlLines[i].split("#")[0];
+      if (s !== "") {
+        out.push(s);
+      }
+    }
+    this.tomlLines = out;
+    this._mergeMultilines();
+  }
+
+  _mergeMultilines(): void {
+    function multilineArrayStart(line: string): boolean {
+      const reg = /.*=\s*\[/g;
+      return reg.test(line) && !line.endsWith(']');
+    }
+
+    function multilineArrayEnd(line: string): boolean {
+      return line.endsWith("]");
+    }
+
+    function multilineStringStart(line: string): boolean {
+      const m = line.match(/.*=\s*(?:\"\"\"|''')/);
+      if (!m) {
+        return false;
+      }
+      return !line.endsWith(`"""`) || !line.endsWith(`'''`);
+    }
+
+    function multilineStringEnd(line: string): boolean {
+      return line.endsWith(`'''`) || line.endsWith(`"""`);
+    }
+
+    function isLiteralString(line: string): boolean {
+      return line.match(/'''/) ? true : false;
+    }
+
+    let merged = [],
+      acc = [],
+      isLiteral = false,
+      capture = false,
+      captureType = "",
+      merge = false;
+
+    for (let i = 0; i < this.tomlLines.length; i++) {
+      const line = this.tomlLines[i];
+      const trimmed = line.trim();
+      if (!capture && multilineArrayStart(trimmed)) {
+        capture = true;
+        captureType = "array";
+      } else if (!capture && multilineStringStart(trimmed)) {
+        isLiteral = isLiteralString(trimmed);
+        capture = true;
+        captureType = "string";
+      } else if (capture && multilineArrayEnd(trimmed)) {
+        merge = true;
+      } else if (capture && multilineStringEnd(trimmed)) {
+        merge = true;
+      }
+
+      if (capture) {
+        acc.push(line);
+      } else {
+        merged.push(line);
+      }
+
+      if (merge) {
+        capture = false;
+        merge = false;
+        if (captureType === "string") {
+          // see TOML specs for literal parsing
+          if (!isLiteral) {
+            for (let i = 0; i < acc.length; i++) {
+              acc[i] = acc[i].trim();
+            }
+          }
+          merged.push(
+            acc
+              .join("\n")
+              .replace(/"""/g, '"')
+              .replace(/'''/g, `'`)
+              .replace(/\n/g, "\\n")
+          );
+          isLiteral = false;
+        } else {
+          merged.push(acc.join(""));
+        }
+        captureType = "";
+        acc = [];
+      }
+    }
+    this.tomlLines = merged;
+  }
+  _unflat(keys: string[], values: object = {}, cObj: object = {}): object {
+    let out = {};
+    if (keys.length === 0) {
+      return cObj;
+    } else {
+      if (Object.keys(cObj).length === 0) {
+        cObj = values;
+      }
+      let key = keys.pop();
+      out[key] = cObj;
+      return this._unflat(keys, values, out);
+    }
+  }
+  _groupToOutput(): void {
+    const arrProperty = this.context.currentGroup.name.split(".");
+    let u = this._unflat(arrProperty, this.context.currentGroup.objValues);
+    deepAssign(this.context.output, u);
+    delete this.context.currentGroup;
+  }
+  _split(str: string): string[] {
+    let out = [];
+    out.push(...str.split("\n"));
+    return out;
+  }
+  _isGroup(line: string): boolean {
+    const t = line.trim();
+    return t.startsWith("[") && t.endsWith("]");
+  }
+  _isDeclaration(line: string): boolean {
+    return line.split("=").length > 1;
+  }
+  _createGroup(line: string): void {
+    const captureReg = /\[(.*)\]/;
+    if (this.context.currentGroup) {
+      this._groupToOutput();
+    }
+    let g = new ParserGroup();
+    g.name = line.match(captureReg)[1];
+    if (g.name.match(regGroup)) {
+      g.type = "array";
+      g.name = g.name.match(captureReg)[1];
+    } else {
+      g.type = "object";
+    }
+    this.context.currentGroup = g;
+  }
+  _processDeclaration(line: string): KeyValuePair {
+    let kv = new KeyValuePair();
+    const idx = line.indexOf("=");
+    kv.key = line.substring(0, idx).trim();
+    kv.value = this._parseData(line.slice(idx + 1));
+    return kv;
+  }
+  _parseData(dataString: string): unknown {
+    dataString = dataString.trim();
+    if (this._isDate(dataString)) {
+      return new Date(dataString);
+    }
+    if (this._isLocalTime(dataString)) {
+      return eval(`"${dataString}"`);
+    }
+    if (dataString === "inf" || dataString === "+inf") {
+      return Infinity;
+    }
+    if (dataString === "-inf") {
+      return -Infinity;
+    }
+    if (
+      dataString === "nan" ||
+      dataString === "+nan" ||
+      dataString === "-nan"
+    ) {
+      return NaN;
+    }
+    // inline table
+    if (dataString.startsWith("{") && dataString.endsWith("}")) {
+      const reg = /([a-zA-Z0-9-_\.]*) (=)/gi;
+      let result;
+      while ((result = reg.exec(dataString))) {
+        let ogVal = result[0];
+        let newVal = ogVal
+          .replace(result[1], `"${result[1]}"`)
+          .replace(result[2], ":");
+        dataString = dataString.replace(ogVal, newVal);
+      }
+      // TODO : unflat if necessary
+      return JSON.parse(dataString);
+    }
+    // If binary / octal / hex
+    if (
+      dataString.startsWith("0b") ||
+      dataString.startsWith("0o") ||
+      dataString.startsWith("0x")
+    ) {
+      return dataString;
+    }
+
+    if (this._isParsableNumber(dataString)) {
+      if (isNaN(parseFloat(dataString))) {
+        return eval(dataString);
+      } else {
+        return parseFloat(dataString.replace(/_/g, ""));
+      }
+    }
+
+    // Handle First and last EOL for multiline strings
+    if (dataString.startsWith(`"\\n`)) {
+      dataString = dataString.replace(`"\\n`, `"`);
+    } else if (dataString.startsWith(`'\\n`)) {
+      dataString = dataString.replace(`'\\n`, `'`);
+    }
+    if (dataString.endsWith(`\\n"`)) {
+      dataString = dataString.replace(`\\n"`, `"`);
+    } else if (dataString.endsWith(`\\n'`)) {
+      dataString = dataString.replace(`\\n'`, `'`);
+    }
+
+    return eval(dataString);
+  }
+  _isLocalTime(str: string): boolean {
+    const reg = /(\d{2}):(\d{2}):(\d{2})/;
+    return reg.test(str);
+  }
+  _isParsableNumber(dataString: string): boolean {
+    let d = dataString.replace("_", "");
+    return !isNaN(parseFloat(d.replace("_", "")));
+  }
+  _isDate(dateStr: string): boolean {
+    const reg = /\d{4}-\d{2}-\d{2}/;
+    return reg.test(dateStr);
+  }
+  _parseLines(): void {
+    for (let i = 0; i < this.tomlLines.length; i++) {
+      const line = this.tomlLines[i];
+      if (this._isGroup(line)) {
+        this._createGroup(line);
+        continue;
+      }
+      if (this._isDeclaration(line)) {
+        let kv = this._processDeclaration(line);
+        if (!this.context.currentGroup) {
+          this.context.output[kv.key] = kv.value;
+        } else {
+          if (this.context.currentGroup.type === "array") {
+            // TODO (zekth) : handle array [[fruit]]
+            let out = {};
+            out[kv.key] = kv.value;
+            this.context.currentGroup.arrValues.push(out);
+          } else {
+            this.context.currentGroup.objValues[kv.key] = kv.value;
+          }
+        }
+      }
+    }
+    if (this.context.currentGroup) {
+      this._groupToOutput();
+    }
+  }
+  parse(): object {
+    this._sanitize();
+    this._parseLines();
+    return this.context.output;
+  }
+}
+
+export function parse(tomlString: string): object {
+  // File is potentially using EOL CRLF
+  tomlString = tomlString.replace(/\r\n/g, "\n");
+  return new Parser(tomlString).parse();
+}
+export function parseFile(filePath: string): object {
+  if (!existsSync(filePath)) {
+    throw new Error("File not found");
+  }
+  const decoder = new TextDecoder();
+  const strFile = decoder.decode(Deno.readFileSync(filePath));
+  return parse(strFile);
+}