Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature request to add dclint (lints docker-compose.yml files) #4381

Open
wesley-dean-flexion opened this issue Dec 11, 2024 · 2 comments
Open
Labels
enhancement New feature or request

Comments

@wesley-dean-flexion
Copy link
Contributor

Is your feature request related to a problem? Please describe.

No, not a problem. I just found a tool last night that lints Docker compose files and it looks pretty nifty. Cheers, @zavoloklom!

https://github.com/zavoloklom/docker-compose-linter

Describe the solution you'd like

Please add dclint to the DOCKER descriptor

Describe alternatives you've considered

I briefly considered not requesting we add this new linter before opting to share it with the group and let others provide their thoughts.

Additional context

The tool a Node package that can be installed with npm install dclint so I'm hoping we can do something like:

- linter_name: "dclint"
  is_formatter: true
  linter_repo: "https://github.com/zavoloklom/docker-compose-linter"
  config_file_name: ".dclintrc"
  cli_lint_mode: "list_of_files"
  cli_lint_fix_args_name: "--fix"
  cli_config_arg_name: "--config"

  examples:
    - "dclint --config .dclintrc ."
    - "dclint path/to/docker-compose.yml"

  install:
    npm:
      - dclint

(it would need a few more configuration directives for the linter_rules.* stuff, the icon, etc.)

What do you all think?

@nvuillam
Copy link
Member

@wesley-dean-flexion @zavoloklom > dclint looks really interesting :)

As the project is quite new, I prefer to wait for wide user adoption before adding it ^^

Meanwhile, you can create a MegaLinter plugin to start using it today , i'll be glad to add the link in documentation :)

https://megalinter.io/latest/plugins/

@wesley-dean-flexion
Copy link
Contributor Author

@nvuillam Understood. I've been working through something with the author, @zavoloklom , and he's been extremely responsive, patient, and open to feedback. I only see great things coming from that project!

Thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants