npmpackage.info

unist-util-remove-position

utility to remove positions from a tree

5.0.0

MIT

JavaScript

Installations

npm install unist-util-remove-position

Pull Requests

Open

0

Total

4

Closed

1

Merged

3

Issues

Open

0

Total

1

Closed

1

Releases

5.0.0

Published on 07 Jul 2023

4.0.2

Published on 23 Jan 2023

4.0.1

Published on 01 Aug 2021

4.0.0

Published on 20 Apr 2021

3.0.0

Published on 14 Jul 2020

2.0.1

Published on 16 Feb 2020

View all 13 releases

Developer

syntax-tree

Developer Guide

BETA

Module System

ESM

Min. Node Version

Typescript Support

Yes

Node Version

20.0.0

NPM Version

9.7.2 Statistics

12 Stars

103 Commits

2 Forks

9 Watching

1 Branches

11 Contributors

Updated on 22 Jul 2024

Languages

JavaScript (90.59%)

TypeScript (9.41%)

Total Downloads

Cumulative downloads

Total Downloads

1,239,234,720

Last day

-0.9%

941,263

Compared to previous day

Last week

4.2%

5,028,618

Compared to previous week

Last month

10.2%

20,960,457

Compared to previous month

Last year

-13.1%

247,968,130

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/unist unist-util-visit

Dev Dependencies

@types/mdast @types/node c8 mdast-util-from-markdown prettier remark-cli remark-preset-wooorm tsd type-coverage typescript unist-builder xo

Versions

unist-util-remove-position

unist utility to remove positional info from a tree.

What is this?
When should I use this?
Install
Use
API
- removePosition(node[, options])
- Options
Types
Compatibility
Contribute
License

What is this?

This is a small utility that helps you remove the position 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 remove position fields from a tree.

You might find the utility unist-util-position useful to instead get clean position info from a tree, or 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 when you want to display positional info to users.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

1npm install unist-util-remove-position

In Deno with esm.sh:

1import {removePosition} from 'https://esm.sh/unist-util-remove-position@5'

In browsers with esm.sh:

1<script type="module">
2  import {removePosition} from 'https://esm.sh/unist-util-remove-position@5?bundle'
3</script>

Use

1import {fromMarkdown} from 'mdast-util-from-markdown'
2import {removePosition} from 'unist-util-remove-position'
3
4const tree = fromMarkdown('Some _emphasis_, **importance**, and `code`.')
5
6removePosition(tree, {force: true})
7
8console.dir(tree, {depth: null})

Yields:

1{
2  type: 'root',
3  children: [
4    {
5      type: 'paragraph',
6      children: [
7        {type: 'text', value: 'Some '},
8        {type: 'emphasis', children: [{type: 'text', value: 'emphasis'}]},
9        {type: 'text', value: ', '},
10        {type: 'strong', children: [{type: 'text', value: 'importance'}]},
11        {type: 'text', value: ', and '},
12        {type: 'inlineCode', value: 'code'},
13        {type: 'text', value: '.'}
14      ]
15    }
16  ]
17}

API

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

`removePosition(node[, options])`

Remove the position field from a tree.

Parameters

node (Node) — tree to clean
options (Options, optional) — 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 type 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

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

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

SAST

Determines if the project uses static code analysis.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

Score

3.7

/10

Last Scanned on 2024-11-18

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to unist-util-remove-position

unist-util-stringify-position

4.0.0

unist utility to serialize a node, position, or point as a human readable location

unist-util-position

5.0.0

unist utility to get the position of a node

unist-util-position-from-estree

2.0.0

unist utility to get a position from an estree node

unist-util-generated

3.0.0

unist utility to check if a node is generated

unist-util-remove-position

Installations

Pull Requests

0

4

1

3

Issues

0

1

1

Releases

Developer

Developer Guide

ESM

Yes

20.0.0

9.7.2

Statistics

Languages

Total Downloads

1,239,234,720

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Dev Dependencies

unist-util-remove-position

Contents

What is this?

When should I use this?

Install

Use

API

removePosition(node[, options])

Parameters

Returns

Options

Fields

Types

Compatibility

Contribute

License

10

10

10

10

10

0

0

0

0

0

0

0

0

0

3.7

/10

Other packages similar to unist-util-remove-position

`removePosition(node[, options])`

`Options`