{"id":17720407,"url":"https://github.com/rcjsuen/dockerfile-utils","last_synced_at":"2025-12-25T21:57:27.291Z","repository":{"id":52981710,"uuid":"115082254","full_name":"rcjsuen/dockerfile-utils","owner":"rcjsuen","description":"A library and command line interface for formatting and linting Dockerfiles.","archived":false,"fork":false,"pushed_at":"2024-03-26T00:58:57.000Z","size":1058,"stargazers_count":24,"open_issues_count":11,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-05-02T06:13:26.770Z","etag":null,"topics":["docker","dockerfile","dockerfile-utilities","dockerfiles","formatter","formatting","lint","linter","linting","moby","validation","validator"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rcjsuen.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"License.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"rcjsuen"}},"created_at":"2017-12-22T06:01:57.000Z","updated_at":"2024-06-18T17:03:14.710Z","dependencies_parsed_at":"2024-03-25T23:26:28.732Z","dependency_job_id":"aaaea800-f96c-42ca-9877-4a2fedd61c21","html_url":"https://github.com/rcjsuen/dockerfile-utils","commit_stats":{"total_commits":231,"total_committers":3,"mean_commits":77.0,"dds":"0.025974025974025983","last_synced_commit":"b5166d821a9fac52b3029af670d4b2f18bb370bf"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcjsuen%2Fdockerfile-utils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcjsuen%2Fdockerfile-utils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcjsuen%2Fdockerfile-utils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rcjsuen%2Fdockerfile-utils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rcjsuen","download_url":"https://codeload.github.com/rcjsuen/dockerfile-utils/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243526463,"owners_count":20305108,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","dockerfile","dockerfile-utilities","dockerfiles","formatter","formatting","lint","linter","linting","moby","validation","validator"],"created_at":"2024-10-25T15:26:49.147Z","updated_at":"2025-12-25T21:57:27.234Z","avatar_url":"https://github.com/rcjsuen.png","language":"TypeScript","readme":"# Dockerfile Utilities\n\n![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-utils/badge.svg?branch=master)](https://coveralls.io/github/rcjsuen/dockerfile-utils?branch=master) [![Build Dependencies](https://david-dm.org/rcjsuen/dockerfile-utils.svg)](https://david-dm.org/rcjsuen/dockerfile-utils) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nThis is a collection of utilities for working with Dockerfiles powered by Node.js written in TypeScript.\nTo [install and run](#installation-instructions) these utilities, you will need to have [Node.js](https://nodejs.org/en/download/) or [Docker](https://www.docker.com/get-docker) installed on your computer.\n\nSupported features:\n- formatting\n- linting\n\n## Development Instructions\n\nIf 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.\nAfter 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:\n\n```\nnpm install\nnpm run build\nnpm test\n```\n\nIf you are planning to change the code, use `npm run watch` to get the TypeScript files transpiled on-the-fly as they are modified.\n\n## Installation Instructions\n\nTo add this library as a dependency to your project, please add `dockerfile-utils` as a dependency in your project's package.json file.\n\n## Running the CLI with Node.js\n\nTo install and use the `dockerfile-utils` command line interface, please install the [dockerfile-utils npm module](https://www.npmjs.com/package/dockerfile-utils).\nThe `-g` flag will install the NPM module globally onto your computer.\n\n```\nnpm install -g dockerfile-utils\n```\n\nAfter the installation has completed, you can run the CLI using the `dockerfile-utils` binary.\n\n```\n\u003e dockerfile-utils --help\nUsage: dockerfile-utils \u003ccommand\u003e [\u003cargs\u003e]\n\nOptions:\n\n  -h, --help                Output usage information\n  -v, --version             Output version information\n\nCommands:\n\n  format                    Format a Dockerfile\n  lint                      Validate a Dockerfile\n```\n\n## Running the CLI with Docker\n\nYou can use `docker run` to launch the command line interface with Docker.\nThis removes the requirement of needing to have Node.js installed locally on your computer.\nThe `dockerfile-utils` binary is available as a Docker image under the name `rcjsuen/dockerfile-utils`.\n\n```\n\u003e docker run rcjsuen/dockerfile-utils --help\nUsage: dockerfile-utils \u003ccommand\u003e [\u003cargs\u003e]\n\nOptions:\n\n  -h, --help                Output usage information\n  -v, --version             Output version information\n\nCommands:\n\n  format                    Format a Dockerfile\n  lint                      Validate a Dockerfile\n```\n\nTo format or lint a Dockerfile in the current working directory, please use the following commands.\n```\n\u003e docker run -v `pwd`/Dockerfile:/Dockerfile rcjsuen/dockerfile-utils format /Dockerfile\n```\n```\n\u003e docker run -v `pwd`/Dockerfile:/Dockerfile rcjsuen/dockerfile-utils lint /Dockerfile\n```\n","funding_links":["https://github.com/sponsors/rcjsuen"],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frcjsuen%2Fdockerfile-utils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frcjsuen%2Fdockerfile-utils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frcjsuen%2Fdockerfile-utils/lists"}