Skip to content

no-undefined-references: Add GFM table support #326

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 9, 2025
Merged

no-undefined-references: Add GFM table support #326

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d3f0192
no-undefined-references: Add GFM table support
AaronMoat Mar 31, 2025
7593f70
Add README update
AaronMoat Mar 31, 2025
5fa9f25
Move tests into JSDoc for auto-docs/testing
AaronMoat Mar 31, 2025
d6b9b12
Simplify examples
AaronMoat Mar 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion packages/remark-lint-no-undefined-references/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,11 @@ const remarkLintNoUndefinedReferences = lintRule(
footnoteDefinitionIdentifiers.add(normalizeIdentifier(node.identifier))
}

if (node.type === 'heading' || node.type === 'paragraph') {
if (
node.type === 'heading' ||
node.type === 'paragraph' ||
node.type === 'tableCell'
) {
phrasingStacks.push([...parents, node])
}
})
Expand Down
23 changes: 23 additions & 0 deletions packages/remark-lint-no-undefined-references/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,29 @@ Solar System.
1:8-1:18: Unexpected reference to undefined definition, expected corresponding definition (`mercury`) for a footnote or escaped opening bracket (`\[`) for regular text
```

#### `gfm-table.md`

###### In

> 👉 **Note**: this example uses
> GFM ([`remark-gfm`][github-remark-gfm]).

```markdown
| [Header 1] | [Header 2] |
|------------|------------|
| [foo][a] | [bar] |

[header 1]: https://example.com
[a]: https://example.com
```

###### Out

```text
1:16-1:26: Unexpected reference to undefined definition, expected corresponding definition (`header 2`) for a link or escaped opening bracket (`\[`) for regular text
3:16-3:21: Unexpected reference to undefined definition, expected corresponding definition (`bar`) for a link or escaped opening bracket (`\[`) for regular text
```
Copy link
Member

@wooorm wooorm Mar 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs and tests are generated from the code.
The docs you wrote will be automatically changed.
You can remove the manual test.
And turn this, what you added manually in the docs, into an actual test, see the code: at the top of the index.js file, there are examples.

Please then run the npm scripts provided by this package. Thank you

Copy link
Contributor Author

@AaronMoat AaronMoat Mar 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, didn't realise this. I did think the coverage of the rule was low, makes sense that the examples (docs) are the tests! Fixed in 5fa9f25.


##### `allow-shortcut-link.md`

When configured with `{ allowShortcutLink: true }`.
Expand Down
75 changes: 75 additions & 0 deletions test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,81 @@ test('remark-lint', async function (t) {
}
)

await t.test(
'should capture a variety of references (remark-lint-no-undefined-references)',
async function () {
const file = await remark()
.use(remarkLintNoUndefinedReferences, {allow: [/^b\./i]})
.process({
path: 'virtual.md',
value: [
'[Mercury] is the first planet from the Sun and the smallest in the Solar',
'System.',
'',
'[Venus][] is the second planet from the Sun.',
'',
'[Earth][earth] is the third planet from the Sun and the only astronomical',
'object known to harbor life.',
'',
'![Mars] is the fourth planet from the Sun in the [Solar',
'System].',
'',
'> Jupiter is the fifth planet from the Sun and the largest in the [Solar',
'> System][].',
'',
'[Saturn][ is the sixth planet from the Sun and the second-largest',
'in the Solar System, after Jupiter.',
'',
'[*Uranus*][] is the seventh planet from the Sun.',
'',
'[Neptune][neptune][more] is the eighth and farthest planet from the Sun.',
'',
'- [Pluto], once considered the ninth planet, is now classified as a [dwarf planet][Pluto].'
].join('\n')
})

assert.deepEqual(file.messages.map(String), [
'virtual.md:1:1-1:10: Unexpected reference to undefined definition, expected corresponding definition (`mercury`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:4:1-4:10: Unexpected reference to undefined definition, expected corresponding definition (`venus`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:6:1-6:15: Unexpected reference to undefined definition, expected corresponding definition (`earth`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:9:2-9:8: Unexpected reference to undefined definition, expected corresponding definition (`mars`) for an image or escaped opening bracket (`\\[`) for regular text',
'virtual.md:9:50-10:8: Unexpected reference to undefined definition, expected corresponding definition (`solar system`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:12:67-13:12: Unexpected reference to undefined definition, expected corresponding definition (`solar > system`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:15:1-15:9: Unexpected reference to undefined definition, expected corresponding definition (`saturn`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:18:1-18:13: Unexpected reference to undefined definition, expected corresponding definition (`*uranus*`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:20:1-20:19: Unexpected reference to undefined definition, expected corresponding definition (`neptune`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:20:19-20:25: Unexpected reference to undefined definition, expected corresponding definition (`more`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:22:3-22:10: Unexpected reference to undefined definition, expected corresponding definition (`pluto`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:22:69-22:90: Unexpected reference to undefined definition, expected corresponding definition (`pluto`) for a link or escaped opening bracket (`\\[`) for regular text'
])
}
)

await t.test(
'should support GFM tables (remark-lint-no-undefined-references)',
async function () {
const file = await remark()
.use(remarkGfm)
.use(remarkLintNoUndefinedReferences)
.process({
path: 'virtual.md',
value: [
'| [Header 1] | [Header 2] |',
'|------------|------------|',
'| [foo][a] | [bar] |',
'',
'[header 1]: https://example.com',
'[a]: https://example.com'
].join('\n')
})

assert.deepEqual(file.messages.map(String), [
'virtual.md:1:16-1:26: Unexpected reference to undefined definition, expected corresponding definition (`header 2`) for a link or escaped opening bracket (`\\[`) for regular text',
'virtual.md:3:16-3:21: Unexpected reference to undefined definition, expected corresponding definition (`bar`) for a link or escaped opening bracket (`\\[`) for regular text'
])
}
)

await t.test(
'should support `checkGithubLinguistFlag` as an option for (remark-lint-fenced-code-flag)',
async function () {
Expand Down