webpipe-js 0.1.7 → 0.1.9

package/dist/index.cjs

@@ -73,6 +73,9 @@ 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;
+  }
   parseProgram() {
     this.skipSpaces();
     const configs = [];
@@ -86,26 +89,31 @@ var Parser = class {
       const start = this.pos;
       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;
       }
@@ -240,11 +248,11 @@ var Parser = class {
   }
   parseStepConfig() {
     const bt = this.tryParse(() => this.parseBacktickString());
-    if (bt !== null) return bt;
+    if (bt !== null) return { config: bt, configType: "backtick" };
     const dq = this.tryParse(() => this.parseQuotedString());
-    if (dq !== null) return dq;
+    if (dq !== null) return { config: dq, configType: "quoted" };
     const id = this.tryParse(() => this.parseIdentifier());
-    if (id !== null) return id;
+    if (id !== null) return { config: id, configType: "identifier" };
     throw new ParseFailure("step-config", this.pos);
   }
   parseConfigValue() {
@@ -316,9 +324,9 @@ var Parser = class {
     const name = this.parseIdentifier();
     this.expect(":");
     this.skipInlineSpaces();
-    const config = this.parseStepConfig();
+    const { config, configType } = this.parseStepConfig();
     this.skipSpaces();
-    return { kind: "Regular", name, config };
+    return { kind: "Regular", name, config, configType };
   }
   parseResultStep() {
     this.skipSpaces();
@@ -659,28 +667,52 @@ 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 });
+  });
+  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 "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();
 }
