unified

Project: retextjs/retext-syntax-urls

Package: retext-syntax-urls@3.1.2

  1. Dependents: 0
  2. retext plugin to classify url-like values as syntax, not natural language
  1. unified 182
  2. plugin 136
  3. retext 41
  4. syntax 28
  5. retext-plugin 26
  6. url 11
  7. source 3
  8. path 3

retext-syntax-urls

Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to classify URL-like values as syntax instead of natural language.

Contents

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 instead of natural language. That node represent “external (ungrammatical) values” instead of natural language, which hides URLs and paths from retext-spell, retext-readability, 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 and remark-retext to “hide” other syntax.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install retext-syntax-urls

In Deno with esm.sh:

import retextSyntaxUrls from 'https://esm.sh/retext-syntax-urls@3'

In browsers with esm.sh:

<script type="module">
  import retextSyntaxUrls from 'https://esm.sh/retext-syntax-urls@3?bundle'
</script>

Use

Without retext-syntax-urls:

import dictionary from 'dictionary-en-gb'
import {reporter} from 'vfile-reporter'
import {unified} from 'unified'
import retextEnglish from 'retext-english'
import retextSpell from 'retext-spell'
import retextSyntaxUrls from 'retext-syntax-urls'
import retextStringify from 'retext-stringify'

const file = await unified()
  .use(retextEnglish)
  .use(retextSpell, dictionary)
  .use(retextStringify)
  .process('Have you read readme.md? Check it out: www.example.com/readme.md')

console.log(reporter(file))

Yields:

  1:15-1:24  warning  `readme.md` is misspelt        retext-spell  retext-spell
  1:40-1:55  warning  `www.example.com` is misspelt  retext-spell  retext-spell
  1:56-1:65  warning  `readme.md` is misspelt        retext-spell  retext-spell

⚠ 3 warnings

With retext-syntax-urls:

   .use(retextEnglish)
+  .use(retextSyntaxUrls)
   .use(retextSpell, dictionary)

Yields:

no issues found

API

This package exports no identifiers. The default export is retextSyntaxUrls.

unified().use(retextSyntaxUrls)

Classify URL-like values as syntax instead of natural language.

There are no options.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.

Contribute

See contributing.md in retextjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer