unified

Project: syntax-tree/nlcst-is-literal

Package: nlcst-is-literal@2.1.0

  1. Dependents: 0
  2. nlcst utility to check whether a node is meant literally
  1. util 147
  2. utility 143
  3. unist 133
  4. nlcst 15
  5. nlcst-util 9
  6. literal 4
  7. word 2

nlcst-is-literal

Build Coverage Downloads Size Sponsors Backers Chat

nlcst utility to check if a node is meant literally.

Contents

What is this?

This utility can check if a node is meant literally.

When should I use this?

This package is a tiny utility that helps when dealing with words. It’s useful if a tool wants to exclude values that are possibly void of meaning. For example, a spell-checker could exclude these literal words, thus not warning about “monsieur”.

Install

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

npm install nlcst-is-literal

In Deno with esm.sh:

import {isLiteral} from "https://esm.sh/nlcst-is-literal@2"

In browsers with esm.sh:

<script type="module">
  import {isLiteral} from "https://esm.sh/nlcst-is-literal@2?bundle"
</script>

Use

Say our document example.txt contains:

The word “foo” is meant as a literal.

The word «bar» is meant as a literal.

The word (baz) is meant as a literal.

The word, qux, is meant as a literal.

The word — quux — is meant as a literal.

…and our module example.js looks as follows:

import {readSync} from 'to-vfile'
import {unified} from 'unified'
import retextEnglish from 'retext-english'
import {visit} from 'unist-util-visit'
import {toString} from 'nlcst-to-string'
import {isLiteral} from 'nlcst-is-literal'

const file = readSync('example.txt')

const tree = unified().use(retextEnglish).parse(file)

visit(tree, 'WordNode', visitor)

function visitor(node, index, parent) {
  if (isLiteral(parent, index)) {
    console.log(toString(node))
  }
}

…now running node example.js yields:

foo
bar
baz
qux
quux

API

This package exports the identifier isLiteral. There is no default export.

isLiteral(parent, index|child)

Check if the child in parent is enclosed by matching delimiters. If an index is given, the child of parent at that index is checked.

For example, foo is literal in the following samples:

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 syntax-tree/.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