Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/flex-development/esast-util-from-code

esast utility to parse source code
https://github.com/flex-development/esast-util-from-code

ast esast javascript js syntax-tree ts typescript unist

Last synced: 9 days ago
JSON representation

esast utility to parse source code

Awesome Lists containing this project

README

        

# esast-util-from-code

[![github release](https://img.shields.io/github/v/release/flex-development/esast-util-from-code.svg?include_prereleases&sort=semver)](https://github.com/flex-development/esast-util-from-code/releases/latest)
[![npm](https://img.shields.io/npm/v/@flex-development/esast-util-from-code.svg)](https://npmjs.com/package/@flex-development/esast-util-from-code)
[![codecov](https://codecov.io/gh/flex-development/esast-util-from-code/graph/badge.svg?token=sZorM0WXz5)](https://codecov.io/gh/flex-development/esast-util-from-code)
[![module type: esm](https://img.shields.io/badge/module%20type-esm-brightgreen)](https://github.com/voxpelli/badges-cjs-esm)
[![license](https://img.shields.io/github/license/flex-development/esast-util-from-code.svg)](LICENSE.md)
[![conventional commits](https://img.shields.io/badge/-conventional%20commits-fe5196?logo=conventional-commits&logoColor=ffffff)](https://conventionalcommits.org/)
[![typescript](https://img.shields.io/badge/-typescript-3178c6?logo=typescript&logoColor=ffffff)](https://typescriptlang.org/)
[![vitest](https://img.shields.io/badge/-vitest-6e9f18?style=flat&logo=vitest&logoColor=ffffff)](https://vitest.dev/)
[![yarn](https://img.shields.io/badge/-yarn-2c8ebb?style=flat&logo=yarn&logoColor=ffffff)](https://yarnpkg.com/)

[esast][esast] utility to parse source code

## Contents

- [What is this?](#what-is-this)
- [When should I use this?](#when-should-i-use-this)
- [Install](#install)
- [Use](#use)
- [API](#api)
- [Related](#related)
- [Contribute](#contribute)

## What is this?

**TODO**: what is this?

## When should I use this?

**TODO**: when should i use this?

## Install

This package is [ESM only][esm].

In Node.js (version 18+) with [yarn][yarn]:

```sh
yarn add @flex-development/esast-util-from-code
```



See Git - Protocols | Yarn
 for details regarding installing from Git.

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

```ts
import { fromCode } from 'https://esm.sh/@flex-development/esast-util-from-code'
```

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

```html

import { fromCode } from 'https://esm.sh/@flex-development/esast-util-from-code'

```

## Use

**TODO**: use

## API

**TODO**: api

## Related

- [`esast-util-attach-comments`][esast-util-attach-comments] — attach comments to the tree

## 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.

[esast-util-attach-comments]: https://github.com/flex-development/esast-util-attach-comments

[esast]: https://github.com/flex-development/esast
[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c
[esmsh]: https://esm.sh/
[yarn]: https://yarnpkg.com