doc: replace bash references with sh

[zackschuster]

sh means the POSIX interface, and could be bash, zsh, etc. — even just plain old sh.

refs: #34837

Checklist

• make -j4 test (UNIX), or vcbuild test (Windows) passes
• documentation is changed or added
• commit message follows commit guidelines

[zackschuster]

@DerekNonGeneric@Trott

[zackschuster]

not sure why lint-md is failing. according to tools/lint-md.js#L47139 it should be allowed.

[DerekNonGeneric]

We chose bashon purpose. I thought you'd specify further. Are you sure this isn't csh?

[DerekNonGeneric]

Suggested change

	```sh
	```console

[zackschuster]

i don't understand this request. isn't console for js code?

[aduh95]

console means a CLI, it usually shows a $, then a command, and below the standard output it produces. I don't think it's ever used for JS code – you would rather use javascript or js for JS code.

[zackschuster]

ah, i see. i updated the code. thanks for pointing that out @DerekNonGeneric 😄

[zackschuster]

Are you sure this isn't csh?

@DerekNonGeneric i've never used csh; i only mention it because it was mentioned in the other PR.

We chose bash on purpose. I thought you'd specify further.

what would you like to see elaborated?

[DerekNonGeneric]

It's not sh. That's too obscure. Find another info string.

[zackschuster]

as was pointed out in the other PR, the syntax highlighting remains the same. using implementation-agnostic references is more correct, both technically (as node itself is officially POSIX compliant) and semantically (as sh is inclusive to both itself and bash et al.)

[DerekNonGeneric]

Yes, but we don't want to make mistakes or repeat this over and over.

[zackschuster]

of course :) i amended OP to fix the mistake. thanks for pointing it out.

[aduh95]

IMHO sh is the correct infostring to use, another one could be shell. bash is just one specific shell, that happens to be the default on some Linux distribution, but there is no reason to use it in our docs. Thanks for doing that @zackschuster :)

[DerekNonGeneric]

The problem here is that we don't want other contributors to make this mistake and it will cause errors later as well. Should we change it? What do we do? I'm just as at a loss here. This has a lot to do with having made choices already. @aduh95, I think you know what is going on more than I do, but things are getting difficult to follow.

[zackschuster]

i'm a bit unclear myself — what is the exact issue? from what i gather it seems to be "a csh user might think the sh references include them". if that's the case, i would argue the inverse is true as well; as things stand, a zsh user (say, a new developer on a fresh catalina machine) might assume they're being excluded by the bash references.

[DerekNonGeneric]

@zackschuster, this is just going to fail.

Refs: https://github.com/nodejs/remark-preset-lint-node/blob/d80f818254e88c7fe7e24d74b3b809e1533e9ff8/index.js#L25

[zackschuster]

@DerekNonGeneric i was going to mention the PR in the other repo, but it seems you've already commented there.

[aduh95]

@zackschuster do you still want to do that? Asking because I still have the PR open on the other repo, and I was wondering if I should close it or request a merge.

[github-actions]

This issue/PR was marked as stalled, it will be automatically closed in 30 days. If it should remain open, please leave a comment explaining why it should remain open.

[zackschuster]

@aduh95 yes please. i'll rebase once the other PR is merged 😄

[aduh95]

Closing, as nodejs/remark-preset-lint-node#136 didn't get merged.