hdi ignore

[maxelkins]

Feature request

<!-- hdi-ignore --> sections of markdown to hide commands from hdi's output.

Very niche but could be useful.

Very niche usecase: Within the hdi repo itself - do we want to surface hdi's usage in the hdi output.

This could be common with other CLI tools too, there is a distinction between "hdi run things in this repo" and "hdi use the tool this repo is about".

[grega]

I definitely like the concept, but I'm a bit hesitant to "pollute" Markdown meant for humans with some additional tags for the machine to read 🤔

Will mull it over some more, as I did also note (and was bothered by) the superfluous output when running on hdi's README...

I'd love to solve it fully in hdi itself, but I'm aware that it's likely to be unachievable 😄

[grega]

One way of tackling this; if there's a CONTRIBUTORS.md file, this could take precedence when hdi runs (since it's most likely to provide the sort of content / commands that we're most interested in), perhaps flagging that there's also a README which can be parsed if the user would prefer.

This preference could even be saved in a .hdirc file, probably in ~/ by default (but optionally in the project directory / repository itself).

And perhaps there are other preferences that could be written to ~/.hdirc (but this very much feels like v2!)

You could even hit x when inside a section in hdi's picker to hide that, eg. marking it as irrelevant (and again, store that as a preference)?

[grega]

In the case of:

hdi                    Interactive picker - shows all sections (default)
hdi install            Just install/setup commands (aliases: setup, i)
hdi run                Just run/start commands (aliases: start, r)
hdi test               Just test commands (alias: t)
hdi deploy             Just deploy/release commands (alias: d)
hdi all                All sections (aliases: a)
hdi check              Check if required tools are installed (alias: c)
hdi /path/to/project   Scan a different directory
hdi /path/to/file.md   Parse a specific markdown file

hdi could simply ignore tabular blocks like this?

[maxelkins]

bit hesitant to "pollute" Markdown meant for humans

Yeah thats a good point - I was kinda only thinking about it being hidden when rendered but I guess a lot of people will read the straight up .md file too.

if there's a CONTRIBUTORS.md file, this could take precedence

I like that, nice extra to have. Had also been thinking about a perferences file.

hdi could simply ignore tabular blocks like this?

mmm feels like that could cause issues later down the line...