Doc: run linter on markdown code blocks #702

Activity

1. intojhanurag commented on Oct 5, 2025

   

   intojhanurag

   on Oct 5, 2025

   Last edited by intojhanurag

   Contributor

   More actions

   Hey @samber
   Can I work on one of the tasks mentioned above (like adding the GitHub Action or config file)?
   Just wanted to confirm if this issue is open for normal contributors or if it’s planned to be handled internally.
2. samber commented on Oct 5, 2025

   

   samber

   on Oct 5, 2025

   OwnerAuthor

   More actions

   This is open to contributors, but some improvements have to be made to mdsf before doing my checklist.

   💯💯💯
3. intojhanurag commented on Oct 5, 2025

   

   intojhanurag

   on Oct 5, 2025

   Contributor

   More actions

   Got it, thanks for clarifying! I’ll keep an eye on the mdsf updates and jump in once those improvements are ready.
4. ccoVeille commented on Nov 12, 2025

   

   ccoVeille

   on Nov 12, 2025

   Contributor

   More actions

   The following PR brought most of what wascreporree as missing in this issue

   • feat: add experimental support for custom tools hougesen/mdsf#1400

   🎉React with 🎉1Reacted by Samuel Berthe
5. samber commented on Nov 12, 2025

   

   samber

   on Nov 12, 2025

   OwnerAuthor

   More actions

   Wonderful ✌️

   @hougesen suggested the following config

   {
     "languages": {
       "go": {
         "binary": "/mylinter",
         "arguments": ["run", "--config", ".mylinter.yaml", "$PATH"]
       }
     }
   }
6. AhmedCharfeddine commented on May 8, 2026

   

   AhmedCharfeddine

   on May 8, 2026

   More actions

   Hello, I wanted to work on this issue since it's been sitting for a while. I'm not sure how linting for code blocks should work. The steps I did were:

   1. Add the mdsf config file, as per @samber's comment. Also specified golangci-lint as the binary while referencing its config file in the repo root
   2. Running the commented mdsf command in the makefile: mdsf verify --debug --log-level warn docs/
      This prints out a lot of false positives since the linter requires a full compilable go program, which the markdown snippets aren't. Example:

   ../../.cache/mdsf/mdsfM8uXDtnoR0b0.go:2:1: expected declaration, found count (typecheck)
   count, dur, err := lo.AttemptWhileWithDelay(
   ^
   1 issues:
   * typecheck: 1
   docs/data/core-attemptwhilewithdelay.md:21 to :29 error running golangci-lint
   

   Am I missing something or is linting for snippets unfeasible?

   Side note

   The make tools command installs an old version of golangci-lint (1.xx) despite referencing @ latest. This conflicts with the linter config file in this repo, which requires version 2. I fixed this for me by specifying some 2.x version as per their docs. Should we align the makefile with this small adjustment?