Project: syntax-tree/nlcst-is-literal

Package: nlcst-is-literal@2.1.0

  1. Dependents: 4
  2. nlcst utility to check whether a node is meant literally
  1. util 143
  2. utility 139
  3. unist 127
  4. nlcst 14
  5. nlcst-util 9
  6. literal 4


Build Coverage Downloads Size Sponsors Backers Chat

nlcst utility to check if a node is meant literally.

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”.


This package is ESM only: Node 12+ is needed to use it and it must be imported instead of required.


npm install nlcst-is-literal


Say we have the following file, example.txt:

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 script, 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)) {

Now, running node example yields:



This package exports the following identifiers: isLiteral. There is no default export.

isLiteral(parent, index|child)

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

For example, foo is literal in the following samples:


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.


MIT © Titus Wormer