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

esast utility to attach comments
https://github.com/flex-development/esast-util-attach-comments

ast comment ecmascript esast esast-util javascript js unist

Last synced: 4 months ago
JSON representation

esast utility to attach comments

• Host: GitHub
• URL: https://github.com/flex-development/esast-util-attach-comments
• Owner: flex-development
• License: bsd-3-clause
• Created: 2024-03-04T05:08:53.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-29T11:59:51.000Z (8 months ago)
• Last Synced: 2024-10-29T13:37:33.458Z (8 months ago)
• Topics: ast, comment, ecmascript, esast, esast-util, javascript, js, unist
• Language: JavaScript
• Homepage: https://github.com/flex-development/esast-util-attach-comments
• Size: 1.4 MB
• Stars: 1
• Watchers: 2
• 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-attach-comments

[![github release](https://img.shields.io/github/v/release/flex-development/esast-util-attach-comments.svg?include_prereleases&sort=semver)](https://github.com/flex-development/esast-util-attach-comments/releases/latest)

[![npm](https://img.shields.io/npm/v/@flex-development/esast-util-attach-comments.svg)](https://npmjs.com/package/@flex-development/esast-util-attach-comments)

[![codecov](https://codecov.io/gh/flex-development/esast-util-attach-comments/graph/badge.svg?token=gATnvcdplV)](https://codecov.io/gh/flex-development/esast-util-attach-comments)

[![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-attach-comments.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 attach comments

## Contents

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

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

- [Install](#install)

- [Use](#use)

- [API](#api)

- [Types](#types)

- [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-attach-comments

yarn add -D @flex-development/docast @flex-development/esast @types/mdast @types/unist

```



  

    See Git - Protocols | Yarn

     for details regarding installing from Git.

  



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

```ts

import { attachComments } from 'https://esm.sh/@flex-development/esast-util-attach-comments'

```

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

```html

  import { attachComments } from 'https://esm.sh/@flex-development/esast-util-attach-comments'

```

## Use

**TODO**: use

## API

**TODO**: api

## Types

This package is fully typed with [TypeScript][typescript].

## Contribute

See [`CONTRIBUTING.md`](CONTRIBUTING.md).

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

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

[esmsh]: https://esm.sh/

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

[yarn]: https://yarnpkg.com