mega-linter-plugin-dclint

This is a MegaLinter plugin for docker-compose-lint (dclint)

Introduction

MegaLinter by OxSecurity is a linter tool that supports various programming languages and file formats. This repository contains a MegaLinter plugin for docker-compose-lint by zavoloklom.

The docker-compose-linter (dclint) tool is a linter for Docker Compose files. It checks for common errors and best practices in Docker Compose files.

Usage

To use this plugin, you need to have MegaLinter installed. Please refer to the MegaLinter documentation for installation instructions.

MegaLinter Configuration

To use this plugin, add the following to your MegaLinter configuration:

PLUGINS:
  - "https://raw.githubusercontent.com/wesley-dean/mega-linter-plugin-dclint/refs/heads/main/mega-linter-plugin-dclint/dclint.megalinter-descriptor.yml

Simply adding the plugin to the PLUGINS section will cause MegaLiner to read the descriptor and make it available for use. However, depending on your MegaLinter configuration, you may need to enable the linter in the ENABLE_LINTERS section as well. For example:

ENABLE_LINTERS:
  - "DOCKERFILE_DCLINT"

Docker-Compose-Lint Configuration

To configure docker-compose-lint, you can create a .dclintrc file in the root of your repository. For more information on configuring, refer to the docker-compose-lint documentation

Passing Options to dclint

If you want to pass command line arguments along to the docker-compose linter, pass a string with the arguments using the DOCKERFILE_DCLINT_ARGUMENTS variable.

# append `--fix` to the end of the `dclint` command
DOCKERFILE_DCLINT_ARGUMENTS: "--fix"