unist-util-generated
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatunist utility to check if a node is generated.
Contents
* [`generated(node)`](#generatednode)
What is this?
This utility can be used to check if a node is said to be generatedgenerated-term.When should I use this?
You can use this utility to check is generated. Generated nodes were not in the source of the original file, and thus not authored by a human. This info can then be used to not emit lint messages for generated content.You might also find the utility
unist-util-position
unist-util-position
useful to get clean positional info.
To display positional info to users, use
unist-util-stringify-position
unist-util-stringify-position.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install unist-util-generated
In Deno with
esm.sh
esmsh:import {generated} from 'https://esm.sh/unist-util-generated@3'
In browsers with
esm.sh
esmsh:<script type="module">
import {generated} from 'https://esm.sh/unist-util-generated@3?bundle'
</script>
Use
import {generated} from 'unist-util-generated'
generated({}) // => true
generated({position: {start: {}, end: {}}}) // => true
generated({
position: {start: {line: 1, column: 1}, end: {line: 1, column: 2}}
}) // => false
API
This package exports the identifiergenerated
generated.
There is no default export.generated(node)
Check if node
is generated.Parameters
— node to check
Returns
Whethernode
is generated (does not have positional info) (boolean
).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,
unist-util-generated@^2
,
compatible with Node.js 16.Related
— get the position of nodes
— get the source of a node or position
— remove `position`s
— serialize positional info
Contribute
Seecontributing.md
contributing in syntax-tree/.github
health for
ways to get started.
See support.md
support for ways to get help.This project has a code of conductcoc. By interacting with this repository, organization, or community you agree to abide by its terms.