vweevers / hallmark

Markdown Style Guide, with linter and automatic fixer.
GNU General Public License v3.0
30 stars 3 forks source link

"cc init" output unclear #123

Open buhtz opened 2 months ago

buhtz commented 2 months ago

Please see this output of "cc init". image

It is not clear to me what it means.

If this is linter output:

vweevers commented 2 months ago

Is this debug output?

No, linter output.

Is it important for users?

Yes. I suppose we could add a introductory message like "Please address the following issues".

Do you use fancy unicode icons somehow?

Yes, it normally looks like this:

image

Which is more obvious than the output you're getting, also because each line has a hyperlink. See vfile-reporter-shiny. If you can figure out why you're not getting pretty output I'll gladly accept a PR.

What does this 1:1-1:1 mean?

Line numbers. I didn't manage to implement real line numbers here (where for example, Release (0.7.4) is empty would point to the offending line in CHANGELOG.md) but it's a general feature of vfile-reporter-shiny.

It is unexpected because "cc" is not about linting.

Hallmark was born as a linter, cc was only added later. Today I pretty much only use it for its cc add feature but I haven't yet decided what to with the rest. It can't be completely stripped out because generating markdown means having opinions on formatting, and there's also value in validating the changelog, both of which means linting is relevant.

buhtz commented 2 months ago

IMHO "cc" and "lint" should be treated as separate commands. From my perspective it is unexpected behavior having linter output when doing "cc".

About the hyperlink in terminal output: Treat a terminal as a terminal and nothing more. No unicode symbols or hyperlinks. Not everyone do use a fancy terminal emu in X/Wayland. My initial screenshot is a windows command prompt, running an ssh client, running tmux, running bahs and in the end your hallmark.