remark-lint rule to warn when URLs are also defined identifiers
npm install remark-lint-no-reference-like-url[![Build][badge-build-image]][badge-build-url]
[![Coverage][badge-coverage-image]][badge-coverage-url]
[![Downloads][badge-downloads-image]][badge-downloads-url]
[![Size][badge-size-image]][badge-size-url]
[![Sponsors][badge-funding-sponsors-image]][badge-funding-url]
[![Backers][badge-funding-backers-image]][badge-funding-url]
[![Chat][badge-chat-image]][badge-chat-url]
[remark-lint][github-remark-lint] rule to warn when URLs are also defined identifiers.
* What is this?
* When should I use this?
* Presets
* Install
* Use
* API
* unified().use(remarkLintNoReferenceLikeUrl)
* Recommendation
* Examples
* Compatibility
* Contribute
* License
This package checks for likely broken URLs that should probably have been
references.
You can use this package to check links.
This plugin is not included in presets maintained here.
This package is [ESM only][github-gist-esm].
In Node.js (version 16+),
install with [npm][npm-install]:
``sh`
npm install remark-lint-no-reference-like-url
In Deno with [esm.sh][esm-sh]:
`js`
import remarkLintNoReferenceLikeUrl from 'https://esm.sh/remark-lint-no-reference-like-url@4'
In browsers with [esm.sh][esm-sh]:
`html`
On the API:
`js
import remarkLint from 'remark-lint'
import remarkLintNoReferenceLikeUrl from 'remark-lint-no-reference-like-url'
import remarkParse from 'remark-parse'
import remarkStringify from 'remark-stringify'
import {read} from 'to-vfile'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await read('example.md')
await unified()
.use(remarkParse)
.use(remarkLint)
.use(remarkLintNoReferenceLikeUrl)
.use(remarkStringify)
.process(file)
console.error(reporter(file))
`
On the CLI:
`sh`
remark --frail --use remark-lint --use remark-lint-no-reference-like-url .
On the CLI in a config file (here a package.json):
`diff`
…
"remarkConfig": {
"plugins": [
…
"remark-lint",
+ "remark-lint-no-reference-like-url",
…
]
}
…
This package exports no identifiers.
It exports no additional [TypeScript][typescript] types.
The default export is
[remarkLintNoReferenceLikeUrl][api-remark-lint-no-reference-like-url].
Warn when URLs are also defined identifiers.
###### Parameters
There are no options.
###### Returns
Transform ([Transformer from unified][github-unified-transformer]).
While full URLs for definition identifiers are okay
([https://example.com]: https://example.com),text
and what looks like an identifier could be an actual URL (),[alpha]: https://example.com
the more common case is that,
assuming a definition ,text
then a link should instead have been [text][alpha].
##### ok.md
###### In
`markdown
[Mercury][mercury] is the first planet from the sun.
[mercury]: https://example.com/mercury/
`
###### Out
No messages.
##### not-ok.md
###### In
`markdown
Mercury is the first planet from the sun.
[mercury]: https://example.com/mercury/
`
###### Out
`texttext
1:1-1:23: Unexpected resource link () with URL that matches a definition identifier (as mercury), expected reference ([text][id])`
##### image.md
###### In
`markdown
!Mercury is a planet.
[mercury]: https://example.com/mercury.jpg
`
###### Out
`text!text
1:1-1:36: Unexpected resource image () with URL that matches a definition identifier (as mercury), expected reference (![text][id])`
Projects maintained by the unified collective are compatible with maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
remark-lint-no-reference-like-url@4,
compatible with Node.js 16.
See [contributing.md][github-dotfiles-contributing] in [remarkjs/.github][github-dotfiles-health] for wayssupport.md`][github-dotfiles-support] for ways to get help.
to get started.
See [
This project has a [code of conduct][github-dotfiles-coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
[MIT][file-license] © [Titus Wormer][author]
[api-remark-lint-no-reference-like-url]: #unifieduseremarklintnoreferencelikeurl
[author]: https://wooorm.com
[badge-build-image]: https://github.com/remarkjs/remark-lint/workflows/main/badge.svg
[badge-build-url]: https://github.com/remarkjs/remark-lint/actions
[badge-chat-image]: https://img.shields.io/badge/chat-discussions-success.svg
[badge-chat-url]: https://github.com/remarkjs/remark/discussions
[badge-coverage-image]: https://img.shields.io/codecov/c/github/remarkjs/remark-lint.svg
[badge-coverage-url]: https://codecov.io/github/remarkjs/remark-lint
[badge-downloads-image]: https://img.shields.io/npm/dm/remark-lint-no-reference-like-url.svg
[badge-downloads-url]: https://www.npmjs.com/package/remark-lint-no-reference-like-url
[badge-funding-backers-image]: https://opencollective.com/unified/backers/badge.svg
[badge-funding-sponsors-image]: https://opencollective.com/unified/sponsors/badge.svg
[badge-funding-url]: https://opencollective.com/unified
[badge-size-image]: https://img.shields.io/bundlejs/size/remark-lint-no-reference-like-url
[badge-size-url]: https://bundlejs.com/?q=remark-lint-no-reference-like-url
[esm-sh]: https://esm.sh
[file-license]: https://github.com/remarkjs/remark-lint/blob/main/license
[github-dotfiles-coc]: https://github.com/remarkjs/.github/blob/main/code-of-conduct.md
[github-dotfiles-contributing]: https://github.com/remarkjs/.github/blob/main/contributing.md
[github-dotfiles-health]: https://github.com/remarkjs/.github
[github-dotfiles-support]: https://github.com/remarkjs/.github/blob/main/support.md
[github-gist-esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[github-remark-lint]: https://github.com/remarkjs/remark-lint
[github-unified-transformer]: https://github.com/unifiedjs/unified#transformer
[npm-install]: https://docs.npmjs.com/cli/install
[typescript]: https://www.typescriptlang.org