`markdownlint-cli` → `markdownlint-cli2` #1934

parkerbxyz · 2022-10-05T05:41:17Z

Proposed Changes

Replace markdownlint-cli with markdownlint-cli2.

Motivation: MegaLinter doesn't currently play nice with directory-specific markdownlint configuration files. Using markdownlint-cli2 in place of markdownlint-cli will fix this.

Advantages:

Speed (allegedly)
Configuration files can live anywhere and automatically apply to their part of the directory tree
The markdownlint VS Code extension is powered by markdownlint-cli2, so everything should just work without special configuration when using the extension in conjunction with MegaLinter.
Fewer dependencies

Additional information: https://dlaa.me/blog/post/markdownlintcli2

Readiness Checklist

Author/Contributor

Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
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
Label as either automation, bug, documentation, enhancement, infrastructure, or performance

Note

Replace markdownlint-cli with markdownlint-cli2 throughout the codebase, updating Dockerfiles, descriptors, schema defaults, docs, tests, and versions; also enhance devcontainer with Docker-in-Docker support.

Linting/Markdown:
- Replace markdownlint-cli with markdownlint-cli2 across core and flavor Dockerfiles and linters/markdown_markdownlint/Dockerfile (install args and packages).
- Update megalinter markdown descriptor: set cli_executable to markdownlint-cli2, change config_file_name default to LINTER_DEFAULT, add --help/--version args, refresh examples and links.
- Adjust schema defaults (MARKDOWN_MARKDOWNLINT_CLI_EXECUTABLE, MARKDOWN_MARKDOWNLINT_CONFIG_FILE) and generated linter versions/help outputs.
- Update docs to reference markdownlint-cli2, new version, commands, and configuration guidance; add CHANGELOG note.
- Tests: skip help check for markdownlint-cli2 specific exit behavior.
Dev Environment:
- devcontainer: add Docker-in-Docker feature, Docker VS Code extension, and DOCKER_BUILDKIT=1.

^{Written by Cursor Bugbot for commit 0c9961a. This will update automatically on new commits. Configure here.}

parkerbxyz · 2022-10-22T00:34:49Z

The only markdownlint test that I see failing is this one:

megalinter/tests/test_megalinter/linters/markdown_markdownlint_test.py::markdown_markdownlint_test::test_failure FAILED [ 46%]

I haven't been able to find any logs indicating why it's failing and I haven't figured out how to run the tests locally to debug further. Any help here would be greatly appreciated. 🙂

nvuillam · 2022-10-22T01:00:46Z

Maybe you can start y what are the advatages og megalinter to use maskdownlint-cli2 instead of markdownlint ? :)

parkerbxyz · 2022-10-22T02:00:10Z

Maybe you can start y what are the advatages og megalinter to use maskdownlint-cli2 instead of markdownlint ? :)

I'm not sure I understand the question... If you're asking what the advantages of markdownlint-cli2 are over the original markdownlint CLI, I addressed that in the PR description. Let me know if there's something I should elaborate on there or if you have any other questions. 🙂

Kurt-von-Laven · 2022-10-22T03:09:40Z

The only markdownlint test that I see failing is this one:
megalinter/tests/test_megalinter/linters/markdown_markdownlint_test.py::markdown_markdownlint_test::test_failure FAILED [ 46%]
I haven't been able to find any logs indicating why it's failing and I haven't figured out how to run the tests locally to debug further. Any help here would be greatly appreciated. 🙂

I think this is very valid feedback. I am inclined to give our CI pipeline some love if @nvuillam agrees. I am open to suggestions on where to begin. Otherwise, I will just try to keep the PRs small in order to solicit feedback.

nvuillam · 2022-10-23T08:00:01Z

There are errors in bad testing files
They are not detected by markdownlint-cli2, that's why CI job fails

parkerbxyz · 2022-10-23T19:33:29Z

It looks like the test is adding markdownlint-cli2 as an argument to the command, like so:

markdownlint-cli2 markdownlint-cli2 /tmp/lint/.automation/test/markdown/markdown_bad_1.md /tmp/lint/.automation/test/markdown/markdown_bad_2.md

This appears to be because of how the container works. More on that here. If we want to use the container, we'll need to use the --entrypoint flag to indicate which command to run without adding it twice.

I'm going to see if the build success without the container and go from there.

nvuillam · 2022-10-23T19:41:30Z

I think using npm package could be ok :) (all npm packages are joined in a single install command so it won't impact badly the build time)

parkerbxyz · 2022-10-24T04:52:58Z

megalinter/tests/test_megalinter/helpers/utilstest.py:604: in assert_file_has_been_updated
    test_self.assertTrue(updated, f"{file_name} has been updated")
E   AssertionError: False is not true : markdown_for_fixes_1.md has been updated

If I run the following command locally on this branch, 17 files, including markdown_for_fixes_1.md get updated/fixed:

npx mega-linter-runner --path .automation/test/sample_project_fixes/ --fix

Any ideas why it might behave differently in the test?

This reverts commit b2dee17.

This reverts commit 58c4863.

echoix · 2025-07-07T20:55:26Z

We're planning and have already some work merged for v9, a major version. @nvuillam what is your opinion on what we accept as changes to users?

echoix · 2025-07-07T20:55:42Z

This PR has been open for way too long

nvuillam · 2025-07-07T21:40:27Z

@echoix v9 is the next version (no ETA yet as we need to implement the custom flavors), so we can add breaking changes as long as we document them :)

