[Bug] .github/ISSUE_TEMPLATE/feature_request.md can't use brackets (such as title: "[Improve]") without Remark-lint errors, don't know what to do.

[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

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/SubStack@719afd5 passes

Runtime

GitHub

Package manager

GitHub

Operating system

GitHub

Build and bundle tools

No response

[SwuduSusuwu]

If you escape those, Remark-lint shows "fixed", but now GitHub's YAML parser broke:

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>"

https://github.com/SwuduSusuwu/SubStack/issues/templates/edit suggests to have the title default to a bracketed prefix (such as [Bug]), so know GitHub allows this.
Other than disable Remark-lint, don't know what to do.

[SwuduSusuwu]

With <!--lint ignore-->, remark_lint is fixed, but GitHub's YAML is broken;

Error in user YAML: (<unknown>): could not find expected ':' while scanning a simple key at line 3 column 1

---

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

From this message, guess is that GitHub uses static line numbers for those fields (rather than scan for those). If so, the solution is to not alter the line count, but all possible permutations of <!--...--> (such as at start or end of exigent lines) failed (that is what the long list of Update feature_request.md's followed by red boxes is).

[SwuduSusuwu]

Related posts (both had to use remark-frontmatter to solve) show errors without brackets (which GitHub does not), so know GitHub has some form of remark-frontmatter now:

• heading-style: settext headings vs front matter remark-lint#211
• https://answers.netlify.com/t/getting-issue-on-codacy-because-of-3-dashes/2762

[ChristianMurphy]

Duplicate of remarkjs/remark-lint#324 and remarkjs/remark-message-control#11
The answer continues to be your lint platform codecy needs to enable remark frontmatter rtfpessoa/codacy-remark-lint#3

[github-actions]

Hi! Thanks for taking the time to contribute!

Because we treat issues as our backlog, we close duplicates to focus our work and not have to touch the same chunk of code for the same reason multiple times. This is also why we may mark something as duplicate that isn’t an exact duplicate but is closely related.

Thanks,
— bb

[github-actions]

Hi team! It seems this post is a duplicate, but hasn’t been marked as such. Please post a comment w/ Duplicate of #123(no final .) to do so. See GH docs for more info.

Thanks,
— bb

[ChristianMurphy]

You could also chose to not use Codecy, if they won't enable remark-frontmatter, and call remark cli + remark lint + remark frontmatter from your project directly

[SwuduSusuwu]

Duplicate of remarkjs/remark-lint#324 and remarkjs/remark-message-control#11 The answer continues to be your lint platform codecy needs to enable remark frontmatter rtfpessoa/codacy-remark-lint#3

This is not a duplicate.

• Those were closed because this is a remark-frontmatter issue, so posted this to remarkjs/remark-frontmatter.
• The GitHub tools do use remark-frontmatter, which is the reason that the error is not triggered on all .github/ISSUE_TEMPLATES/*.md (just on those which use brackets).
• The error which occurs if remark-frontmatter is not enabled is different from this [no-undefined-references] Found reference to undefined definition

[SwuduSusuwu]

https://github.com/codacy/codacy-remark-lint/blob/master/package.json#L68=L75 shows "dependencies": { ... "remark-frontmatter": "^3.0.0",; know that is for frontmatter use.

[ChristianMurphy]

know that is for frontmatter use.

Having it as a dependency doesn't mean it is used or configured.
This is not a frontmatter bug.
We validate issue templates too, and do not have this issue.

[SwuduSusuwu]

know that is for frontmatter use.

Having it as a dependency doesn't mean it is used or configured. This is not a frontmatter bug.

The sole configuration file is - https://github.com/<user>/<repo>/blob/<branch>/.github/workflows/codacy.yml does not seem to have an option for this., which does not have an option to enable or disable remark-frontmatter. Thus the fact that remark-frontmatter is included (coupled with the lack of errors which the lack of remark-frontmatter causes (such as errors about the 3 dashes at the top)) shows that remark-frontmatter is used.

We validate issue templates too, and do not have this issue.

But your templates don't include brackets (such as [Bug] `build.sh` without params....
Without brackets, do not have this issue.
The reason for those brackets is: without brackets around the first word (such as Bug `build.sh` without params..., the grammar implies that the first word forms a command as part of the sentence (as opposed to the category of the post).

[wooorm]

You have problems with codacy: go talk to them.