@effected/toml 0.16.0 → 0.17.0

package/TomlDiagnostic.js

@@ -1,5 +1,6 @@
 import { TOML_LEX_ERROR_CODES, TOML_PARSE_ERROR_CODES, TOML_SEMANTIC_ERROR_CODES, TOML_STRINGIFY_ERROR_CODES } from "./internal/diagnostics.js";
 import { Schema } from "effect";
+import { LineIndex } from "@effected/source";
 
 // src/TomlDiagnostic.ts
 /**
@@ -49,6 +50,15 @@ const TomlErrorCode = Schema.Union([
 * and `@effected/yaml`'s `YamlDiagnostic`; `message` is this package's
 * additive extra.
 *
+* With `message` it satisfies `@effected/source`'s `SourceDiagnostic`
+* structurally, so a consumer written over that interface (an LSP server, a
+* CLI printing annotations) reads it directly. `line` and `character` come
+* from `@effected/source`'s `LineIndex` under its default `"lsp"` rule: a line
+* ends at `\n`, `\r\n` or a bare `\r`, as an LSP client counts. TOML's own
+* newline is `\n` or `\r\n` only, so a bare `\r` is invalid TOML; it is
+* counted as a line break only so a diagnostic about it positions LSP-style.
+* An offset at the `\n` of a `\r\n` reads as the end of its line.
+*
 * @public
 */
 var TomlDiagnostic = class TomlDiagnostic extends Schema.Class("TomlDiagnostic")({
@@ -69,7 +79,7 @@ var TomlDiagnostic = class TomlDiagnostic extends Schema.Class("TomlDiagnostic")
 	* @returns The diagnostic with `line` and `character` filled in.
 	*/
 	static fromRaw(source, raw) {
-		const { line, character } = lineChar(source, raw.offset);
+		const { line, character } = LineIndex.make(source).positionAt(raw.offset);
 		return TomlDiagnostic.make({
 			code: raw.code,
 			message: raw.message,
@@ -80,30 +90,5 @@ var TomlDiagnostic = class TomlDiagnostic extends Schema.Class("TomlDiagnostic")
 		});
 	}
 };
-/**
-* Compute the zero-based line/character position of `offset` within `text`.
-* Recognizes `\n`, `\r` and `\r\n` as line breaks (TOML's newline grammar);
-* a CRLF pair counts as a single newline.
-*/
-function lineChar(text, offset) {
-	let line = 0;
-	let lineStart = 0;
-	const limit = Math.min(offset, text.length);
-	for (let i = 0; i < limit; i++) {
-		const ch = text.charCodeAt(i);
-		if (ch === 10) {
-			line++;
-			lineStart = i + 1;
-		} else if (ch === 13) {
-			if (i + 1 < text.length && text.charCodeAt(i + 1) === 10) i++;
-			line++;
-			lineStart = i + 1;
-		}
-	}
-	return {
-		line,
-		character: offset - lineStart
-	};
-}
 
 export { TomlDiagnostic, TomlErrorCode, TomlLexErrorCode, TomlParseErrorCode, TomlSemanticErrorCode, TomlStringifyErrorCode };

package/index.d.ts

@@ -79,6 +79,15 @@ declare const TomlDiagnostic_base: Schema.Class<TomlDiagnostic, Schema.Struct<{
  * and `@effected/yaml`'s `YamlDiagnostic`; `message` is this package's
  * additive extra.
  *
+ * With `message` it satisfies `@effected/source`'s `SourceDiagnostic`
+ * structurally, so a consumer written over that interface (an LSP server, a
+ * CLI printing annotations) reads it directly. `line` and `character` come
+ * from `@effected/source`'s `LineIndex` under its default `"lsp"` rule: a line
+ * ends at `\n`, `\r\n` or a bare `\r`, as an LSP client counts. TOML's own
+ * newline is `\n` or `\r\n` only, so a bare `\r` is invalid TOML; it is
+ * counted as a line break only so a diagnostic about it positions LSP-style.
+ * An offset at the `\n` of a `\r\n` reads as the end of its line.
+ *
  * @public
  */
 export declare class TomlDiagnostic extends TomlDiagnostic_base {
@@ -1055,125 +1064,22 @@ export type TomlVisitorEvent = Data.TaggedEnum<{
  *
  * @public
  */
-export declare const TomlVisitorEvent: {
-  readonly $is: <Tag extends "ArrayTableStart" | "Comment" | "KeyValue" | "TableStart">(tag: Tag) => (u: unknown) => u is Extract<{
-    readonly _tag: "ArrayTableStart";
-    readonly path: ReadonlyArray<string>;
-    readonly index: number;
-  }, {
-    readonly _tag: Tag;
-  }> | Extract<{
-    readonly _tag: "Comment";
-    readonly text: string;
-    readonly offset: number;
-  }, {
-    readonly _tag: Tag;
-  }> | Extract<{
-    readonly _tag: "KeyValue";
-    readonly path: ReadonlyArray<string>;
-    readonly node: TomlKeyValue;
-  }, {
-    readonly _tag: Tag;
-  }> | Extract<{
-    readonly _tag: "TableStart";
-    readonly path: ReadonlyArray<string>;
-  }, {
-    readonly _tag: Tag;
-  }>;
-  readonly $match: {
-    <Cases extends {
-      readonly ArrayTableStart: (args: {
-        readonly _tag: "ArrayTableStart";
-        readonly path: ReadonlyArray<string>;
-        readonly index: number;
-      }) => any;
-      readonly Comment: (args: {
-        readonly _tag: "Comment";
-        readonly text: string;
-        readonly offset: number;
-      }) => any;
-      readonly KeyValue: (args: {
-        readonly _tag: "KeyValue";
-        readonly path: ReadonlyArray<string>;
-        readonly node: TomlKeyValue;
-      }) => any;
-      readonly TableStart: (args: {
-        readonly _tag: "TableStart";
-        readonly path: ReadonlyArray<string>;
-      }) => any;
-    }>(cases: Cases): (value: {
-      readonly _tag: "ArrayTableStart";
-      readonly path: ReadonlyArray<string>;
-      readonly index: number;
-    } | {
-      readonly _tag: "Comment";
-      readonly text: string;
-      readonly offset: number;
-    } | {
-      readonly _tag: "KeyValue";
-      readonly path: ReadonlyArray<string>;
-      readonly node: TomlKeyValue;
-    } | {
-      readonly _tag: "TableStart";
-      readonly path: ReadonlyArray<string>;
-    }) => import("effect/Unify").Unify<ReturnType<Cases["ArrayTableStart" | "Comment" | "KeyValue" | "TableStart"]>>;
-    <Cases extends {
-      readonly ArrayTableStart: (args: {
-        readonly _tag: "ArrayTableStart";
-        readonly path: ReadonlyArray<string>;
-        readonly index: number;
-      }) => any;
-      readonly Comment: (args: {
-        readonly _tag: "Comment";
-        readonly text: string;
-        readonly offset: number;
-      }) => any;
-      readonly KeyValue: (args: {
-        readonly _tag: "KeyValue";
-        readonly path: ReadonlyArray<string>;
-        readonly node: TomlKeyValue;
-      }) => any;
-      readonly TableStart: (args: {
-        readonly _tag: "TableStart";
-        readonly path: ReadonlyArray<string>;
-      }) => any;
-    }>(value: {
-      readonly _tag: "ArrayTableStart";
-      readonly path: ReadonlyArray<string>;
-      readonly index: number;
-    } | {
-      readonly _tag: "Comment";
-      readonly text: string;
-      readonly offset: number;
-    } | {
-      readonly _tag: "KeyValue";
-      readonly path: ReadonlyArray<string>;
-      readonly node: TomlKeyValue;
-    } | {
-      readonly _tag: "TableStart";
-      readonly path: ReadonlyArray<string>;
-    }, cases: Cases): import("effect/Unify").Unify<ReturnType<Cases["ArrayTableStart" | "Comment" | "KeyValue" | "TableStart"]>>;
-  };
-  readonly ArrayTableStart: Data.TaggedEnum.ConstructorFrom<{
-    readonly _tag: "ArrayTableStart";
-    readonly path: ReadonlyArray<string>;
-    readonly index: number;
-  }, "_tag">;
-  readonly Comment: Data.TaggedEnum.ConstructorFrom<{
-    readonly _tag: "Comment";
-    readonly text: string;
-    readonly offset: number;
-  }, "_tag">;
-  readonly KeyValue: Data.TaggedEnum.ConstructorFrom<{
-    readonly _tag: "KeyValue";
-    readonly path: ReadonlyArray<string>;
-    readonly node: TomlKeyValue;
-  }, "_tag">;
-  readonly TableStart: Data.TaggedEnum.ConstructorFrom<{
-    readonly _tag: "TableStart";
-    readonly path: ReadonlyArray<string>;
-  }, "_tag">;
-};
+export declare const TomlVisitorEvent: Data.TaggedEnum.Constructor<{
+  readonly _tag: "ArrayTableStart";
+  readonly path: ReadonlyArray<string>;
+  readonly index: number;
+} | {
+  readonly _tag: "Comment";
+  readonly text: string;
+  readonly offset: number;
+} | {
+  readonly _tag: "KeyValue";
+  readonly path: ReadonlyArray<string>;
+  readonly node: TomlKeyValue;
+} | {
+  readonly _tag: "TableStart";
+  readonly path: ReadonlyArray<string>;
+}>;
 /**
  * Walks TOML text as a `Stream` of table, array-table, key-value and comment
  * events in document order, without building a value. Not instantiable.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@effected/toml",
-	"version": "0.16.0",
+	"version": "0.17.0",
 	"private": false,
 	"description": "TOML 1.1.0 parsing, editing and formatting as Effect schemas: typed diagnostics, a lossless CST and first-class date-time values.",
 	"keywords": [
@@ -37,6 +37,9 @@
 		},
 		"./package.json": "./package.json"
 	},
+	"dependencies": {
+		"@effected/source": "^0.1.0"
+	},
 	"peerDependencies": {
 		"effect": "^4.0.0"
 	},

package/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.59.1"
+      "packageVersion": "7.59.4"
     }
   ]
 }