@alchemy.run/docker 2.0.0-beta.84 → 2.0.0-beta.86

package/lib/DockerfileParser.d.ts

@@ -0,0 +1,125 @@
+import * as Effect from "effect/Effect";
+declare const DockerfileSyntaxError_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "DockerfileSyntaxError";
+} & Readonly<A>;
+/**
+ * A Dockerfile parsed into stages and instructions, with the line each one
+ * starts on. Builders that are not Docker (E2B, Modal, Daytona) lower this
+ * structure into their own build steps instead of running `docker build`.
+ *
+ * The parser is a port of BuildKit's (`frontend/dockerfile/parser` and the
+ * checks in `instructions`), and is tested against it: parser directives,
+ * line continuations, heredocs, exec and shell forms, `--flag[=value]`
+ * options, Docker's quoting, and the files BuildKit rejects. It does not
+ * expand variables: lowering decides whether a builder expands them or
+ * Alchemy does.
+ */
+/** The Dockerfile could not be parsed. */
+export declare class DockerfileSyntaxError extends DockerfileSyntaxError_base<{
+    readonly message: string;
+    /** 1-based line the error was found on. */
+    readonly line: number;
+}> {
+}
+/** A `--name` or `--name=value` option on an instruction. */
+export interface Flag {
+    readonly name: string;
+    readonly value: string | undefined;
+}
+/** A heredoc attached to an instruction (`RUN <<EOF … EOF`). */
+export interface Heredoc {
+    /** The delimiter word, e.g. `EOF`. */
+    readonly name: string;
+    /** The body, without the closing delimiter line. */
+    readonly content: string;
+    /** `<<-`: leading tabs were stripped from the body. */
+    readonly stripTabs: boolean;
+    /** A quoted delimiter (`<<"EOF"`): the body is not expanded. */
+    readonly quoted: boolean;
+}
+/** The exec form (`["bun", "index.mjs"]`) or the shell form (`bun index.mjs`). */
+export type Command = {
+    readonly form: "exec";
+    readonly argv: ReadonlyArray<string>;
+} | {
+    readonly form: "shell";
+    readonly script: string;
+};
+interface InstructionBase {
+    /** 1-based line the instruction starts on. */
+    readonly line: number;
+    /** The instruction as written: the joined logical line, plus heredoc bodies. */
+    readonly raw: string;
+    readonly flags: ReadonlyArray<Flag>;
+}
+export interface RunInstruction extends InstructionBase {
+    readonly _tag: "RUN";
+    readonly command: Command;
+    readonly heredocs: ReadonlyArray<Heredoc>;
+}
+export interface CopyInstruction extends InstructionBase {
+    readonly _tag: "COPY" | "ADD";
+    /** Context-relative sources, URLs (ADD), or `<<NAME` heredoc references. */
+    readonly sources: ReadonlyArray<string>;
+    readonly destination: string;
+    readonly heredocs: ReadonlyArray<Heredoc>;
+}
+export interface EnvInstruction extends InstructionBase {
+    readonly _tag: "ENV";
+    readonly vars: ReadonlyArray<readonly [name: string, value: string]>;
+}
+export interface ArgInstruction extends InstructionBase {
+    readonly _tag: "ARG";
+    readonly vars: ReadonlyArray<readonly [name: string, defaultValue: string | undefined]>;
+}
+export interface ValueInstruction extends InstructionBase {
+    readonly _tag: "WORKDIR" | "USER" | "STOPSIGNAL";
+    readonly value: string;
+}
+export interface CommandInstruction extends InstructionBase {
+    readonly _tag: "CMD" | "ENTRYPOINT" | "SHELL";
+    readonly command: Command;
+}
+export interface OtherInstruction extends InstructionBase {
+    readonly _tag: "EXPOSE" | "LABEL" | "HEALTHCHECK" | "VOLUME" | "ONBUILD" | "MAINTAINER";
+    /** Everything after the instruction name and its flags. */
+    readonly args: string;
+}
+export type Instruction = RunInstruction | CopyInstruction | EnvInstruction | ArgInstruction | ValueInstruction | CommandInstruction | OtherInstruction;
+export type InstructionName = Instruction["_tag"] | "FROM";
+/** One `FROM` and the instructions after it. */
+export interface Stage {
+    /** 1-based line of the `FROM`. */
+    readonly line: number;
+    /** The `FROM` line as written. */
+    readonly raw: string;
+    /** The base: an image reference, an earlier stage's name, or `scratch`. */
+    readonly image: string;
+    /** `FROM … AS name`. */
+    readonly name: string | undefined;
+    readonly flags: ReadonlyArray<Flag>;
+    readonly instructions: ReadonlyArray<Instruction>;
+}
+export interface ParsedDockerfile {
+    /** Parser directives, e.g. `{ syntax: "docker/dockerfile:1", escape: "\\" }`. */
+    readonly directives: Readonly<Record<string, string>>;
+    /** `ARG`s declared before the first `FROM`. */
+    readonly globalArgs: ReadonlyArray<ArgInstruction>;
+    readonly stages: ReadonlyArray<Stage>;
+}
+/**
+ * Parse Dockerfile text into stages and instructions, as BuildKit reads it:
+ * the same directives, continuations, heredocs, word splitting and quoting,
+ * and the same files rejected. Values have their quotes and escapes
+ * resolved; variables are left as written for the builder to expand.
+ */
+export declare const parse: (text: string) => Effect.Effect<ParsedDockerfile, DockerfileSyntaxError>;
+/**
+ * Render a parsed Dockerfile back to text, one instruction per entry, each
+ * exactly as written (continuations and heredoc bodies included).
+ */
+export declare const renderLines: (dockerfile: ParsedDockerfile) => string[];
+/** Render a parsed Dockerfile back to text. */
+export declare const render: (dockerfile: ParsedDockerfile) => string;
+export {};
+//# sourceMappingURL=DockerfileParser.d.ts.map

