https://github.com/flex-development/fst-util-from-fs

fst utility to create trees from a file system
https://github.com/flex-development/fst-util-from-fs

ast file-system fs fst unist

Last synced: 13 days ago
JSON representation

fst utility to create trees from a file system

• Host: GitHub
• URL: https://github.com/flex-development/fst-util-from-fs
• Owner: flex-development
• License: bsd-3-clause
• Created: 2025-01-15T21:10:01.000Z (14 days ago)
• Default Branch: main
• Last Pushed: 2025-01-15T21:13:40.000Z (14 days ago)
• Last Synced: 2025-01-15T22:53:20.260Z (14 days ago)
• Topics: ast, file-system, fs, fst, unist
• Language: JavaScript
• Homepage: https://github.com/flex-development/fst-util-from-fs
• Size: 1.39 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• 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

        
# fst-util-from-fs

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

[![npm](https://img.shields.io/npm/v/@flex-development/fst-util-from-fs.svg)](https://npmjs.com/package/@flex-development/fst-util-from-fs)

[![codecov](https://codecov.io/gh/flex-development/fst-util-from-fs/branch/main/graph/badge.svg?token=c7gDtTlaw3)](https://codecov.io/gh/flex-development/fst-util-from-fs)

[![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/fst-util-from-fs.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)

Create file system trees

## Contents

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

- [Install](#install)

- [Use](#use)

- [API](#api)

- [Syntax tree](#syntax-tree)

- [Types](#types)

  - [Interfaces](#interfaces)

- [Contribute](#contribute)

## What is this?

**TODO**: what is this?

## Install

This package is [ESM only][esm].

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

```sh

yarn add @flex-development/fst-util-from-fs

```



  

    See Git - Protocols | Yarn

     for details regarding installing from Git.

  



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

```ts

import { fromFileSystem } from 'https://esm.sh/@flex-development/fst-util-from-fs'

```

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

```html

  import { fromFileSystem } from 'https://esm.sh/@flex-development/fst-util-from-fs'

```

## Use

**TODO**: use

## API

**TODO**: api

## Syntax tree

The syntax tree is [fst][].

## Types

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

### Interfaces

**TODO**: interfaces

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

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

[esmsh]: https://esm.sh

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

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

[yarn]: https://yarnpkg.com