@k-l-lambda/portolan 0.0.0-stage → 0.1.0

package/dist/format.d.ts

@@ -0,0 +1,9 @@
+export interface FormatResult {
+    source: string;
+    /** IDs generated for nodes that had none, with their 1-based lines. */
+    assigned: {
+        line: number;
+        id: string;
+    }[];
+}
+export declare function format(source: string): FormatResult;

package/dist/format.js

@@ -0,0 +1,35 @@
+// `rhumb fmt`, 0.1 subset: assign missing IDs and normalize status aliases.
+//
+// Not yet implemented from spec section 7: re-indentation to 2 spaces, `-` markers,
+// attribute normalization, edge `^` stripping and dedup, blank-line collapsing.
+// Those need a full CST printer; this pass only rewrites node lines in place.
+import { generateId } from "./edit.js";
+import { parse } from "./parse.js";
+export function format(source) {
+    const doc = parse(source);
+    const eol = source.includes("\r\n") ? "\r\n" : "\n";
+    const lines = source.replace(/\r\n?/g, "\n").split("\n");
+    const taken = new Set();
+    const all = [];
+    const walk = (nodes) => nodes.forEach((n) => (all.push(n), walk(n.children)));
+    walk(doc.nodes);
+    for (const n of all)
+        if (n.id)
+            taken.add(n.id);
+    // Lines whose trailing token is an invalid ID (W009): appending another ID would
+    // silently turn that token into title text, so leave them for the user.
+    const skip = new Set(doc.diagnostics.filter((d) => d.code === "W009" || d.code === "E011").map((d) => d.line));
+    const assigned = [];
+    for (const node of all) {
+        const i = node.line - 1;
+        lines[i] = lines[i].replace(/^(\s*[-*]\s+\[)([X~])(\])/, (_m, a, s, b) => a + (s === "X" ? "x" : "/") + b);
+        if (node.id === null && !skip.has(node.line)) {
+            const id = generateId(taken);
+            taken.add(id);
+            lines[i] = `${lines[i].trimEnd()} ^${id}`;
+            assigned.push({ line: node.line, id });
+        }
+    }
+    return { source: lines.join(eol), assigned };
+}
+//# sourceMappingURL=format.js.map

package/dist/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../src/format.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,EAAE;AACF,oFAAoF;AACpF,gFAAgF;AAChF,8EAA8E;AAE9E,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AASnC,MAAM,UAAU,MAAM,CAAC,MAAc;IACnC,MAAM,GAAG,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1B,MAAM,GAAG,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IACpD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAEzD,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,MAAM,GAAG,GAAgB,EAAE,CAAC;IAC5B,MAAM,IAAI,GAAG,CAAC,KAAkB,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;IAC3F,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAChB,KAAK,MAAM,CAAC,IAAI,GAAG;QAAE,IAAI,CAAC,CAAC,EAAE;YAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;IAE/C,iFAAiF;IACjF,wEAAwE;IACxE,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IAE/G,MAAM,QAAQ,GAA6B,EAAE,CAAC;IAC9C,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;QACvB,MAAM,CAAC,GAAG,IAAI,CAAC,IAAI,GAAG,CAAC,CAAC;QACxB,KAAK,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,CAAC,2BAA2B,EAAE,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;QAC5G,IAAI,IAAI,CAAC,EAAE,KAAK,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAC7C,MAAM,EAAE,GAAG,UAAU,CAAC,KAAK,CAAC,CAAC;YAC7B,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACd,KAAK,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAE,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE,CAAC;YAC3C,QAAQ,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,EAAE,EAAE,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,QAAQ,EAAE,CAAC;AAC/C,CAAC"}

package/dist/generated/line-parser.d.ts

