unist-util-remove-position
!Buildbuild-badgebuild
!Coveragecoverage-badgecoverage
!Downloadsdownloads-badgedownloads
!Sizesize-badgesize
!Sponsorssponsors-badgecollective
!Backersbackers-badgecollective
!Chatchat-badgechatunist utility to remove positional info from a tree.
Contents
* [`removePosition(node[, options])`](#removepositionnode-options)
* [`Options`](#options)
What is this?
This is a small utility that helps you remove theposition
field from nodes in
a unist tree.When should I use this?
Often, positional info is the whole reason, or an important reason, for using ASTs. Sometimes, especially when comparing trees, or when inserting one tree into another, the positional info is at best useless and at worst harmful. In those cases, you can use this utility to removeposition
fields from a
tree.You might find the utility
unist-util-position
unist-util-position
useful to instead get clean position info from a tree, or
unist-util-generated
unist-util-generated useful to check whether a node is
considered to be generated (not in the original input file).You might also enjoy
unist-util-stringify-position
unist-util-stringify-position when you want
to display positional info to users.Install
This package is ESM onlyesm. In Node.js (version 16+), install with npm:npm install unist-util-remove-position
In Deno with
esm.sh
esmsh:import {removePosition} from 'https://esm.sh/unist-util-remove-position@5'
In browsers with
esm.sh
esmsh:<script type="module">
import {removePosition} from 'https://esm.sh/unist-util-remove-position@5?bundle'
</script>
Use
import {fromMarkdown} from 'mdast-util-from-markdown'
import {removePosition} from 'unist-util-remove-position'
const tree = fromMarkdown('Some _emphasis_, **importance**, and `code`.')
removePosition(tree, {force: true})
console.dir(tree, {depth: null})
Yields:
{
type: 'root',
children: [
{
type: 'paragraph',
children: [
{type: 'text', value: 'Some '},
{type: 'emphasis', children: [{type: 'text', value: 'emphasis'}]},
{type: 'text', value: ', '},
{type: 'strong', children: [{type: 'text', value: 'importance'}]},
{type: 'text', value: ', and '},
{type: 'inlineCode', value: 'code'},
{type: 'text', value: '.'}
]
}
]
}
API
This package exports the identifierremovePosition
removeposition.
There is no default export.removePosition(node[, options])
Remove the position
field from a tree.Parameters
— tree to clean
— configuration
Returns
Nothing (undefined
).Options
Configuration (TypeScript type).Fields
force
(boolean
, default:false
)
— whether to use `delete` to remove `position` fields, the default is to
set them to `undefined`
Types
This package is fully typed with TypeScript. It exports the additional typeOptions
options.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-remove-position@^5
, compatible with Node.js 16.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.