@@ -698,7 +730,7 @@ function formatConfigValue(value) {
 }
 function formatPipelineStep(step, indent = "  ") {
   if (step.kind === "Regular") {
-    return `${indent}|> ${step.name}: ${formatStepConfig(step.config)}`;
+    return `${indent}|> ${step.name}: ${formatStepConfig(step.config, step.configType)}`;
   } else {
     const lines = [`${indent}|> result`];
     step.branches.forEach((branch) => {
@@ -711,33 +743,16 @@ function formatPipelineStep(step, indent = "  ") {
     return lines.join("\n");
   }
 }
-function formatStepConfig(config) {
-  if (config.includes("\n") || config.includes("{") || config.includes("[") || config.includes(".") || config.includes("(")) {
-    return `\`${config}\``;
-  } else if (config.includes(" ")) {
-    return `"${config}"`;
-  } else if (isAuthStringValue(config)) {
-    return `"${config}"`;
-  } else {
-    return config;
+function formatStepConfig(config, configType) {
+  switch (configType) {
+    case "backtick":
+      return `\`${config}\``;
+    case "quoted":
+      return `"${config}"`;
+    case "identifier":
+      return config;
   }
 }
-function isAuthStringValue(config) {
-  const authValues = [
-    "login",
-    "logout",
-    "register",
-    "required",
-    "optional"
-  ];
-  if (authValues.includes(config)) {
-    return true;
-  }
-  if (config.startsWith("type:")) {
-    return true;
-  }
-  return false;
-}
 function formatPipelineRef(ref) {
   if (ref.kind === "Named") {
     return [`  |> pipeline: ${ref.name}`];

package/dist/index.d.cts

@@ -8,6 +8,7 @@ interface Program {
 interface Config {
     name: string;
     properties: ConfigProperty[];
+    lineNumber?: number;
 }
 interface ConfigProperty {
     key: string;
@@ -30,16 +31,19 @@ type ConfigValue = {
 interface NamedPipeline {
     name: string;
     pipeline: Pipeline;
+    lineNumber?: number;
 }
 interface Variable {
     varType: string;
     name: string;
     value: string;
+    lineNumber?: number;
 }
 interface Route {
     method: string;
     path: string;
     pipeline: PipelineRef;
+    lineNumber?: number;
 }
 type PipelineRef = {
     kind: 'Inline';
@@ -51,10 +55,12 @@ type PipelineRef = {
 interface Pipeline {
     steps: PipelineStep[];
 }
+type ConfigType = 'backtick' | 'quoted' | 'identifier';
 type PipelineStep = {
     kind: 'Regular';
     name: string;
     config: string;
+    configType: ConfigType;
 } | {
     kind: 'Result';
     branches: ResultBranch[];
@@ -76,6 +82,7 @@ interface Describe {
     name: string;
     mocks: Mock[];
     tests: It[];
+    lineNumber?: number;
 }
 interface Mock {
     target: string;
@@ -138,8 +145,8 @@ declare function printDescribe(describe: Describe): string;
 declare function prettyPrint(program: Program): string;
 declare function formatConfigValue(value: ConfigValue): string;
 declare function formatPipelineStep(step: PipelineStep, indent?: string): string;
-declare function formatStepConfig(config: string): string;
+declare function formatStepConfig(config: string, configType: ConfigType): string;
 declare function formatPipelineRef(ref: PipelineRef): string[];
 declare function formatWhen(when: When): string;
 
-export { type Condition, type Config, type ConfigProperty, 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 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 };

package/dist/index.d.ts

@@ -8,6 +8,7 @@ interface Program {
 interface Config {
     name: string;
     properties: ConfigProperty[];
+    lineNumber?: number;
 }
 interface ConfigProperty {
     key: string;
@@ -30,16 +31,19 @@ type ConfigValue = {
 interface NamedPipeline {
     name: string;
     pipeline: Pipeline;
+    lineNumber?: number;
 }
 interface Variable {
     varType: string;
     name: string;
     value: string;
+    lineNumber?: number;
 }
 interface Route {
     method: string;
     path: string;
     pipeline: PipelineRef;
+    lineNumber?: number;
 }
 type PipelineRef = {
     kind: 'Inline';
@@ -51,10 +55,12 @@ type PipelineRef = {
 interface Pipeline {
     steps: PipelineStep[];
 }
+type ConfigType = 'backtick' | 'quoted' | 'identifier';
 type PipelineStep = {
     kind: 'Regular';
     name: string;
     config: string;
+    configType: ConfigType;
 } | {
     kind: 'Result';
     branches: ResultBranch[];
@@ -76,6 +82,7 @@ interface Describe {
     name: string;
     mocks: Mock[];
     tests: It[];
+    lineNumber?: number;
 }
 interface Mock {
     target: string;
@@ -138,8 +145,8 @@ declare function printDescribe(describe: Describe): string;
 declare function prettyPrint(program: Program): string;
 declare function formatConfigValue(value: ConfigValue): string;
 declare function formatPipelineStep(step: PipelineStep, indent?: string): string;
-declare function formatStepConfig(config: string): string;
+declare function formatStepConfig(config: string, configType: ConfigType): string;
 declare function formatPipelineRef(ref: PipelineRef): string[];
 declare function formatWhen(when: When): string;
 
-export { type Condition, type Config, type ConfigProperty, 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 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 };

package/dist/index.mjs

@@ -30,6 +30,9 @@ 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;
+  }
   parseProgram() {
     this.skipSpaces();
     const configs = [];
@@ -43,26 +46,31 @@ var Parser = class {
       const start = this.pos;
       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;
       }
@@ -197,11 +205,11 @@ var Parser = class {
   }
   parseStepConfig() {
     const bt = this.tryParse(() => this.parseBacktickString());
-    if (bt !== null) return bt;
+    if (bt !== null) return { config: bt, configType: "backtick" };
     const dq = this.tryParse(() => this.parseQuotedString());
-    if (dq !== null) return dq;
+    if (dq !== null) return { config: dq, configType: "quoted" };
     const id = this.tryParse(() => this.parseIdentifier());
-    if (id !== null) return id;
+    if (id !== null) return { config: id, configType: "identifier" };
     throw new ParseFailure("step-config", this.pos);
   }
   parseConfigValue() {
@@ -273,9 +281,9 @@ var Parser = class {
     const name = this.parseIdentifier();
     this.expect(":");
     this.skipInlineSpaces();
-    const config = this.parseStepConfig();
+    const { config, configType } = this.parseStepConfig();
     this.skipSpaces();
-    return { kind: "Regular", name, config };
+    return { kind: "Regular", name, config, configType };
   }
   parseResultStep() {
     this.skipSpaces();
@@ -616,28 +624,52 @@ 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 });
+  });
+  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 "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();
 }
@@ -655,7 +687,7 @@ function formatConfigValue(value) {
 }
 function formatPipelineStep(step, indent = "  ") {
   if (step.kind === "Regular") {
-    return `${indent}|> ${step.name}: ${formatStepConfig(step.config)}`;
+    return `${indent}|> ${step.name}: ${formatStepConfig(step.config, step.configType)}`;
   } else {
     const lines = [`${indent}|> result`];
     step.branches.forEach((branch) => {
@@ -668,33 +700,16 @@ function formatPipelineStep(step, indent = "  ") {
     return lines.join("\n");
   }
 }
-function formatStepConfig(config) {
-  if (config.includes("\n") || config.includes("{") || config.includes("[") || config.includes(".") || config.includes("(")) {
-    return `\`${config}\``;
-  } else if (config.includes(" ")) {
-    return `"${config}"`;
-  } else if (isAuthStringValue(config)) {
-    return `"${config}"`;
-  } else {
-    return config;
+function formatStepConfig(config, configType) {
+  switch (configType) {
+    case "backtick":
+      return `\`${config}\``;
+    case "quoted":
+      return `"${config}"`;
+    case "identifier":
+      return config;
   }
 }
-function isAuthStringValue(config) {
-  const authValues = [
-    "login",
-    "logout",
-    "register",
-    "required",
-    "optional"
-  ];
-  if (authValues.includes(config)) {
-    return true;
-  }
-  if (config.startsWith("type:")) {
-    return true;
-  }
-  return false;
-}
 function formatPipelineRef(ref) {
   if (ref.kind === "Named") {
     return [`  |> pipeline: ${ref.name}`];

package/package.json

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