https://github.com/retextjs/retext-syntax-urls
plugin to classify url-like values as syntax, not natural language
https://github.com/retextjs/retext-syntax-urls
file filename filepath natural-language path retext retext-plugin syntax url
Last synced: 9 months ago
JSON representation
plugin to classify url-like values as syntax, not natural language
- Host: GitHub
- URL: https://github.com/retextjs/retext-syntax-urls
- Owner: retextjs
- License: mit
- Created: 2017-08-03T15:54:07.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2023-09-07T10:52:14.000Z (almost 3 years ago)
- Last Synced: 2025-05-07T20:44:52.646Z (about 1 year ago)
- Topics: file, filename, filepath, natural-language, path, retext, retext-plugin, syntax, url
- Language: JavaScript
- Homepage: https://unifiedjs.com
- Size: 105 KB
- Stars: 9
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# retext-syntax-urls
[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][size-badge]][size]
[![Sponsors][sponsors-badge]][collective]
[![Backers][backers-badge]][collective]
[![Chat][chat-badge]][chat]
**[retext][]** plugin to classify URL-like values as syntax instead of natural
language.
## Contents
* [What is this?](#what-is-this)
* [When should I use this?](#when-should-i-use-this)
* [Install](#install)
* [Use](#use)
* [API](#api)
* [`unified().use(retextSyntaxUrls)`](#unifieduseretextsyntaxurls)
* [Types](#types)
* [Compatibility](#compatibility)
* [Related](#related)
* [Contribute](#contribute)
* [License](#license)
## What is this?
This package is a [unified][] ([retext][]) plugin to classify URL-like values
(such as `example.com`, `index.html`, or `www.alpha.bravo`) as
[`SourceNode`][nlcst-source] instead of natural language.
That node represent “external (ungrammatical) values” instead of natural
language, which hides URLs and paths from [`retext-spell`][retext-spell],
[`retext-readability`][retext-readability],
[`retext-equality`][retext-equality], and other things that check words.
## When should I use this?
You can use this plugin any time there are URLs and paths in prose, that are
(incorrectly) warned about by linting plugins.
> 👉 **Note**: this is not a markdown parser.
> Use `unified` with [`remark-parse`][remark-parse] and
> [`remark-retext`][remark-retext] to “hide” other syntax.
## Install
This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:
```sh
npm install retext-syntax-urls
```
In Deno with [`esm.sh`][esmsh]:
```js
import retextSyntaxUrls from 'https://esm.sh/retext-syntax-urls@4'
```
In browsers with [`esm.sh`][esmsh]:
```html
import retextSyntaxUrls from 'https://esm.sh/retext-syntax-urls@4?bundle'
```
## Use
Without `retext-syntax-urls`:
```js
import dictionaryEn from 'dictionary-en'
import retextEnglish from 'retext-english'
import retextSpell from 'retext-spell'
import retextStringify from 'retext-stringify'
import retextSyntaxUrls from 'retext-syntax-urls'
import {unified} from 'unified'
import {reporter} from 'vfile-reporter'
const file = await unified()
.use(retextEnglish)
.use(retextSpell, dictionaryEn)
.use(retextStringify)
.process('Have you read readme.md? Check it out: www.example.com/readme.md')
console.log(reporter(file))
```
Yields:
```txt
1:15-1:24 warning `readme.md` is misspelt readme-md retext-spell
1:40-1:55 warning `www.example.com` is misspelt www-example.com retext-spell
1:56-1:65 warning `readme.md` is misspelt; did you mean ? readme-md retext-spell
⚠ 3 warnings
```
With `retext-syntax-urls`:
```diff
.use(retextEnglish)
+ .use(retextSyntaxUrls)
.use(retextSpell, dictionaryEn)
```
Yields:
```txt
no issues found
```
## API
This package exports no identifiers.
The default export is [`retextSyntaxUrls`][api-retext-syntax-urls].
### `unified().use(retextSyntaxUrls)`
Classify url-like values (`example.com`, `index.html`, `www.alpha.bravo`) as
syntax instead of natural language.
###### Parameters
There are no parameters.
###### Returns
Nothing (`undefined`).
## Types
This package is fully typed with [TypeScript][].
It exports no additional types.
## Compatibility
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, `retext-syntax-urls@^4`,
compatible with Node.js 16.
## Related
* [`retext-syntax-mentions`][retext-syntax-mentions]
— classify [**@mentions**](https://github.com/blog/821) as syntax
* [`retext-spell`][retext-spell]
— check spelling
* [`retext-readability`][retext-readability]
— check readability
* [`retext-equality`][retext-equality]
— check possible insensitive, inconsiderate language
## Contribute
See [`contributing.md`][contributing] in [`retextjs/.github`][health] for ways
to get started.
See [`support.md`][support] for ways to get help.
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.
## License
[MIT][license] © [Titus Wormer][author]
[build-badge]: https://github.com/retextjs/retext-syntax-urls/workflows/main/badge.svg
[build]: https://github.com/retextjs/retext-syntax-urls/actions
[coverage-badge]: https://img.shields.io/codecov/c/github/retextjs/retext-syntax-urls.svg
[coverage]: https://codecov.io/github/retextjs/retext-syntax-urls
[downloads-badge]: https://img.shields.io/npm/dm/retext-syntax-urls.svg
[downloads]: https://www.npmjs.com/package/retext-syntax-urls
[size-badge]: https://img.shields.io/bundlejs/size/retext-syntax-urls
[size]: https://bundlejs.com/?q=retext-syntax-urls
[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg
[backers-badge]: https://opencollective.com/unified/backers/badge.svg
[collective]: https://opencollective.com/unified
[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg
[chat]: https://github.com/retextjs/retext/discussions
[npm]: https://docs.npmjs.com/cli/install
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh
[typescript]: https://www.typescriptlang.org
[health]: https://github.com/retextjs/.github
[contributing]: https://github.com/retextjs/.github/blob/main/contributing.md
[support]: https://github.com/retextjs/.github/blob/main/support.md
[coc]: https://github.com/retextjs/.github/blob/main/code-of-conduct.md
[license]: license
[author]: https://wooorm.com
[nlcst-source]: https://github.com/syntax-tree/nlcst#source
[remark-parse]: https://github.com/remarkjs/remark/tree/main/packages/remark-parse
[remark-retext]: https://github.com/remarkjs/remark-retext
[retext]: https://github.com/retextjs/retext
[retext-spell]: https://github.com/retextjs/retext-spell
[retext-readability]: https://github.com/retextjs/retext-readability
[retext-equality]: https://github.com/retextjs/retext-equality
[retext-syntax-mentions]: https://github.com/retextjs/retext-syntax-mentions
[unified]: https://github.com/unifiedjs/unified
[api-retext-syntax-urls]: #unifieduseretextsyntaxurls