@venn-lang/cli 0.1.0

package/dist/index.d.mts

@@ -0,0 +1,98 @@
+import { HttpClient, HttpServer } from "@venn-lang/http";
+import { Console, Host } from "@venn-lang/contracts";
+import { CleanupSink, EventSink, ModuleIo, NpmModules, RunFilter, RunResult } from "@venn-lang/runtime";
+import { Problem } from "@venn-lang/core";
+//#region src/commands/run.d.ts
+/** Everything `venn run` accepts. */
+interface RunOptions {
+  file: string;
+  reporter?: string;
+  tags?: string;
+  flow?: string;
+  step?: string;
+  env?: string;
+  bail?: boolean;
+}
+/**
+ * `venn test <file|directory>`: run every matching flow, then report.
+ *
+ * @param options - The file or directory, the reporter, and the filters.
+ * @returns The exit code: whatever a flow's `exit` named, else 0 when nothing
+ * failed, else 1. Also 1 when the path holds no `.vn` file.
+ */
+declare function runCommand(options: RunOptions): Promise<number>;
+//#endregion
+//#region src/commands/verify-plugin.d.ts
+/**
+ * `venn verify-plugin <path>`: import a plugin module, print what it declares,
+ * and check its shape.
+ *
+ * @param args - `path` is the module to import, relative to the working
+ * directory or absolute.
+ * @returns 0 when the plugin names itself and a namespace, 1 when it does not.
+ * @throws Error when the module exports nothing that looks like a plugin.
+ */
+declare function verifyPluginCommand(args: {
+  path: string;
+}): Promise<number>;
+//#endregion
+//#region src/reporters/ndjson-stdout.d.ts
+/**
+ * An event sink that writes each envelope to stdout as one line of NDJSON: the
+ * stream a script or a CI job parses.
+ */
+declare function createStdoutSink(): EventSink;
+//#endregion
+//#region src/reporters/problem-reporter.d.ts
+/**
+ * Print compile-time problems to stderr, one code and title per problem with
+ * its source location beneath. The terminal surface of the §16 model.
+ */
+declare function reportProblems(problems: readonly Problem[]): void;
+//#endregion
+//#region src/run/run-file.d.ts
+/** What one `.vn` file amounted to. */
+interface RunFileOutcome {
+  /** Everything refused or reported. Empty when the file ran clean. */
+  problems: Problem[];
+  /** Absent when nothing ran: the parse or the imports stopped it first. */
+  result?: RunResult;
+}
+/** The source to run, the implementations behind its ports, and how to run it. */
+interface RunFileArgs {
+  source: string;
+  uri: string;
+  host: Host;
+  sink: EventSink;
+  httpClient: HttpClient;
+  /** Injected when the caller needs to close the servers itself, as `venn run` does. */
+  httpServer?: HttpServer;
+  console?: Console;
+  filter?: RunFilter;
+  bail?: boolean;
+  env?: Record<string, unknown>;
+  io?: ModuleIo;
+  /** How an installed package is loaded, when the host can load one. */
+  npm?: NpmModules;
+  /** Where the program registers what it opened, so the host can close it. */
+  cleanup?: CleanupSink;
+  /** "test" runs the flows; "script" executes the file top to bottom. */
+  mode?: "test" | "script";
+}
+/**
+ * Parse and run a `.vn` source with the full stdlib loaded.
+ *
+ * The HttpClient, HttpServer and Console ports take injected implementations
+ * (real in the CLI, fakes in tests); every other port takes the binding
+ * `@venn-lang/stdlib` supplies.
+ *
+ * @param args - The source and its uri, the host and the ports, and how to run
+ * it: the filter, the mode, the environment, the module and package loaders.
+ * @returns The problems and, when anything ran, the run's result. A failing
+ * flow is a `Problem` here, not an exception.
+ * @throws Whatever an action or a loaded module let escape the runner.
+ */
+declare function runFile(args: RunFileArgs): Promise<RunFileOutcome>;
+//#endregion
+export { type RunFileOutcome, createStdoutSink, reportProblems, runCommand, runFile, verifyPluginCommand };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/commands/run.ts","../src/commands/verify-plugin.ts","../src/reporters/ndjson-stdout.ts","../src/reporters/problem-reporter.ts","../src/run/run-file.ts"],"mappings":";;;;;;UAiBiB;EACf;EACA;EACA;EACA;EACA;EACA;EACA;;;;;;;;;iBAkBoB,WAAW,SAAS,aAAa;;;;;;;;;;;;iBC7BjC,oBAAoB;EAAQ;IAAiB;;;;;;;iBCPnD,oBAAoB;;;;;;;iBCApB,eAAe,mBAAmB;;;;UCYjC;;EAEf,UAAU;;EAEV,SAAS;;;UAIM;EACf;EACA;EACA,MAAM;EACN,MAAM;EACN,YAAY;;EAEZ,aAAa;EACb,UAAU;EACV,SAAS;EACT;EACA,MAAM;EACN,KAAK;;EAEL,MAAM;;EAEN,UAAU;;EAEV;;;;;;;;;;;;;;;iBAgBoB,QAAQ,MAAM,cAAc,QAAQ"}