github-actions · 2025-08-07T01:23:14Z

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 · 2025-09-22T01:13:56Z

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.

cursor · 2025-09-27T21:19:57Z

.devcontainer/devcontainer.json

+      "version": "latest",
+      "enableNonRootDocker": "true",
+      "moby": "true"
+    }


Bug: Unintended Docker Configurations in PR

This PR includes devcontainer configuration for Docker-in-Docker and Buildkit. These changes appear to be accidental commits, unrelated to the markdownlint migration that is the focus of this PR.

Additional Locations (1)

.devcontainer/devcontainer.json#L49-L52

github-actions · 2025-10-29T01:15:09Z

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.

parkerbxyz · 2025-11-15T22:53:50Z

Should I continue keeping this PR up-to-date by resolving conflicts as they arise?

parkerbxyz marked this pull request as ready for review October 22, 2022 00:31

parkerbxyz requested a review from nvuillam as a code owner October 22, 2022 00:31

parkerbxyz mentioned this pull request Oct 22, 2022

Remove trailing space from build script #1987

Merged

4 tasks

parkerbxyz added 19 commits October 24, 2022 13:54

markdownlint-cli → markdownlint-cli2

240ca29

Update CLI arguments

a1f1959

Add cli_executable for markdownlint

ddc5cdb

Update markdownlint CLI examples

a3b1a53

Add markdownlint CLI docker configuration

c25c393

Revert "Add markdownlint CLI docker configuration"

d2bf2e0

This reverts commit b2dee17.

Add davidanson to CSpell config

b373238

Update config_file_name to LINTER_DEFAULT

f38a730

Replace CLI args with executables

1bcca1b

Add cli_executable_fix to schema

56f1abe

Fix order of properties

1f75e5f

Fix cli_executable_version value

bfa5f48

Set markdownlint CLI args to empty strings

09a6240

Revert whitespaces changes made by editor

9b42e07

Split cli_executable_help

c1a6fcf

Revert "Split cli_executable_help"

4f2a380

This reverts commit 58c4863.

Update megalinter-configuration.jsonschema.json

5a73252

Remove cli_executable_help from markdownlint

3a4f7fc

Try using tail in cli_help_arg_name

d30cbd0

fix: update markdownlint version to 0.18.1 and regenerate documentation

47ea64f

parkerbxyz had a problem deploying to dev July 7, 2025 20:49 — with GitHub Actions Error

Merge branch 'main' into main

9b4dcf4

parkerbxyz temporarily deployed to dev July 7, 2025 20:52 — with GitHub Actions Inactive

github-actions bot removed the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Jul 8, 2025

github-actions bot added the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Aug 7, 2025

github-actions bot closed this Aug 22, 2025

echoix reopened this Aug 22, 2025

github-actions bot removed the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Aug 23, 2025

github-actions bot added the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Sep 22, 2025

Merge remote-tracking branch 'upstream/main'

5e3c4cf

parkerbxyz had a problem deploying to dev September 27, 2025 21:13 — with GitHub Actions Error

This comment was marked as outdated.

Sign in to view

Update Kubescape version to 3.0.41

0c9961a

parkerbxyz temporarily deployed to dev September 27, 2025 21:17 — with GitHub Actions Inactive

cursor bot reviewed Sep 27, 2025

View reviewed changes

github-actions bot removed the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Sep 28, 2025

github-actions bot added the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Oct 29, 2025

github-actions bot closed this Nov 12, 2025

Uh oh!

markdownlint-cli → markdownlint-cli2 #1934

markdownlint-cli → markdownlint-cli2 #1934

Uh oh!

Conversation

parkerbxyz commented Oct 5, 2022 • edited by cursor bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Readiness Checklist

Author/Contributor

Reviewing Maintainer

Uh oh!

parkerbxyz commented Oct 22, 2022

Uh oh!

nvuillam commented Oct 22, 2022

Uh oh!

parkerbxyz commented Oct 22, 2022

Uh oh!

Kurt-von-Laven commented Oct 22, 2022

Uh oh!

nvuillam commented Oct 23, 2022

Uh oh!

parkerbxyz commented Oct 23, 2022

Uh oh!

nvuillam commented Oct 23, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

parkerbxyz commented Oct 24, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

echoix commented Jul 7, 2025

Uh oh!

echoix commented Jul 7, 2025

Uh oh!

nvuillam commented Jul 7, 2025

Uh oh!

github-actions bot commented Aug 7, 2025

Uh oh!

github-actions bot commented Sep 22, 2025

Uh oh!

This comment was marked as outdated.

Uh oh!

cursor bot Sep 27, 2025

Choose a reason for hiding this comment

Bug: Unintended Docker Configurations in PR

Uh oh!

github-actions bot commented Oct 29, 2025

Uh oh!

parkerbxyz commented Nov 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

`markdownlint-cli` → `markdownlint-cli2` #1934

`markdownlint-cli` → `markdownlint-cli2` #1934

parkerbxyz commented Oct 5, 2022 •

edited by cursor bot

Loading

nvuillam commented Oct 23, 2022 •

edited

Loading

parkerbxyz commented Oct 24, 2022 •

edited

Loading

parkerbxyz commented Nov 15, 2025 •

edited

Loading