webpipe-js 0.1.8 → 0.1.10

package/dist/index.cjs

@@ -30,6 +30,7 @@ __export(index_exports, {
   parseProgram: () => parseProgram,
   parseProgramWithDiagnostics: () => parseProgramWithDiagnostics,
   prettyPrint: () => prettyPrint,
+  printComment: () => printComment,
   printCondition: () => printCondition,
   printConfig: () => printConfig,
   printDescribe: () => printDescribe,
@@ -73,39 +74,103 @@ var Parser = class {
     while (i < this.text.length && this.text[i] !== "\n") i++;
     return i;
   }
+  getLineNumber(pos) {
+    return this.text.slice(0, pos).split("\n").length;
+  }
+  parseInlineComment() {
+    this.skipInlineSpaces();
+    const start = this.pos;
+    if (this.text.startsWith("#", this.pos)) {
+      this.pos++;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "inline",
+        text: text.trim(),
+        style: "#",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    if (this.text.startsWith("//", this.pos)) {
+      this.pos += 2;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "inline",
+        text: text.trim(),
+        style: "//",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    return null;
+  }
+  parseStandaloneComment() {
+    const start = this.pos;
+    if (this.text.startsWith("#", this.pos)) {
+      this.pos++;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "standalone",
+        text: text.trim(),
+        style: "#",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    if (this.text.startsWith("//", this.pos)) {
+      this.pos += 2;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "standalone",
+        text: text.trim(),
+        style: "//",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    return null;
+  }
   parseProgram() {
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     const configs = [];
     const pipelines = [];
     const variables = [];
     const routes = [];
     const describes = [];
+    const comments = [];
     while (!this.eof()) {
-      this.skipSpaces();
+      this.skipWhitespaceOnly();
       if (this.eof()) break;
       const start = this.pos;
+      const comment = this.tryParse(() => this.parseStandaloneComment());
+      if (comment) {
+        comments.push(comment);
+        if (this.cur() === "\n") this.pos++;
+        continue;
+      }
       const cfg = this.tryParse(() => this.parseConfig());
       if (cfg) {
+        cfg.lineNumber = this.getLineNumber(start);
         configs.push(cfg);
         continue;
       }
       const namedPipe = this.tryParse(() => this.parseNamedPipeline());
       if (namedPipe) {
+        namedPipe.lineNumber = this.getLineNumber(start);
         pipelines.push(namedPipe);
         continue;
       }
       const variable = this.tryParse(() => this.parseVariable());
       if (variable) {
+        variable.lineNumber = this.getLineNumber(start);
         variables.push(variable);
         continue;
       }
       const route = this.tryParse(() => this.parseRoute());
       if (route) {
+        route.lineNumber = this.getLineNumber(start);
         routes.push(route);
         continue;
       }
       const describe = this.tryParse(() => this.parseDescribe());
       if (describe) {
+        describe.lineNumber = this.getLineNumber(start);
         describes.push(describe);
         continue;
       }
@@ -124,7 +189,7 @@ var Parser = class {
       const start = Math.max(0, idx);
       this.report("Unclosed backtick-delimited string", start, start + 1, "warning");
     }
-    return { configs, pipelines, variables, routes, describes };
+    return { configs, pipelines, variables, routes, describes, comments };
   }
   eof() {
     return this.pos >= this.len;
@@ -164,6 +229,9 @@ var Parser = class {
       break;
     }
   }
+  skipWhitespaceOnly() {
+    this.consumeWhile((ch) => ch === " " || ch === "	" || ch === "\r" || ch === "\n");
+  }
   skipInlineSpaces() {
     this.consumeWhile((ch) => ch === " " || ch === "	" || ch === "\r");
   }
@@ -291,6 +359,7 @@ var Parser = class {
     const name = this.parseIdentifier();
     this.skipInlineSpaces();
     this.expect("{");
+    const inlineComment = this.parseInlineComment();
     this.skipSpaces();
     const properties = [];
     while (true) {
@@ -301,8 +370,8 @@ var Parser = class {
     }
     this.skipSpaces();
     this.expect("}");
-    this.skipSpaces();
-    return { name, properties };
+    this.skipWhitespaceOnly();
+    return { name, properties, inlineComment: inlineComment || void 0 };
   }
   parsePipelineStep() {
     const result = this.tryParse(() => this.parseResultStep());
@@ -310,22 +379,22 @@ var Parser = class {
     return this.parseRegularStep();
   }
   parseRegularStep() {
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     this.expect("|>");
     this.skipInlineSpaces();
     const name = this.parseIdentifier();
     this.expect(":");
     this.skipInlineSpaces();
     const { config, configType } = this.parseStepConfig();
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     return { kind: "Regular", name, config, configType };
   }
   parseResultStep() {
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     this.expect("|>");
     this.skipInlineSpaces();
     this.expect("result");
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     const branches = [];
     while (true) {
       const br = this.tryParse(() => this.parseResultBranch());
@@ -361,7 +430,7 @@ var Parser = class {
     const steps = [];
     while (true) {
       const save = this.pos;
-      this.skipSpaces();
+      this.skipWhitespaceOnly();
       if (!this.text.startsWith("|>", this.pos)) {
         this.pos = save;
         break;
@@ -378,19 +447,20 @@ var Parser = class {
     const name = this.parseIdentifier();
     this.skipInlineSpaces();
     this.expect("=");
+    const inlineComment = this.parseInlineComment();
     this.skipInlineSpaces();
     const beforePipeline = this.pos;
     const pipeline = this.parsePipeline();
     const end = this.pos;
     this.pipelineRanges.set(name, { start, end });
-    this.skipSpaces();
-    return { name, pipeline };
+    this.skipWhitespaceOnly();
+    return { name, pipeline, inlineComment: inlineComment || void 0 };
   }
   parsePipelineRef() {
     const inline = this.tryParse(() => this.parsePipeline());
     if (inline && inline.steps.length > 0) return { kind: "Inline", pipeline: inline };
     const named = this.tryParse(() => {
-      this.skipSpaces();
+      this.skipWhitespaceOnly();
       this.expect("|>");
       this.skipInlineSpaces();
       this.expect("pipeline:");
@@ -410,19 +480,21 @@ var Parser = class {
     this.expect("=");
     this.skipInlineSpaces();
     const value = this.parseBacktickString();
+    const inlineComment = this.parseInlineComment();
     const end = this.pos;
     this.variableRanges.set(`${varType}::${name}`, { start, end });
-    this.skipSpaces();
-    return { varType, name, value };
+    this.skipWhitespaceOnly();
+    return { varType, name, value, inlineComment: inlineComment || void 0 };
   }
   parseRoute() {
     const method = this.parseMethod();
     this.skipInlineSpaces();
-    const path = this.consumeWhile((c) => c !== " " && c !== "\n");
+    const path = this.consumeWhile((c) => c !== " " && c !== "\n" && c !== "#");
+    const inlineComment = this.parseInlineComment();
     this.skipSpaces();
     const pipeline = this.parsePipelineRef();
-    this.skipSpaces();
-    return { method, path, pipeline };
+    this.skipWhitespaceOnly();
+    return { method, path, pipeline, inlineComment: inlineComment || void 0 };
   }
   parseWhen() {
     const calling = this.tryParse(() => {
@@ -548,6 +620,7 @@ var Parser = class {
     this.expect('"');
     const name = this.consumeWhile((c) => c !== '"');
     this.expect('"');
+    const inlineComment = this.parseInlineComment();
     this.skipSpaces();
     const mocks = [];
     while (true) {
@@ -562,7 +635,7 @@ var Parser = class {
       if (!it) break;
       tests.push(it);
     }
-    return { name, mocks, tests };
+    return { name, mocks, tests, inlineComment: inlineComment || void 0 };
   }
 };
 function parseProgram(text) {
@@ -592,14 +665,24 @@ var ParseFailure = class extends Error {
 };
 function printRoute(route) {
   const lines = [];
-  lines.push(`${route.method} ${route.path}`);
+  const routeLine = `${route.method} ${route.path}`;
+  if (route.inlineComment) {
+    lines.push(`${routeLine} ${printComment(route.inlineComment)}`);
+  } else {
+    lines.push(routeLine);
+  }
   const pipelineLines = formatPipelineRef(route.pipeline);
   pipelineLines.forEach((line) => lines.push(line));
   return lines.join("\n");
 }
 function printConfig(config) {
   const lines = [];
-  lines.push(`config ${config.name} {`);
+  const configLine = `config ${config.name} {`;
+  if (config.inlineComment) {
+    lines.push(`${configLine} ${printComment(config.inlineComment)}`);
+  } else {
+    lines.push(configLine);
+  }
   config.properties.forEach((prop) => {
     const value = formatConfigValue(prop.value);
     lines.push(`  ${prop.key}: ${value}`);
@@ -609,14 +692,23 @@ function printConfig(config) {
 }
 function printPipeline(pipeline) {
   const lines = [];
-  lines.push(`pipeline ${pipeline.name} =`);
+  const pipelineLine = `pipeline ${pipeline.name} =`;
+  if (pipeline.inlineComment) {
+    lines.push(`${pipelineLine} ${printComment(pipeline.inlineComment)}`);
+  } else {
+    lines.push(pipelineLine);
+  }
   pipeline.pipeline.steps.forEach((step) => {
     lines.push(formatPipelineStep(step));
   });
   return lines.join("\n");
 }
 function printVariable(variable) {
-  return `${variable.varType} ${variable.name} = \`${variable.value}\``;
+  const variableLine = `${variable.varType} ${variable.name} = \`${variable.value}\``;
+  if (variable.inlineComment) {
+    return `${variableLine} ${printComment(variable.inlineComment)}`;
+  }
+  return variableLine;
 }
 function printMock(mock, indent = "  ") {
   return `${indent}with mock ${mock.target} returning \`${mock.returnValue}\``;
@@ -642,9 +734,17 @@ function printTest(test) {
   });
   return lines.join("\n");
 }
+function printComment(comment) {
+  return `${comment.style} ${comment.text}`;
+}
 function printDescribe(describe) {
   const lines = [];
-  lines.push(`describe "${describe.name}"`);
+  const describeLine = `describe "${describe.name}"`;
+  if (describe.inlineComment) {
+    lines.push(`${describeLine} ${printComment(describe.inlineComment)}`);
+  } else {
+    lines.push(describeLine);
+  }
   describe.mocks.forEach((mock) => {
     lines.push(printMock(mock));
   });
@@ -659,28 +759,58 @@ function printDescribe(describe) {
 }
 function prettyPrint(program) {
   const lines = [];
-  if (program.configs.length > 0) {
-    lines.push("## Config");
-    program.configs.forEach((config) => {
-      lines.push(printConfig(config));
-      lines.push("");
-    });
-  }
+  const allItems = [];
+  program.configs.forEach((config) => {
+    allItems.push({ type: "config", item: config, lineNumber: config.lineNumber || 0 });
+  });
   program.routes.forEach((route) => {
-    lines.push(printRoute(route));
-    lines.push("");
+    allItems.push({ type: "route", item: route, lineNumber: route.lineNumber || 0 });
   });
   program.pipelines.forEach((pipeline) => {
-    lines.push(printPipeline(pipeline));
-    lines.push("");
+    allItems.push({ type: "pipeline", item: pipeline, lineNumber: pipeline.lineNumber || 0 });
   });
   program.variables.forEach((variable) => {
-    lines.push(printVariable(variable));
+    allItems.push({ type: "variable", item: variable, lineNumber: variable.lineNumber || 0 });
   });
-  if (program.variables.length > 0) lines.push("");
   program.describes.forEach((describe) => {
-    lines.push(printDescribe(describe));
-    lines.push("");
+    allItems.push({ type: "describe", item: describe, lineNumber: describe.lineNumber || 0 });
+  });
+  program.comments.forEach((comment) => {
+    allItems.push({ type: "comment", item: comment, lineNumber: comment.lineNumber || 0 });
+  });
+  allItems.sort((a, b) => a.lineNumber - b.lineNumber);
+  let hasConfigs = false;
+  allItems.forEach((entry, index) => {
+    if (entry.type === "config" && !hasConfigs) {
+      lines.push("## Config");
+      hasConfigs = true;
+    }
+    switch (entry.type) {
+      case "comment":
+        lines.push(printComment(entry.item));
+        break;
+      case "config":
+        lines.push(printConfig(entry.item));
+        lines.push("");
+        break;
+      case "route":
+        lines.push(printRoute(entry.item));
+        lines.push("");
+        break;
+      case "pipeline":
+        lines.push(printPipeline(entry.item));
+        lines.push("");
+        break;
+      case "variable":
+        lines.push(printVariable(entry.item));
+        const nextNonVariable = allItems.slice(index + 1).find((item) => item.type !== "variable");
+        if (nextNonVariable) lines.push("");
+        break;
+      case "describe":
+        lines.push(printDescribe(entry.item));
+        lines.push("");
+        break;
+    }
   });
   return lines.join("\n").trim();
 }
@@ -754,6 +884,7 @@ function formatWhen(when) {
   parseProgram,
   parseProgramWithDiagnostics,
   prettyPrint,
+  printComment,
   printCondition,
   printConfig,
   printDescribe,

package/dist/index.d.cts

@@ -4,10 +4,19 @@ interface Program {
     variables: Variable[];
     routes: Route[];
     describes: Describe[];
+    comments: Comment[];
+}
+interface Comment {
+    type: 'standalone' | 'inline';
+    text: string;
+    style: '#' | '//';
+    lineNumber?: number;
 }
 interface Config {
     name: string;
     properties: ConfigProperty[];
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface ConfigProperty {
     key: string;
@@ -30,16 +39,22 @@ type ConfigValue = {
 interface NamedPipeline {
     name: string;
     pipeline: Pipeline;
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface Variable {
     varType: string;
     name: string;
     value: string;
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface Route {
     method: string;
     path: string;
     pipeline: PipelineRef;
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 type PipelineRef = {
     kind: 'Inline';
@@ -78,6 +93,8 @@ interface Describe {
     name: string;
     mocks: Mock[];
     tests: It[];
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface Mock {
     target: string;
@@ -136,6 +153,7 @@ declare function printVariable(variable: Variable): string;
 declare function printMock(mock: Mock, indent?: string): string;
 declare function printCondition(condition: Condition, indent?: string): string;
 declare function printTest(test: It): string;
+declare function printComment(comment: Comment): string;
 declare function printDescribe(describe: Describe): string;
 declare function prettyPrint(program: Program): string;
 declare function formatConfigValue(value: ConfigValue): string;
@@ -144,4 +162,4 @@ declare function formatStepConfig(config: string, configType: ConfigType): strin
 declare function formatPipelineRef(ref: PipelineRef): string[];
 declare function formatWhen(when: When): string;
 
-export { type Condition, type Config, type ConfigProperty, type ConfigType, type ConfigValue, type Describe, type DiagnosticSeverity, type It, type Mock, type NamedPipeline, type ParseDiagnostic, type Pipeline, type PipelineRef, type PipelineStep, type Program, type ResultBranch, type ResultBranchType, type Route, type Variable, type When, formatConfigValue, formatPipelineRef, formatPipelineStep, formatStepConfig, formatWhen, getPipelineRanges, getVariableRanges, parseProgram, parseProgramWithDiagnostics, prettyPrint, printCondition, printConfig, printDescribe, printMock, printPipeline, printRoute, printTest, printVariable };
+export { type Comment, type Condition, type Config, type ConfigProperty, type ConfigType, type ConfigValue, type Describe, type DiagnosticSeverity, type It, type Mock, type NamedPipeline, type ParseDiagnostic, type Pipeline, type PipelineRef, type PipelineStep, type Program, type ResultBranch, type ResultBranchType, type Route, type Variable, type When, formatConfigValue, formatPipelineRef, formatPipelineStep, formatStepConfig, formatWhen, getPipelineRanges, getVariableRanges, parseProgram, parseProgramWithDiagnostics, prettyPrint, printComment, printCondition, printConfig, printDescribe, printMock, printPipeline, printRoute, printTest, printVariable };

package/dist/index.d.ts

@@ -4,10 +4,19 @@ interface Program {
     variables: Variable[];
     routes: Route[];
     describes: Describe[];
+    comments: Comment[];
+}
+interface Comment {
+    type: 'standalone' | 'inline';
+    text: string;
+    style: '#' | '//';
+    lineNumber?: number;
 }
 interface Config {
     name: string;
     properties: ConfigProperty[];
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface ConfigProperty {
     key: string;
@@ -30,16 +39,22 @@ type ConfigValue = {
 interface NamedPipeline {
     name: string;
     pipeline: Pipeline;
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface Variable {
     varType: string;
     name: string;
     value: string;
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface Route {
     method: string;
     path: string;
     pipeline: PipelineRef;
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 type PipelineRef = {
     kind: 'Inline';
@@ -78,6 +93,8 @@ interface Describe {
     name: string;
     mocks: Mock[];
     tests: It[];
+    lineNumber?: number;
+    inlineComment?: Comment;
 }
 interface Mock {
     target: string;
@@ -136,6 +153,7 @@ declare function printVariable(variable: Variable): string;
 declare function printMock(mock: Mock, indent?: string): string;
 declare function printCondition(condition: Condition, indent?: string): string;
 declare function printTest(test: It): string;
+declare function printComment(comment: Comment): string;
 declare function printDescribe(describe: Describe): string;
 declare function prettyPrint(program: Program): string;
 declare function formatConfigValue(value: ConfigValue): string;
@@ -144,4 +162,4 @@ declare function formatStepConfig(config: string, configType: ConfigType): strin
 declare function formatPipelineRef(ref: PipelineRef): string[];
 declare function formatWhen(when: When): string;
 
-export { type Condition, type Config, type ConfigProperty, type ConfigType, type ConfigValue, type Describe, type DiagnosticSeverity, type It, type Mock, type NamedPipeline, type ParseDiagnostic, type Pipeline, type PipelineRef, type PipelineStep, type Program, type ResultBranch, type ResultBranchType, type Route, type Variable, type When, formatConfigValue, formatPipelineRef, formatPipelineStep, formatStepConfig, formatWhen, getPipelineRanges, getVariableRanges, parseProgram, parseProgramWithDiagnostics, prettyPrint, printCondition, printConfig, printDescribe, printMock, printPipeline, printRoute, printTest, printVariable };
+export { type Comment, type Condition, type Config, type ConfigProperty, type ConfigType, type ConfigValue, type Describe, type DiagnosticSeverity, type It, type Mock, type NamedPipeline, type ParseDiagnostic, type Pipeline, type PipelineRef, type PipelineStep, type Program, type ResultBranch, type ResultBranchType, type Route, type Variable, type When, formatConfigValue, formatPipelineRef, formatPipelineStep, formatStepConfig, formatWhen, getPipelineRanges, getVariableRanges, parseProgram, parseProgramWithDiagnostics, prettyPrint, printComment, printCondition, printConfig, printDescribe, printMock, printPipeline, printRoute, printTest, printVariable };

package/dist/index.mjs

@@ -30,39 +30,103 @@ var Parser = class {
     while (i < this.text.length && this.text[i] !== "\n") i++;
     return i;
   }
+  getLineNumber(pos) {
+    return this.text.slice(0, pos).split("\n").length;
+  }
+  parseInlineComment() {
+    this.skipInlineSpaces();
+    const start = this.pos;
+    if (this.text.startsWith("#", this.pos)) {
+      this.pos++;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "inline",
+        text: text.trim(),
+        style: "#",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    if (this.text.startsWith("//", this.pos)) {
+      this.pos += 2;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "inline",
+        text: text.trim(),
+        style: "//",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    return null;
+  }
+  parseStandaloneComment() {
+    const start = this.pos;
+    if (this.text.startsWith("#", this.pos)) {
+      this.pos++;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "standalone",
+        text: text.trim(),
+        style: "#",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    if (this.text.startsWith("//", this.pos)) {
+      this.pos += 2;
+      const text = this.consumeWhile((ch) => ch !== "\n");
+      return {
+        type: "standalone",
+        text: text.trim(),
+        style: "//",
+        lineNumber: this.getLineNumber(start)
+      };
+    }
+    return null;
+  }
   parseProgram() {
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     const configs = [];
     const pipelines = [];
     const variables = [];
     const routes = [];
     const describes = [];
+    const comments = [];
     while (!this.eof()) {
-      this.skipSpaces();
+      this.skipWhitespaceOnly();
       if (this.eof()) break;
       const start = this.pos;
+      const comment = this.tryParse(() => this.parseStandaloneComment());
+      if (comment) {
+        comments.push(comment);
+        if (this.cur() === "\n") this.pos++;
+        continue;
+      }
       const cfg = this.tryParse(() => this.parseConfig());
       if (cfg) {
+        cfg.lineNumber = this.getLineNumber(start);
         configs.push(cfg);
         continue;
       }
       const namedPipe = this.tryParse(() => this.parseNamedPipeline());
       if (namedPipe) {
+        namedPipe.lineNumber = this.getLineNumber(start);
         pipelines.push(namedPipe);
         continue;
       }
       const variable = this.tryParse(() => this.parseVariable());
       if (variable) {
+        variable.lineNumber = this.getLineNumber(start);
         variables.push(variable);
         continue;
       }
       const route = this.tryParse(() => this.parseRoute());
       if (route) {
+        route.lineNumber = this.getLineNumber(start);
         routes.push(route);
         continue;
       }
       const describe = this.tryParse(() => this.parseDescribe());
       if (describe) {
+        describe.lineNumber = this.getLineNumber(start);
         describes.push(describe);
         continue;
       }
@@ -81,7 +145,7 @@ var Parser = class {
       const start = Math.max(0, idx);
       this.report("Unclosed backtick-delimited string", start, start + 1, "warning");
     }
-    return { configs, pipelines, variables, routes, describes };
+    return { configs, pipelines, variables, routes, describes, comments };
   }
   eof() {
     return this.pos >= this.len;
@@ -121,6 +185,9 @@ var Parser = class {
       break;
     }
   }
+  skipWhitespaceOnly() {
+    this.consumeWhile((ch) => ch === " " || ch === "	" || ch === "\r" || ch === "\n");
+  }
   skipInlineSpaces() {
     this.consumeWhile((ch) => ch === " " || ch === "	" || ch === "\r");
   }
@@ -248,6 +315,7 @@ var Parser = class {
     const name = this.parseIdentifier();
     this.skipInlineSpaces();
     this.expect("{");
+    const inlineComment = this.parseInlineComment();
     this.skipSpaces();
     const properties = [];
     while (true) {
@@ -258,8 +326,8 @@ var Parser = class {
     }
     this.skipSpaces();
     this.expect("}");
-    this.skipSpaces();
-    return { name, properties };
+    this.skipWhitespaceOnly();
+    return { name, properties, inlineComment: inlineComment || void 0 };
   }
   parsePipelineStep() {
     const result = this.tryParse(() => this.parseResultStep());
@@ -267,22 +335,22 @@ var Parser = class {
     return this.parseRegularStep();
   }
   parseRegularStep() {
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     this.expect("|>");
     this.skipInlineSpaces();
     const name = this.parseIdentifier();
     this.expect(":");
     this.skipInlineSpaces();
     const { config, configType } = this.parseStepConfig();
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     return { kind: "Regular", name, config, configType };
   }
   parseResultStep() {
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     this.expect("|>");
     this.skipInlineSpaces();
     this.expect("result");
-    this.skipSpaces();
+    this.skipWhitespaceOnly();
     const branches = [];
     while (true) {
       const br = this.tryParse(() => this.parseResultBranch());
@@ -318,7 +386,7 @@ var Parser = class {
     const steps = [];
     while (true) {
       const save = this.pos;
-      this.skipSpaces();
+      this.skipWhitespaceOnly();
       if (!this.text.startsWith("|>", this.pos)) {
         this.pos = save;
         break;
@@ -335,19 +403,20 @@ var Parser = class {
     const name = this.parseIdentifier();
     this.skipInlineSpaces();
     this.expect("=");
+    const inlineComment = this.parseInlineComment();
     this.skipInlineSpaces();
     const beforePipeline = this.pos;
     const pipeline = this.parsePipeline();
     const end = this.pos;
     this.pipelineRanges.set(name, { start, end });
-    this.skipSpaces();
-    return { name, pipeline };
+    this.skipWhitespaceOnly();
+    return { name, pipeline, inlineComment: inlineComment || void 0 };
   }
   parsePipelineRef() {
     const inline = this.tryParse(() => this.parsePipeline());
     if (inline && inline.steps.length > 0) return { kind: "Inline", pipeline: inline };
     const named = this.tryParse(() => {
-      this.skipSpaces();
+      this.skipWhitespaceOnly();
       this.expect("|>");
       this.skipInlineSpaces();
       this.expect("pipeline:");
@@ -367,19 +436,21 @@ var Parser = class {
     this.expect("=");
     this.skipInlineSpaces();
     const value = this.parseBacktickString();
+    const inlineComment = this.parseInlineComment();
     const end = this.pos;
     this.variableRanges.set(`${varType}::${name}`, { start, end });
-    this.skipSpaces();
-    return { varType, name, value };
+    this.skipWhitespaceOnly();
+    return { varType, name, value, inlineComment: inlineComment || void 0 };
   }
   parseRoute() {
     const method = this.parseMethod();
     this.skipInlineSpaces();
-    const path = this.consumeWhile((c) => c !== " " && c !== "\n");
+    const path = this.consumeWhile((c) => c !== " " && c !== "\n" && c !== "#");
+    const inlineComment = this.parseInlineComment();
     this.skipSpaces();
     const pipeline = this.parsePipelineRef();
-    this.skipSpaces();
-    return { method, path, pipeline };
+    this.skipWhitespaceOnly();
+    return { method, path, pipeline, inlineComment: inlineComment || void 0 };
   }
   parseWhen() {
     const calling = this.tryParse(() => {
@@ -505,6 +576,7 @@ var Parser = class {
     this.expect('"');
     const name = this.consumeWhile((c) => c !== '"');
     this.expect('"');
+    const inlineComment = this.parseInlineComment();
     this.skipSpaces();
     const mocks = [];
     while (true) {
@@ -519,7 +591,7 @@ var Parser = class {
       if (!it) break;
       tests.push(it);
     }
-    return { name, mocks, tests };
+    return { name, mocks, tests, inlineComment: inlineComment || void 0 };
   }
 };
 function parseProgram(text) {
@@ -549,14 +621,24 @@ var ParseFailure = class extends Error {
 };
 function printRoute(route) {
   const lines = [];
-  lines.push(`${route.method} ${route.path}`);
+  const routeLine = `${route.method} ${route.path}`;
+  if (route.inlineComment) {
+    lines.push(`${routeLine} ${printComment(route.inlineComment)}`);
+  } else {
+    lines.push(routeLine);
+  }
   const pipelineLines = formatPipelineRef(route.pipeline);
   pipelineLines.forEach((line) => lines.push(line));
   return lines.join("\n");
 }
 function printConfig(config) {
   const lines = [];
-  lines.push(`config ${config.name} {`);
+  const configLine = `config ${config.name} {`;
+  if (config.inlineComment) {
+    lines.push(`${configLine} ${printComment(config.inlineComment)}`);
+  } else {
+    lines.push(configLine);
+  }
   config.properties.forEach((prop) => {
     const value = formatConfigValue(prop.value);
     lines.push(`  ${prop.key}: ${value}`);
@@ -566,14 +648,23 @@ function printConfig(config) {
 }
 function printPipeline(pipeline) {
   const lines = [];
-  lines.push(`pipeline ${pipeline.name} =`);
+  const pipelineLine = `pipeline ${pipeline.name} =`;
+  if (pipeline.inlineComment) {
+    lines.push(`${pipelineLine} ${printComment(pipeline.inlineComment)}`);
+  } else {
+    lines.push(pipelineLine);
+  }
   pipeline.pipeline.steps.forEach((step) => {
     lines.push(formatPipelineStep(step));
   });
   return lines.join("\n");
 }
 function printVariable(variable) {
-  return `${variable.varType} ${variable.name} = \`${variable.value}\``;
+  const variableLine = `${variable.varType} ${variable.name} = \`${variable.value}\``;
+  if (variable.inlineComment) {
+    return `${variableLine} ${printComment(variable.inlineComment)}`;
+  }
+  return variableLine;
 }
 function printMock(mock, indent = "  ") {
   return `${indent}with mock ${mock.target} returning \`${mock.returnValue}\``;
@@ -599,9 +690,17 @@ function printTest(test) {
   });
   return lines.join("\n");
 }
+function printComment(comment) {
+  return `${comment.style} ${comment.text}`;
+}
 function printDescribe(describe) {
   const lines = [];
-  lines.push(`describe "${describe.name}"`);
+  const describeLine = `describe "${describe.name}"`;
+  if (describe.inlineComment) {
+    lines.push(`${describeLine} ${printComment(describe.inlineComment)}`);
+  } else {
+    lines.push(describeLine);
+  }
   describe.mocks.forEach((mock) => {
     lines.push(printMock(mock));
   });
@@ -616,28 +715,58 @@ function printDescribe(describe) {
 }
 function prettyPrint(program) {
   const lines = [];
-  if (program.configs.length > 0) {
-    lines.push("## Config");
-    program.configs.forEach((config) => {
-      lines.push(printConfig(config));
-      lines.push("");
-    });
-  }
+  const allItems = [];
+  program.configs.forEach((config) => {
+    allItems.push({ type: "config", item: config, lineNumber: config.lineNumber || 0 });
+  });
   program.routes.forEach((route) => {
-    lines.push(printRoute(route));
-    lines.push("");
+    allItems.push({ type: "route", item: route, lineNumber: route.lineNumber || 0 });
   });
   program.pipelines.forEach((pipeline) => {
-    lines.push(printPipeline(pipeline));
-    lines.push("");
+    allItems.push({ type: "pipeline", item: pipeline, lineNumber: pipeline.lineNumber || 0 });
   });
   program.variables.forEach((variable) => {
-    lines.push(printVariable(variable));
+    allItems.push({ type: "variable", item: variable, lineNumber: variable.lineNumber || 0 });
   });
-  if (program.variables.length > 0) lines.push("");
   program.describes.forEach((describe) => {
-    lines.push(printDescribe(describe));
-    lines.push("");
+    allItems.push({ type: "describe", item: describe, lineNumber: describe.lineNumber || 0 });
+  });
+  program.comments.forEach((comment) => {
+    allItems.push({ type: "comment", item: comment, lineNumber: comment.lineNumber || 0 });
+  });
+  allItems.sort((a, b) => a.lineNumber - b.lineNumber);
+  let hasConfigs = false;
+  allItems.forEach((entry, index) => {
+    if (entry.type === "config" && !hasConfigs) {
+      lines.push("## Config");
+      hasConfigs = true;
+    }
+    switch (entry.type) {
+      case "comment":
+        lines.push(printComment(entry.item));
+        break;
+      case "config":
+        lines.push(printConfig(entry.item));
+        lines.push("");
+        break;
+      case "route":
+        lines.push(printRoute(entry.item));
+        lines.push("");
+        break;
+      case "pipeline":
+        lines.push(printPipeline(entry.item));
+        lines.push("");
+        break;
+      case "variable":
+        lines.push(printVariable(entry.item));
+        const nextNonVariable = allItems.slice(index + 1).find((item) => item.type !== "variable");
+        if (nextNonVariable) lines.push("");
+        break;
+      case "describe":
+        lines.push(printDescribe(entry.item));
+        lines.push("");
+        break;
+    }
   });
   return lines.join("\n").trim();
 }
@@ -710,6 +839,7 @@ export {
   parseProgram,
   parseProgramWithDiagnostics,
   prettyPrint,
+  printComment,
   printCondition,
   printConfig,
   printDescribe,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpipe-js",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "description": "Web Pipe parser",
   "license": "ISC",
   "author": "William Cotton",