[Bug] `remark-lint-no-undefined-references` false positive on `.github/ISSUE_TEMPLATE/*.md` with square brackets (such as `title: "[Improve]"`).

[SwuduSusuwu]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and discussions and couldn’t find anything (or linked relevant results below)

Affected package

GitHub's workflow (https://github.com/<user>/<repo>/blob/<branch>/.github/workflows/codacy.yml, which does not seem to have an option for remark-frontmatter).

Steps to reproduce

• Enable Remark-lint GitHub workflows (such as https://github.com/codacy + https://github.com/rtfpessoa/codacy-remark-lint)
  • https://github.com/<user>/<repo>/blob/<branch>/.github/workflows/codacy.yml
• Use https://github.com/SwuduSusuwu/SubStack/issues/templates/edit to add a new template (<template>) for issues, with square brackets for the default title (title: "[Improve] <relative path>: <what to do>")
  • This commits to https://github.com/<user>/<repo>/blob/<branch>/.github/ISSUE_TEMPLATE/<template>.md

Actual behavior

https://github.com/SwuduSusuwu/SubStack/security/code-scanning/2332

.github/ISSUE_TEMPLATE/feature_request.md:4

name: Feature request
about: Suggest an idea for this project
title: "[Improve] <relative path>: <what to do>"

[no-undefined-references] Found reference to undefined definition
Remark-lint (reported by Codacy)

Expected behavior

SwuduSusuwu/SusuLib@719afd5 passes

Runtime

GitHub workflows

Package manager

GitHub workflows

Operating system

GitHub workflows

Build and bundle tools

No response

[SwuduSusuwu]

If you escape those, Remark-lint shows "fixed", but now GitHub fails with

Error in user YAML: (<unknown>): found unknown escape character while parsing a quoted scalar at line 3 column 8

---

name: Feature request
about: Suggest how to improve code/workflow
title: "\[Improve\] <relative path>: <what to do>"

[ChristianMurphy]

@SwuduSusuwu it sounds like you are using front matters but have not added/enabled remark-frontmatter.

[SwuduSusuwu]

@SwuduSusuwu it sounds like you are using front matters but have not added/enabled remark-frontmatter.

@ChristianMurphy https://github.com/remarkjs/remark-frontmatter sounds like a solution, but don't know how to include that into GitHub's workflows (or if you can).

Have not found selective measures (such as clang-tidy's /* NOLINT(concurrency-mt-unsafe) */ or shellcheck's #shellcheck disable=SC2086) to disable this. Hope someone knows how to

[ChristianMurphy]

sounds like a solution, but don't know how to include that into GitHub's workflows (or if you can).

I'm not sure which GitHub workflow you are referring to.
And no I don't manage any of them.
This would be something to open an issue with that tool to have them add the frontmatter plugin.

There are disables supported by remark https://github.com/remarkjs/remark-message-control
But those may cause conflicts with whatever other tool isn't correctly configuring remark in the first place.

[github-actions]

Hi! This was closed. Team: If this was fixed, please add phase/solved. Otherwise, please add one of the no/* labels.

[SwuduSusuwu]

There are disables supported by remark https://github.com/remarkjs/remark-message-control But those may cause conflicts with whatever other tool isn't correctly configuring remark in the first place.

Now https://github.com/SwuduSusuwu/SubStack/security/code-scanning/2332 has:

.github/ISSUE_TEMPLATE/feature_request.md:5
name: Feature request
about: Suggest how to improve code/workflow
<!--lint ignore remark-lint-no-undefined-references-->
title: "[Improve] <relative path>: <what to do>"

[no-undefined-references] Found reference to undefined definition
Remark-lint (reported by Codacy)

Want to know if this is wrong use of lint ignore or if GitHub's workflows just don't support this.

https://github.com/remarkjs/remark-message-control?tab=readme-ov-file#when-should-i-use-this says that the stock remark-lint has this tool.