Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/flex-development/esast-util-builder
esast utility to build trees
https://github.com/flex-development/esast-util-builder
ast builder esast syntax syntax-tree tree unist unist-util util
Last synced: 9 days ago
JSON representation
esast utility to build trees
- Host: GitHub
- URL: https://github.com/flex-development/esast-util-builder
- Owner: flex-development
- License: bsd-3-clause
- Created: 2024-05-29T10:26:01.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2024-10-24T23:01:49.000Z (27 days ago)
- Last Synced: 2024-10-26T06:29:11.930Z (25 days ago)
- Topics: ast, builder, esast, syntax, syntax-tree, tree, unist, unist-util, util
- Language: JavaScript
- Homepage: https://github.com/flex-development/esast-util-builder
- Size: 1.3 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# esast-util-builder
[](https://github.com/flex-development/esast-util-builder/releases/latest)
[](https://npmjs.com/package/@flex-development/esast-util-builder)
[](https://codecov.io/gh/flex-development/esast-util-builder)
[](https://github.com/voxpelli/badges-cjs-esm)
[](LICENSE.md)
[](https://conventionalcommits.org/)
[](https://typescriptlang.org/)
[](https://vitest.dev/)
[](https://yarnpkg.com/)
[esast][esast] utility to build trees
## Contents
- [What is this?](#what-is-this)
- [When should I use this?](#when-should-i-use-this)
- [Install](#install)
- [Use](#use)
- [API](#api)
- [`u(type[, builder])`](#utype-builder)
- [`AnyNode`](#anynode)
- [`Builder<[T]>`](#buildert)
- [`Match`](#matchn-check)
- [`Type<[T]>`](#typet)
- [Types](#types)
- [Related](#related)
- [Contribute](#contribute)
## What is this?
This is a tiny but useful utility for building [esast][esast] nodes.
## When should I use this?
Use this package when you need to create [esast][esast] nodes.
If you need to build nodes for other ASTs, use [`unist-util-builder`][unist-util-builder] instead.
## Install
This package is [ESM only][esm].
In Node.js (version 18+) with [yarn][yarn]:
```sh
yarn add @flex-development/esast-util-builder
```
See Git - Protocols | Yarn
for details regarding installing from Git.
In Deno with [`esm.sh`][esmsh]:
```ts
import { u } from 'https://esm.sh/@flex-development/esast-util-builder'
```
In browsers with [`esm.sh`][esmsh]:
```html
import { u } from 'https://esm.sh/@flex-development/esast-util-builder'
```
## Use
**TODO**: use
## API
This package exports the identifier [`u`](#utype-builder). There is no default export.
### `u(type[, builder])`
Build an [esast][esast] node using a child node array, properties object, or value.
If `builder` is omitted, a void node (a node with only a `type` field) will be created.
> 👉 Undefined literals must be created using a properties object, rather than a value. Passing `undefined` will create
> a void node.
#### Type Parameters
- `T` (`Type`) - esast node type
##### Parameters
- `type` (`T`) - esast node type
- `builder` ([`Builder`](#buildert), optional) - node children, properties, or value
##### Returns
`Match` new esast node.
### `AnyNode`
Union of nodes that can occur in esast (TypeScript type).
> 👉 This type is exported from [`@flex-development/esast`][esast].\
> See [`AnyNode`][anynode] for more details.
### `Builder<[T]>`
Construct a union of esast node builders (TypeScript type).
**See also**: [`ub.AnyBuilder`][anybuilder], [`ub.Builder`][buildert]
```ts
type Builder> = T extends Type
? ub.Builder> extends infer B extends ub.AnyBuilder
? B extends ub.BuilderValue
? B
: B extends readonly Node[]
? B[number][]
: {
[K in keyof B]: K extends 'children'
? B[K] extends infer U extends readonly Node[]
? U[number][]
: never
: B[K]
}
: never
: never
```
### `Match`
Check if node `N` passes a test. (TypeScript type).
> 👉 This type is exported from [`@flex-development/unist-util-types`][unist-util-types].\
> See [`Match`][matchn-check] for more details.
### `Type<[T]>`
Extract [*type*][type] from node `T` (TypeScript type).
> 👉 This type is exported from [`@flex-development/unist-util-types`][unist-util-types].\
> See [`Type<[T]>`][typet] for more details.
## Types
This package is fully typed with [TypeScript][typescript].
## Related
- [`esast`][esast] — ecmascript abstract syntax tree format
## Contribute
See [`CONTRIBUTING.md`](CONTRIBUTING.md).
This project has a [code of conduct](CODE_OF_CONDUCT.md). By interacting with this repository, organization, or
community you agree to abide by its terms.
[anybuilder]: https://github.com/flex-development/unist-util-builder#anybuilder
[anynode]: https://github.com/flex-development/esast/blob/main/src/types/any-node.ts
[buildert]: https://github.com/flex-development/unist-util-builder#buildert
[esast]: https://github.com/flex-development/esast
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh/
[matchn-check]: https://github.com/flex-development/unist-util-types#typet
[type]: https://github.com/syntax-tree/unist#type
[typescript]: https://www.typescriptlang.org
[typet]: https://github.com/flex-development/unist-util-types#typet
[unist-util-builder]: https://github.com/flex-development/unist-util-builder
[unist-util-types]: https://github.com/flex-development/unist-util-types
[yarn]: https://yarnpkg.com