@@ -0,0 +1,213 @@
+/** Provides information pointing to a location within a source. */
+export interface Location {
+  /** Line in the parsed source (1-based). */
+  readonly line: number;
+  /** Column in the parsed source (1-based). */
+  readonly column: number;
+  /** Offset in the parsed source (0-based). */
+  readonly offset: number;
+}
+
+/**
+ * Anything that can successfully be converted to a string with `String()`
+ * so that it can be used in error messages.
+ *
+ * The GrammarLocation class in Peggy is a good example.
+ */
+export interface GrammarSourceObject {
+  readonly toString: () => string;
+
+  /**
+   * If specified, allows the grammar source to be embedded in a larger file
+   * at some offset.
+   */
+  readonly offset?: undefined | ((loc: Location) => Location);
+}
+
+/**
+ * Most often, you just use a string with the file name.
+ */
+export type GrammarSource = string | GrammarSourceObject;
+
+/** The `start` and `end` position's of an object within the source. */
+export interface LocationRange {
+  /**
+   * A string or object that was supplied to the `parse()` call as the
+   * `grammarSource` option.
+   */
+  readonly source: GrammarSource;
+  /** Position at the beginning of the expression. */
+  readonly start: Location;
+  /** Position after the end of the expression. */
+  readonly end: Location;
+}
+
+/**
+ * Expected a literal string, like `"foo"i`.
+ */
+export interface LiteralExpectation {
+  readonly type: "literal";
+  readonly text: string;
+  readonly ignoreCase: boolean;
+}
+
+/**
+ * Range of characters, like `a-z`
+ */
+export type ClassRange = [
+  start: string,
+  end: string,
+]
+
+export interface ClassParts extends Array<string | ClassRange> {
+}
+
+/**
+ * Expected a class, such as `[^acd-gz]i`
+ */
+export interface ClassExpectation {
+  readonly type: "class";
+  readonly parts: ClassParts;
+  readonly inverted: boolean;
+  readonly ignoreCase: boolean;
+}
+
+/**
+ * Expected any character, with `.`
+ */
+export interface AnyExpectation {
+  readonly type: "any";
+}
+
+/**
+ * Expected the end of input.
+ */
+export interface EndExpectation {
+  readonly type: "end";
+}
+
+/**
+ * Expected some other input.  These are specified with a rule's
+ * "human-readable name", or with the `expected(message, location)`
+ * function.
+ */
+export interface OtherExpectation {
+  readonly type: "other";
+  readonly description: string;
+}
+
+export type Expectation =
+  | AnyExpectation
+  | ClassExpectation
+  | EndExpectation
+  | LiteralExpectation
+  | OtherExpectation;
+
+/**
+ * Pass an array of these into `SyntaxError.prototype.format()`
+ */
+export interface SourceText {
+  /**
+   * Identifier of an input that was used as a grammarSource in parse().
+   */
+  readonly source: GrammarSource;
+  /** Source text of the input. */
+  readonly text: string;
+}
+
+export declare class SyntaxError extends globalThis.SyntaxError {
+  /**
+   * Constructs the human-readable message from the machine representation.
+   *
+   * @param expected Array of expected items, generated by the parser
+   * @param found Any text that will appear as found in the input instead of
+   *   expected
+   */
+  static buildMessage(expected: Expectation[], found?: string | null | undefined): string;
+  readonly expected: Expectation[];
+  readonly found: string | null | undefined;
+  readonly location: LocationRange;
+  readonly name: string;
+  constructor(
+    message: string,
+    expected: Expectation[],
+    found: string | null,
+    location: LocationRange,
+  );
+
+  /**
+   * With good sources, generates a feature-rich error message pointing to the
+   * error in the input.
+   * @param sources List of {source, text} objects that map to the input.
+   */
+  format(sources: SourceText[]): string;
+}
+
+/**
+ * Trace execution of the parser.
+ */
+export interface ParserTracer {
+  trace: (event: ParserTracerEvent) => void;
+}
+
+export type ParserTracerEvent
+  = {
+      readonly type: "rule.enter";
+      readonly rule: string;
+      readonly location: LocationRange
+    }
+  | {
+      readonly type: "rule.fail";
+      readonly rule: string;
+      readonly location: LocationRange
+    }
+  | {
+      readonly type: "rule.match";
+      readonly rule: string;
+      readonly location: LocationRange
+      /** Return value from the rule. */
+      readonly result: unknown;
+    };
+
+export type StartRuleNames = "Line" | "Inline";
+export interface ParseOptions<T extends StartRuleNames = "Line"> {
+  /**
+   * String or object that will be attached to the each `LocationRange` object
+   * created by the parser. For example, this can be path to the parsed file
+   * or even the File object.
+   */
+  readonly grammarSource?: GrammarSource;
+  readonly startRule?: T;
+  readonly tracer?: ParserTracer;
+
+  // Internal use only:
+  readonly peg$library?: boolean;
+  // Internal use only:
+  peg$currPos?: number;
+  // Internal use only:
+  peg$silentFails?: number;
+  // Internal use only:
+  peg$maxFailExpected?: Expectation[];
+  // Extra application-specific properties
+  [key: string]: unknown;
+}
+
+export declare const StartRules: StartRuleNames[];
+export declare const parse: typeof ParseFunction;
+
+// Overload of ParseFunction for each allowedStartRule
+
+declare function ParseFunction<Options extends ParseOptions<"Line">>(
+  input: string,
+  options?: Options,
+): any;
+
+declare function ParseFunction<Options extends ParseOptions<"Inline">>(
+  input: string,
+  options?: Options,
+): any;
+
+declare function ParseFunction<Options extends ParseOptions<StartRuleNames>>(
+  input: string,
+  options?: Options,
+): any;