There are no diff unless we specify `-p` about md-toc HOT 9 CLOSED

I'm not sure what you are trying to achieve, but correct me if I'm wrong:

• you are using md-toc's pre-commit hook
• the platform you are running pre-commit on does not support file changing in place
• md-toc returns an exit code != 0 only in the case if something goes wrong. If you don't pass the -p options then md-toc will print the TOC to the stdout, and it will return 0. Since you can't use -p, you need some other way to replace the old TOC in the markdown file
• since the markdown file needs to be changed, you need that the pre-commit pipeline fails. This won't happen by simply removing the -p option...

You didn't mention the platform(s), but I think the easiest thing to do is reading some environment variable specific to that/those platform: if the environment variable(s) is detected then md-toc must exit with something != 0

from md-toc.

Is there a way to check whether the ToC would have been changed without actually changing the ToC?

If so, I can put md-toc in tox (no changing the ToC) as well as in pre-commit (apply changes to ToC if necessary).

Thanks!

from md-toc.

OK, so you want something like this?

old_toc = get_toc(file)
new_toc = build_toc(file)
if '--diff' and old_toc != new_toc:
    print(new_toc)
    sys.exit(128)
else:
    print(new_toc)
    sys.exit(0)

from md-toc.

You can try the new --diff option from the dev branch. Let me know if it works

from md-toc.

Hi @frnmst , it works perfectly! Thank you!

I'm using md-toc in pre-commit for auto-formatting locally. And then I'm adding a md-toc step in tox.ini (with --diff) just for the CI pipeline.

from md-toc.

Hi @frnmst , here's a follow-up question: do you plan to add this functionality to the latest release any time soon? Thanks!

from md-toc.

Hi @jsh9 this new feature needs a cleanup and the usual unit tests. It is scheduled to be released for version 8.2.0. See the changelog.

from md-toc.

Thank you!

from md-toc.

Done, check version 8.2.0

from md-toc.