package/lib/DockerfileParser.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DockerfileParser.d.ts","sources":["../src/DockerfileParser.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;;;;AAIxC;;;;;;;;;;;GAWG;AAEH,0CAA0C;AAC1C,qBAAa,qBAAsB,SAAQ,2BAA0C;IACnF,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB,CAAC;CAAG;AAEL,6DAA6D;AAC7D,MAAM,WAAW,IAAI;IACnB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,SAAS,CAAC;CACpC;AAED,gEAAgE;AAChE,MAAM,WAAW,OAAO;IACtB,sCAAsC;IACtC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,oDAAoD;IACpD,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,uDAAuD;IACvD,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,gEAAgE;IAChE,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED,kFAAkF;AAClF,MAAM,MAAM,OAAO,GACf;IAAE,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,CAAA;CAAE,GAC/D;IAAE,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAC;AAExD,UAAU,eAAe;IACvB,8CAA8C;IAC9C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,gFAAgF;IAChF,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;CACrC;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAC1B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,eAAgB,SAAQ,eAAe;IACtD,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B,4EAA4E;IAC5E,QAAQ,CAAC,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,CAAC;IACxC,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;CAC3C;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC;CACtE;AAED,MAAM,WAAW,cAAe,SAAQ,eAAe;IACrD,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IACrB,QAAQ,CAAC,IAAI,EAAE,aAAa,CAAC,SAAS,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC,CAAC;CACzF;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,MAAM,GAAG,YAAY,CAAC;IACjD,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IACzD,QAAQ,CAAC,IAAI,EAAE,KAAK,GAAG,YAAY,GAAG,OAAO,CAAC;IAC9C,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC3B;AAED,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,QAAQ,CAAC,IAAI,EAAE,QAAQ,GAAG,OAAO,GAAG,aAAa,GAAG,QAAQ,GAAG,SAAS,GAAG,YAAY,CAAC;IACxF,2DAA2D;IAC3D,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,MAAM,WAAW,GACnB,cAAc,GACd,eAAe,GACf,cAAc,GACd,cAAc,GACd,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,CAAC;AAErB,MAAM,MAAM,eAAe,GAAG,WAAW,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC;AAE3D,gDAAgD;AAChD,MAAM,WAAW,KAAK;IACpB,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,kCAAkC;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IACrB,2EAA2E;IAC3E,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IACvB,wBAAwB;IACxB,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;IACpC,QAAQ,CAAC,YAAY,EAAE,aAAa,CAAC,WAAW,CAAC,CAAC;CACnD;AAED,MAAM,WAAW,gBAAgB;IAC/B,iFAAiF;IACjF,QAAQ,CAAC,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACtD,+CAA+C;IAC/C,QAAQ,CAAC,UAAU,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;IACnD,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,KAAK,CAAC,CAAC;CACvC;AAq9BD;;;;;GAKG;AACH,eAAO,MAAM,KAAK,SAAU,MAAM,KAAG,MAAM,CAAC,MAAM,CAAC,gBAAgB,EAAE,qBAAqB,CAuBtF,CAAC;AAEL;;;GAGG;AACH,eAAO,MAAM,WAAW,eAAgB,gBAAgB,KAAG,MAAM,EAIhE,CAAC;AAEF,+CAA+C;AAC/C,eAAO,MAAM,MAAM,eAAgB,gBAAgB,KAAG,MACX,CAAC"}