jsonh-ts 1.0.0

package/jsonh-token.ts

@@ -0,0 +1,37 @@
+import JsonTokenType = require("./json-token-type");
+
+/**
+ * A single JSONH token with a {@link JsonTokenType}.
+ */
+class JsonhToken {
+    /**
+     * The type of the token.
+     */
+    #jsonType: JsonTokenType;
+    /**
+     * The type of the token.
+     */
+    get jsonType(): JsonTokenType {
+        return this.#jsonType;
+    }
+    /**
+     * The value of the token, or an empty string.
+     */
+    #value: string;
+    /**
+     * The value of the token, or an empty string.
+     */
+    get value(): string {
+        return this.#value;
+    }
+
+    /**
+     * Constructs a single JSONH token.
+     */
+    constructor(jsonType: JsonTokenType, value: string = "") {
+        this.#jsonType = jsonType;
+        this.#value = value;
+    }
+}
+
+export = JsonhToken;

package/jsonh-version.ts

@@ -0,0 +1,15 @@
+/**
+ * The major versions of the JSONH specification.
+ */
+enum JsonhVersion {
+    /**
+     * Indicates that the latest version should be used (currently {@link V1}).
+     */
+    Latest = 0,
+    /**
+     * Version 1 of the specification, released 2025/03/19.
+     */
+    V1 = 1,
+}
+
+export = JsonhVersion;

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "jsonh-ts",
+  "version": "1.0.0",
+  "description": "JSON for Humans in TypeScript/JavaScript.",
+  "type": "commonjs",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "scripts": {
+    "build": "tsc"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jsonh-org/JsonhTs.git"
+  },
+  "keywords": [
+    "JSONH",
+    "JSON for Humans",
+    "JSON",
+    "JSON5",
+    "HJSON",
+    "config",
+    "parser"
+  ],
+  "author": "Joyless",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/jsonh-org/JsonhTs/issues"
+  },
+  "homepage": "https://github.com/jsonh-org/JsonhTs#readme"
+}

package/result.ts

@@ -0,0 +1,97 @@
+/**
+ * A value or an error.
+ */
+class Result<T = undefined, E extends Error = Error> {
+    /**
+     * The optional value if successful.
+     */
+    #value: T | undefined;
+    /**
+     * The error if unsuccessful.
+     */
+    #error: E | undefined;
+
+    /**
+     * Constructs a successful or failed result from a value and an error.
+     */
+    private constructor(value: T | undefined, error: E | undefined) {
+        this.#value = value;
+        this.#error = error;
+    }
+    /**
+     * Constructs a successful result from an optional value.
+     */
+    static fromValue<T>(value: T | undefined = undefined): Result<T> {
+        return new Result<T>(value, undefined);
+    }
+    /**
+     * Constructs a failed result from an error.
+     */
+    static fromError<T = undefined, E extends Error = Error>(error: E): Result<T, E> {
+        return new Result<T, E>(undefined, error);
+    }
+
+    /**
+     * Returns whether this result is successful (has an optional value).
+     */
+    get isValue(): boolean {
+        return this.#error === undefined;
+    }
+    /**
+     * Returns whether this result is failed (has an error).
+     */
+    get isError(): boolean {
+        return this.#error !== undefined;
+    }
+
+    /**
+     * Returns the value or throws an error.
+     */
+    get value(): T {
+        if (this.#error !== undefined) {
+            throw new Error(`Result was error: \"${this.#error.message}\"`);
+        }
+        if (this.#value === undefined) {
+            throw new Error("Result was not error but had no value");
+        }
+        return this.#value;
+    }
+    /**
+     * Changes the optional value or throws an error.
+     */
+    set value(value: T | undefined) {
+        if (this.#error !== undefined) {
+            throw new Error(`Result was error: \"${this.#error.message}\"`);
+        }
+        this.#value = value;
+    }
+    /**
+     * Returns the optional value or undefined.
+     */
+    get valueOrUndefined(): T | undefined {
+        if (this.#error !== undefined) {
+            return undefined;
+        }
+        return this.#value;
+    }
+    /**
+     * Returns the error or throws an error.
+     */
+    get error(): E {
+        if (this.#error === undefined) {
+            throw new Error("Result was value");
+        }
+        return this.#error;
+    }
+    /**
+     * Returns the optional error or undefined.
+     */
+    get errorOrUndefined(): E | undefined {
+        if (this.#error === undefined) {
+            return undefined;
+        }
+        return this.#error;
+    }
+}
+
+export = Result;

package/string-text-reader.ts

@@ -0,0 +1,35 @@
+import TextReader = require("./text-reader.js");
+
+class StringTextReader extends TextReader {
+    #string: string;
+    #index: number;
+
+    constructor(string: string) {
+        super();
+        this.#string = string;
+        this.#index = 0;
+    }
+
+    override read(): string | null {
+        if (this.#index >= this.#string.length) {
+            return null;
+        }
+        return this.#string.at(this.#index++)!;
+    }
+    override peek(): string | null {
+        if (this.#index >= this.#string.length) {
+            return null;
+        }
+        return this.#string.at(this.#index)!;
+    }
+    override done(): boolean {
+        return this.#index >= this.#string.length;
+    }
+    override readToEnd(): string {
+        let currentIndex: number = this.#index;
+        this.#index = this.#string.length;
+        return this.#string.slice(currentIndex);
+    }
+}
+
+export = StringTextReader;

package/text-reader.ts

@@ -0,0 +1,30 @@
+abstract class TextReader {
+    /**
+     * Returns the next character and increments the position, or returns null.
+     */
+    abstract read(): string | null;
+    /**
+     * Returns the next character, or returns null.
+     */
+    abstract peek(): string | null;
+    /**
+     * Returns whether the text reader is finished reading characters.
+     */
+    abstract done(): boolean;
+    /**
+     * Returns all of the remaining characters.
+     */
+    readToEnd(): string {
+        let result: string = "";
+        while (true) {
+            let next: string | null = this.peek();
+            if (next === null) {
+                break;
+            }
+            result += next;
+        }
+        return result;
+    }
+}
+
+export = TextReader;

package/tsconfig.json

@@ -0,0 +1,38 @@
+{
+    "compilerOptions": {
+        // File Layout
+        "outDir": "./build",
+
+        // Environment Settings
+        "module": "commonjs",
+        "target": "es2022",
+        "lib": ["ES2022"],
+        "types": [],
+
+        // Other Outputs
+        "sourceMap": true,
+        "declaration": true,
+        "declarationMap": true,
+
+        // Stricter Typechecking Options
+        "noUncheckedIndexedAccess": true,
+        "exactOptionalPropertyTypes": true,
+
+        // Style Options
+        "noImplicitReturns": true,
+        "noImplicitOverride": true,
+        //"noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "noFallthroughCasesInSwitch": true,
+        "noPropertyAccessFromIndexSignature": true,
+
+        // Recommended Options
+        "strict": true,
+        "jsx": "react-jsx",
+        "verbatimModuleSyntax": true,
+        "isolatedModules": true,
+        "noUncheckedSideEffectImports": true,
+        "moduleDetection": "force",
+        "skipLibCheck": true,
+    },
+}