How to make remark-cli exit with non-zero code if it applies any change to the provided files?

[assyrus-favolo]

I'd like to make a pre-commit hook that blocks committing if the markdown files don't fit in with how remark will format them, but I don't want to automatically apply the corrections, I want it to exit with, say, 1 so that the hook makes the commit fail and the user has to intervene manually to fix their mistake (like by manually re-running remark and explicitly making it format the files in-place).
Right now if any change is made by remark, I don't see any error nor warning reported

[remcohaszing]

You can use the unified-consistency plugin.

[assyrus-favolo]

Thank you! I'll check it out and see how it goes

[assyrus-favolo]

Works perfectly, thanks again!

Btw, this is the lefthook job configuration I ended up with:

  - name: Markdown
    run: npm exec remark -- --no-color --frail --quiet --no-stdout README.md

[ChristianMurphy]

Welcome @assyrus-favolo! 👋
Are you using a hook framework like https://pre-commit.com/ or https://github.com/typicode/husky with https://github.com/lint-staged/lint-staged? Or writing raw shell in the hooks folder?
The hook frameworks do enable this, they look for file changes automatically.
If you are handwriting the hook, you may need some additional wrapping.

[assyrus-favolo]

Hello! I'm using lefthook https://lefthook.dev

[ChristianMurphy]

Left hook doesn't really support the workflow you want, and that is by design on their side evilmartians/lefthook#58 (comment)
You could try https://github.com/orgs/remarkjs/discussions/1442#discussioncomment-13159552 as @remcohaszing recommends.
But you are fighting against the workflow lefthook is trying to enforce, you may want to consider a different hook manager.

[assyrus-favolo]

I never felt like I'm working against the system here, for example I also use pint to check PHP files with only reporting and no fixing, it is functional as is, it all depends on how the tools that one uses in the hooks work, so yeah, the additional plugin suggested here makes this tool here work in that same way, lefthook always remains transparent