megalinter icon indicating copy to clipboard operation
megalinter copied to clipboard

Correct spelling of `containername` argument.

Open Kurt-von-Laven opened this issue 2 years ago β€’ 8 comments

Fixes #1570.

Proposed Changes

  1. Spell the new mega-linter-runner argument container-name for consistency with the package name, mega-linter-runner, and to spare users from needing to add containername as a CSpell exception.
  2. Remove the CSpell exception for containername to prove that no references were missed and as a regression test.
  3. Make minor formatting improvements to runner.js for consistency with #1563 based on my code review feedback on #1561.

Readiness Checklist

Author/Contributor

  • [x] If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • [ ] Label as breaking if this is a large fundamental change
  • [x] Label as either automation, bug, documentation, enhancement, infrastructure, or performance

Kurt-von-Laven avatar Jun 28 '22 06:06 Kurt-von-Laven

πŸ¦™ MegaLinter status: :warning: WARNING

Descriptor Linter Files Fixed Errors Elapsed time
βœ… BASH bash-exec 7 0 0.04s
βœ… BASH shellcheck 7 0 0.3s
βœ… BASH shfmt 7 0 0 0.28s
βœ… COPYPASTE jscpd yes no 2.47s
βœ… DOCKERFILE hadolint 105 0 8.05s
βœ… JSON eslint-plugin-jsonc 21 0 0 2.4s
βœ… JSON jsonlint 19 0 0.25s
βœ… JSON v8r 21 0 18.26s
:warning: MARKDOWN markdownlint 294 0 5 6.53s
βœ… MARKDOWN markdown-link-check 294 0 6.43s
βœ… MARKDOWN markdown-table-formatter 294 0 0 8.03s
βœ… OPENAPI spectral 1 0 0.91s
:warning: PYTHON bandit 170 55 2.87s
βœ… PYTHON black 170 0 0 5.28s
βœ… PYTHON flake8 170 0 2.41s
βœ… PYTHON isort 170 0 0 0.69s
βœ… PYTHON mypy 170 0 7.8s
βœ… PYTHON pylint 170 0 13.22s
:warning: PYTHON pyright 170 274 18.94s
βœ… REPOSITORY checkov yes no 32.61s
βœ… REPOSITORY git_diff yes no 0.26s
βœ… REPOSITORY secretlint yes no 10.58s
βœ… REPOSITORY trivy yes no 24.29s
βœ… SPELL cspell 706 0 21.28s
βœ… SPELL misspell 533 0 0 0.85s
βœ… XML xmllint 3 0 0.0s
βœ… YAML prettier 80 0 0 3.22s
βœ… YAML v8r 22 0 42.24s
βœ… YAML yamllint 81 0 1.43s

See errors details in artifact MegaLinter reports on CI Job page

MegaLinter is graciously provided by OX Security

nvuillam avatar Jun 28 '22 06:06 nvuillam

πŸ¦™ MegaLinter status: :warning: WARNING

Descriptor Linter Files Fixed Errors Elapsed time
βœ… BASH bash-exec 7 0 0.04s
βœ… BASH shellcheck 7 0 0.27s
βœ… BASH shfmt 7 0 0 0.03s
βœ… COPYPASTE jscpd yes no 1.96s
βœ… DOCKERFILE hadolint 105 0 8.42s
βœ… JSON eslint-plugin-jsonc 21 0 0 1.81s
βœ… JSON jsonlint 19 0 0.26s
βœ… JSON v8r 21 0 15.77s
:warning: MARKDOWN markdownlint 294 2 5 4.95s
βœ… MARKDOWN markdown-link-check 294 0 4.96s
βœ… MARKDOWN markdown-table-formatter 294 2 0 5.38s
βœ… OPENAPI spectral 1 0 0.73s
:warning: PYTHON bandit 170 55 2.45s
βœ… PYTHON black 170 0 0 3.58s
βœ… PYTHON flake8 170 0 2.18s
βœ… PYTHON isort 170 0 0 0.4s
βœ… PYTHON mypy 170 0 6.98s
βœ… PYTHON pylint 170 0 10.73s
:warning: PYTHON pyright 170 272 16.28s
βœ… REPOSITORY checkov yes no 25.96s
:warning: REPOSITORY devskim yes 59 1.15s
βœ… REPOSITORY dustilock yes no 2.36s
βœ… REPOSITORY git_diff yes no 0.04s
βœ… REPOSITORY secretlint yes no 3.35s
βœ… REPOSITORY syft yes no 2.0s
βœ… REPOSITORY trivy yes no 17.43s
βœ… SPELL cspell 706 0 16.04s
βœ… SPELL misspell 533 2 0 0.41s
βœ… XML xmllint 3 0 0.0s
βœ… YAML prettier 80 0 0 2.57s
βœ… YAML v8r 22 0 34.94s
βœ… YAML yamllint 81 0 1.33s

See errors details in artifact MegaLinter reports on CI Job page

You could have the same capabilities but better runtime performances if you use a MegaLinter flavor:

MegaLinter is graciously provided by OX Security

nvuillam avatar Jun 28 '22 07:06 nvuillam

@Kurt-von-Laven this would be a breaking change for people using containername argument :/

nvuillam avatar Jul 14 '22 10:07 nvuillam

Is it worth doing in v7? I think the current unconventional spelling may cause some frustration for users who aren't yet using it. I understandably got push back from the CSpell maintainer when I proposed adding containername to the software-terms dictionary since he couldn't find much evidence of other projects that use this spelling.

Kurt-von-Laven avatar Jul 15 '22 01:07 Kurt-von-Laven

Let's have a stable v6 before thinking about v7 haha ^^ But we can write that somwhere for someday ^^

nvuillam avatar Jul 15 '22 08:07 nvuillam

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

If you think this pull request should stay open, please remove the O: stale πŸ€– label or comment on the pull request.

github-actions[bot] avatar Aug 15 '22 01:08 github-actions[bot]

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed in 14 days if no further activity occurs. Thank you for your contributions.

If you think this pull request should stay open, please remove the O: stale πŸ€– label or comment on the pull request.

github-actions[bot] avatar Sep 20 '22 01:09 github-actions[bot]

Codecov Report

Merging #1571 (8c2c728) into main (1708e04) will increase coverage by 0.02%. The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1571      +/-   ##
==========================================
+ Coverage   82.68%   82.71%   +0.02%     
==========================================
  Files         157      157              
  Lines        3384     3384              
==========================================
+ Hits         2798     2799       +1     
+ Misses        586      585       -1     
Impacted Files Coverage Ξ”
megalinter/reporters/UpdatedSourcesReporter.py 89.74% <0.00%> (+2.56%) :arrow_up:

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

codecov-commenter avatar Sep 21 '22 22:09 codecov-commenter