chore(lint): refactor Markdown linting to use markdownlint-cli2

[trentm]

This switches from markdownlint-cli to markdownlint-cli2 and drops
usage of the https://github.com/avto-dev/markdown-lint GitHub action in CI.

• The avto-dev/markdown-lint action was using a 4y old version of markdownlint.
  AFAICT that action is not being maintained.
• The lint.yml workflow now uses npm run lint:markdown so that linting in CI
  is the same as doing so in dev.
• The switch from markdownlint-cli to markdownlint-cli2 and .markdownlint-cli2.jsonc
  as the config allows using the https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint
  VSCode plugin for in-editor Markdown lint warnings and intellisense in the config file.
• This also changes to prefer dash for ul-style (MD004), except in CHANGELOG.md files.

Refs: #4703

---

This is an alternative to #4703
/cc @blumamir

on ul-style

#4698 discusses whether to prefer a particular bullet character for unordered lists in Markdown. This corresponds to the MD004 rule. The default value is "consistent" ... meaning that the first bullet style in a file dictates the preference for the remainder of that file.

Currently this PR includes two commits to change to prefer the dash style... with the exception of the 3 CHANGELOG.md files which ignore this rule (via a <!-- markdownlint-disable MD004 --> directive).

(The CHANGELOG.md files are skipped because they consistently use *, including new content automatically added by tools such as release-please.)

separate commits

This PR is separated into a number of commits to try to separate the config changes from the lint-update changes, in case that helps with reviewing.

[trentm]

special changelog lint rules in avto-dev/markdown-lint

One of the potential pitches of the avto-dev/markdown-lint action is that it supported some addition lint rules for changelog files.

However, my understanding is that we have never used those rules because they are commented out here:

opentelemetry-js/.github/workflows/lint.yml

Lines 27 to 30 in 806fa97

	# Commenting due to
	# https://github.com/avto-dev/markdown-lint/blob/aab9be9823fcd706f6da3e6ad6c64874c23fbd4c/lint/rules/changelog.js#L51-L71
	# TODO: adhere to, or overwrite above rule and uncomment rules
	# rules: "/lint/rules/changelog.js"

So, nothing is lost by switching away from this GH Action.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.57%. Comparing base (2610122) to head (397e001).
Report is 36 commits behind head on main.

❗ Current head 397e001 differs from pull request most recent head c6753bb

Please upload reports for the commit c6753bb to get more accurate results.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4713      +/-   ##
==========================================
+ Coverage   90.77%   93.57%   +2.79%     
==========================================
  Files          90      298     +208     
  Lines        1930     8466    +6536     
  Branches      417     1753    +1336     
==========================================
+ Hits         1752     7922    +6170     
- Misses        178      544     +366     

see 244 files with indirect coverage changes

[trentm]

For the contrib repo, open-telemetry/opentelemetry-js-contrib#2205 was a recent change adding "dash" ul-style. If this PR is amenable I can make a PR to switch the contrib repo over to markdownlint-cli2 as well.

[blumamir]

Thanks @trentm great research and digging, happy to see up-to-date tolling and better developer experience.

left few minor questions / thoughts

[blumamir]

For the contrib repo, open-telemetry/opentelemetry-js-contrib#2205 was a recent change adding "dash" ul-style. If this PR is amenable I can make a PR to switch the contrib repo over to markdownlint-cli2 as well.

That sounds great, would love to see this change in contrib as well 🥇