# kissfs

> Extensible and reactive file-system library that keeps it simple

Latest version **0.7.1** (published 2018-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install kissfs
pnpm add kissfs
yarn add kissfs
bun add kissfs
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.7.1 |
| Published | 2018-10-17 |
| First published | 2016-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 397 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Amir Arad |
| Maintainers | amir-arad |
| Keywords | file, folder, abstraction, watch |

## Links

- npm: https://www.npmjs.com/package/kissfs
- Repository: https://github.com/wix/kissfs
- Homepage: https://github.com/wix/kissfs#readme
- Issues: https://github.com/wix/kissfs/issues
- npm.io page: https://npm.io/package/kissfs

## Dependencies (8)

- [klaw](https://npm.io/package/klaw.md) ^3.0.0
- [tslib](https://npm.io/package/tslib.md) ^1.9.3
- [autobahn](https://npm.io/package/autobahn.md) ^18.10.1
- [chokidar](https://npm.io/package/chokidar.md) ^2.0.4
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.0
- [klaw-sync](https://npm.io/package/klaw-sync.md) ^6.0.0
- [wamp-server](https://npm.io/package/wamp-server.md) ^0.0.9
- [eventemitter3](https://npm.io/package/eventemitter3.md) ^3.1.0

## Recent versions

- 0.7.1 (latest) — 2018-10-17
- 0.7.0 — 2018-10-17
- 0.6.3 — 2018-05-02
- 0.6.2 — 2018-04-15
- 0.6.1 — 2018-04-11
- 0.6.0 — 2018-04-11
- 0.5.3 — 2018-01-11
- 0.5.2 — 2018-01-09
- 0.5.1 — 2018-01-09
- 0.5.0 — 2018-01-08
- 0.4.0 — 2017-12-05
- 0.3.1 — 2017-10-22
- 0.3.0 — 2017-10-17
- 0.2.0 — 2017-09-23
- 0.1.0 — 2017-09-21
- … 191 more at https://npm.io/package/kissfs/versions

## README

# :kiss:fs
[![Build Status](https://travis-ci.org/wix/kissfs.svg?branch=master)](https://travis-ci.org/wix/kissfs)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/wix/kissfs?branch=master&svg=true)](https://ci.appveyor.com/project/qballer/kissfs/branch/master)

Extensible and reactive file-system library that keeps it simple

## User documentation
:kiss:fs supplies a standard API for the most basic file-system operations: CRUD of modest sized text files and directories, as well as listening for changes to files and directories. If you're looking to build a folder tree visualizer or manager, or a tool for viewing and editing any text file in a directory tree, :kiss:fs is what you're looking for. For simplicity and supportability, we are keeping the focus narrow so that it can be widely implemented and extended over a wide range of data sources, such as local file systems, remote git APIs, cloud-based file systems, etc. For example, you can use it to run a rename script on an in memory directory for testing purposes and then run the same script on the directories requiring the change. 

There is currently no support for meta-data (timestamps, permissions, etc.), binary content or data streams. So if you're writing a log viewer or an all-in-one file system manager, this may not be the right tool for you and we suggest you try [vinyl](https://github.com/gulpjs/vinyl).

Feedback, questions and contributions always welcome via issues.


### usage code examples
coming soon...

## developer documentation
how to build and test:
 - clone the repository
 - in the cloned folder, run `npm install`
 - run `npm test` to build and test the code in both nodejs and browser

how to debug (browser):
 - run `npm build:watch` to start transpiling all source files to es5 whenever they change (CTR+c to exit)
 - in a different window, run `npm start` to run a development server that watches the es5 files and serves them to the browser
 - open `http://localhost:8080/webtest.bundle` to run live tests that will update while you change the source code

## similar solutions
 - [vinyl](https://github.com/gulpjs/vinyl) - a standard API for file descriptors, designed for gulp. More complex than :kiss:fs.
 - [vfs](https://github.com/c9/vfs) - a file-system API with HTTP transport layer. More complex than :kiss:fs.

---
_Source: https://npm.io/package/kissfs · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._