Crate parse_dockerfile

Crate parse_dockerfile 

Source
Expand description

Dockerfile parser, written in Rust.

§Usage

To use this crate as a library, add this to your Cargo.toml:

[dependencies]
parse-dockerfile = { version = "0.1", default-features = false }

ⓘ Note

We recommend disabling default features because they enable CLI-related dependencies which the library part does not use.

§Examples

use parse_dockerfile::{parse, Instruction};

let text = r#"
ARG UBUNTU_VERSION=latest

FROM ubuntu:${UBUNTU_VERSION}
RUN echo
"#;

let dockerfile = parse(text).unwrap();

// Iterate over all instructions.
let mut instructions = dockerfile.instructions.iter();
assert!(matches!(instructions.next(), Some(Instruction::Arg(..))));
assert!(matches!(instructions.next(), Some(Instruction::From(..))));
assert!(matches!(instructions.next(), Some(Instruction::Run(..))));
assert!(matches!(instructions.next(), None));

// Iterate over global args.
let mut global_args = dockerfile.global_args();
let global_arg1 = global_args.next().unwrap();
assert_eq!(global_arg1.arguments.value, "UBUNTU_VERSION=latest");
assert!(matches!(global_args.next(), None));

// Iterate over stages.
let mut stages = dockerfile.stages();
let stage1 = stages.next().unwrap();
assert_eq!(stage1.from.image.value, "ubuntu:${UBUNTU_VERSION}");
let mut stage1_instructions = stage1.instructions.iter();
assert!(matches!(stage1_instructions.next(), Some(Instruction::Run(..))));
assert!(matches!(stage1_instructions.next(), None));
assert!(matches!(stages.next(), None));

§Optional features

Structs§

AddInstruction
An ADD instruction.
ArgInstruction
An ARG instruction.
CmdInstruction
A CMD instruction.
CopyInstruction
A COPY instruction.
Dockerfile
A dockerfile.
EntrypointInstruction
An ENTRYPOINT instruction.
EnvInstruction
An ENV instruction.
Error
An error that occurred during parsing the dockerfile.
ExposeInstruction
An EXPOSE instruction.
Flag
An option flag.
FromInstruction
A FROM instruction.
HealthcheckInstruction
A HEALTHCHECK instruction.
HereDoc
A here-document.
Keyword
A keyword.
LabelInstruction
A LABEL instruction.
MaintainerInstruction
A MAINTAINER instruction (deprecated).
OnbuildInstruction
A ONBUILD instruction.
ParseIter
An iterator over instructions.
ParserDirective
A parser directive.
ParserDirectives
Parser directives.
RunInstruction
A RUN instruction.
ShellInstruction
A SHELL instruction.
Spanned
A spanned value.
Stage
A stage.
StopsignalInstruction
A STOPSIGNAL instruction.
UnescapedString
An unescaped string.
UserInstruction
A USER instruction.
VolumeInstruction
A VOLUME instruction.
WorkdirInstruction
A WORKDIR instruction.

Enums§

Command
A command.
HealthcheckArguments
Arguments of the HEALTHCHECK instruction.
Instruction
An instruction.
JsonOrStringArray
A JSON array or space-separated string.
Source
A enum that represents source value of ARG instruction and COPY instruction.

Functions§

parse
Parses dockerfile from the given text.
parse_iter
Returns an iterator over instructions in the given text.

Type Aliases§

Span