Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/syntax-tree/xast-util-from-xml

utility to parse from XML
https://github.com/syntax-tree/xast-util-from-xml

parse syntax-tree unist util xast xast-util xml

Last synced: about 1 month ago
JSON representation

utility to parse from XML

Host: GitHub
URL: https://github.com/syntax-tree/xast-util-from-xml
Owner: syntax-tree
License: mit
Created: 2020-02-14T12:39:03.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2023-07-18T15:17:27.000Z (over 1 year ago)
Last Synced: 2024-11-11T19:14:32.326Z (about 1 month ago)
Topics: parse, syntax-tree, unist, util, xast, xast-util, xml
Language: JavaScript
Homepage: https://unifiedjs.com
Size: 108 KB
Stars: 15
Watchers: 9
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: readme.md
- License: license

Awesome Lists containing this project

awesome-syntax-tree - xast-util-from-xml - Transform from an XML string. (xast utilities)

README

        # xast-util-from-xml

[![Build][build-badge]][build]

[![Coverage][coverage-badge]][coverage]

[![Downloads][downloads-badge]][downloads]

[![Size][size-badge]][size]

[![Sponsors][sponsors-badge]][collective]

[![Backers][backers-badge]][collective]

[![Chat][chat-badge]][chat]

[xast][] utility to parse from XML.

## Contents

*   [What is this?](#what-is-this)

*   [When should I use this?](#when-should-i-use-this)

*   [Install](#install)

*   [Use](#use)

*   [API](#api)

    *   [`fromXml(value)`](#fromxmlvalue)

*   [Types](#types)

*   [Compatibility](#compatibility)

*   [Security](#security)

*   [Related](#related)

*   [Contribute](#contribute)

*   [License](#license)

## What is this?

This package is a utility that takes serialized XML as input and turns it into

a [xast][] syntax tree.

It uses [`@rgrove/parse-xml`][parse-xml], which is a good and fast XML parser,

and turns its results into xast.

## When should I use this?

If you want to use xast syntax trees, use this.

The utility [`xast-util-to-xml`][xast-util-to-xml] does the inverse of this

utility.

It turns xast into XML.

## Install

This package is [ESM only][esm].

In Node.js (version 16+), install with [npm][]:

```sh

npm install xast-util-from-xml

```

In Deno with [`esm.sh`][esmsh]:

```js

import {fromXml} from 'https://esm.sh/xast-util-from-xml@4'

```

In browsers with [`esm.sh`][esmsh]:

```html

  import {fromXml} from 'https://esm.sh/xast-util-from-xml@4?bundle'

```

## Use

Say our document `example.xml` contains:

```xml

  Born in the U.S.A.

  Bruce Springsteen

  1984-04-06

```

…and our module `example.js` looks as follows:

```js

import fs from 'node:fs/promises'

import {fromXml} from 'xast-util-from-xml'

const tree = fromXml(await fs.readFile('example.xml'))

console.dir(tree, {depth: undefined})

```

…now running `node example.js` yields (positional info removed for brevity):

```js

{

  type: 'root',

  children: [

    {

      type: 'element',

      name: 'album',

      attributes: {id: '123'},

      children: [

        {type: 'text', value: '\n  '},

        {

          type: 'element',

          name: 'name',

          attributes: {},

          children: [{type: 'text', value: 'Born in the U.S.A.'}]

        },

        {type: 'text', value: '\n  '},

        {

          type: 'element',

          name: 'artist',

          attributes: {},

          children: [{type: 'text', value: 'Bruce Springsteen'}]

        },

        {type: 'text', value: '\n  '},

        {

          type: 'element',

          name: 'releasedate',

          attributes: {},

          children: [{type: 'text', value: '1984-04-06'}]

        },

        {type: 'text', value: '\n'}

      ]

    }

  ]

}

```

## API

This package exports the identifier [`fromXml`][api-from-xml].

There is no default export.

### `fromXml(value)`

Parse a string of XML to a xast tree.

##### Parameters

*   `value` (`Uint8Array` in UTF-8 or `string`).

    — serialized XML

##### Returns

xast root ([`Root`][root]).

###### Throws

When the XML cannot be parsed with `@rgrove/parse-xml`, a

[`VFileMessage`][vfile-message] is thrown.

This can for example happen when passing archaic or unsafe XML (such as

entities), or just otherwise invalid XML such as missnested tags.

## 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, `xast-util-from-xml@^4`,

compatible with Node.js 16.

## Security

XML can be a dangerous language: don’t trust user-provided data.

## Related

*   [`xast-util-to-xml`](https://github.com/syntax-tree/xast-util-to-xml)

    — serialize xast to XML

*   [`hast-util-to-xast`](https://github.com/syntax-tree/hast-util-to-xast)

    — transform hast (html, svg) to xast (xml)

*   [`xastscript`](https://github.com/syntax-tree/xastscript)

    — create xast trees

## Contribute

See [`contributing.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 conduct][coc].

By interacting with this repository, organization, or community you agree to

abide by its terms.

## License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/syntax-tree/xast-util-from-xml/workflows/main/badge.svg

[build]: https://github.com/syntax-tree/xast-util-from-xml/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/syntax-tree/xast-util-from-xml.svg

[coverage]: https://codecov.io/github/syntax-tree/xast-util-from-xml

[downloads-badge]: https://img.shields.io/npm/dm/xast-util-from-xml.svg

[downloads]: https://www.npmjs.com/package/xast-util-from-xml

[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=xast-util-from-xml

[size]: https://bundlejs.com/?q=xast-util-from-xml

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[collective]: https://opencollective.com/unified

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/syntax-tree/unist/discussions

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[typescript]: https://www.typescriptlang.org

[license]: license

[author]: https://wooorm.com

[health]: https://github.com/syntax-tree/.github

[contributing]: https://github.com/syntax-tree/.github/blob/main/contributing.md

[support]: https://github.com/syntax-tree/.github/blob/main/support.md

[coc]: https://github.com/syntax-tree/.github/blob/main/code-of-conduct.md

[xast]: https://github.com/syntax-tree/xast

[root]: https://github.com/syntax-tree/xast#root

[vfile-message]: https://github.com/vfile/vfile-message

[parse-xml]: https://github.com/rgrove/parse-xml

[xast-util-to-xml]: https://github.com/syntax-tree/xast-util-to-xml

[api-from-xml]: #fromxmlvalue