https://github.com/rcjsuen/dockerfile-ast

An npm module for parsing Dockerfiles powered by TypeScript.
https://github.com/rcjsuen/dockerfile-ast

ast docker dockerfile dockerfiles moby parse parser

Last synced: about 1 month ago
JSON representation

An npm module for parsing Dockerfiles powered by TypeScript.

• Host: GitHub
• URL: https://github.com/rcjsuen/dockerfile-ast
• Owner: rcjsuen
• License: mit
• Created: 2017-12-16T23:09:26.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-11-09T21:08:20.000Z (2 months ago)
• Last Synced: 2024-11-09T22:18:56.794Z (2 months ago)
• Topics: ast, docker, dockerfile, dockerfiles, moby, parse, parser
• Language: TypeScript
• Homepage:
• Size: 627 KB
• Stars: 41
• Watchers: 3
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: License.txt

Awesome Lists containing this project

README

        
# Dockerfile AST

![Node.js Builds](https://github.com/rcjsuen/dockerfile-ast/workflows/Node.js%20Builds/badge.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/github/rcjsuen/dockerfile-ast/badge.svg?branch=master)](https://coveralls.io/github/rcjsuen/dockerfile-ast?branch=master) [![Build Dependencies](https://david-dm.org/rcjsuen/dockerfile-ast.svg)](https://david-dm.org/rcjsuen/dockerfile-ast) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) [![npm downloads per week](https://img.shields.io/npm/dw/dockerfile-ast.svg)](https://www.npmjs.com/package/dockerfile-ast)

The `dockerfile-ast` NPM module is a Dockerfile parser written in TypeScript.

The module provides full programmatic access to a parsed Dockerfile.

Supported features:

- escaped newline detection

  - `escape` parser directive considered when parsing

- comments preserved

  - inlined comments in multiline instructions preserved

- continuous empty newlines honoured (albeit discouraged as of Docker CE 17.09)

- `ARG` and `ENV` variable lookup and resolution

Unsupported:

- `\r` as a a line delimiter

  - only `\r\n` and `\n` are supported as being line delimiters

  - if a `\r` is detected the parser assumes that it is followed by a `\n`

## Development Instructions

If you wish to build and compile this project, you must first install [Node.js](https://nodejs.org/en/download/) if you have not already done so.

After you have installed Node.js and cloned the repository with Git, you may now proceed to build and compile the project with the following commands:

```

npm install

npm run build

npm test

```

If you are planning to change the code, use `npm run watch` to get the

TypeScript files transpiled on-the-fly as they are modified.

## Installation Instructions

To add this library as a dependency to your project, please add `dockerfile-ast` as a dependency in your package.json file.

## Using this Module

```TypeScript

import { DockerfileParser } from 'dockerfile-ast';

const content =

`FROM alpine

ExposE 8080`

let dockerfile = DockerfileParser.parse(content);

let instructions = dockerfile.getInstructions();

for (let instruction of instructions) {

  // FROM

  // EXPOSE

  console.log(instruction.getKeyword());

  // FROM

  // ExposE

  console.log(instruction.getInstruction());

}

```