# rise-filesystem-foundation

> ## Install

Latest version **0.0.1** (published 2023-01-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install rise-filesystem-foundation
pnpm add rise-filesystem-foundation
yarn add rise-filesystem-foundation
bun add rise-filesystem-foundation
```

## Health

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

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-01-14 |
| First published | 2023-01-14 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 2 |
| Unpacked size | 9.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | garysjennings |

## Links

- npm: https://www.npmjs.com/package/rise-filesystem-foundation
- npm.io page: https://npm.io/package/rise-filesystem-foundation

## Dependencies (2)

- [archiver](https://npm.io/package/archiver.md) ^5.3.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^10.1.0

## Recent versions

- 0.0.1 (latest) — 2023-01-14

## README

# Rise Filesystem Foundation

## Install

```
npm i rise-filsystem-foundation
```

## Usage

### filesystem.getDirectories

```js
import * as filesystem from 'rise-filesystem-foundation'
const x = filesystem.getDirectories({
    path: '/',
    projectRoot: __dirname
})
```

### filesystem.makeDir

```js
import * as filesystem from 'rise-filesystem-foundation'
await filesystem.makeDir({
    path: '/example',
    projectRoot: __dirname
})
```

### filesystem.removeDir

```js
import * as filesystem from 'rise-filesystem-foundation'
filesystem.removeDir({
    path: '/example',
    projectRoot: __dirname
})
```

### filesystem.copyDir

```js
import * as filesystem from 'rise-filesystem-foundation'
filesystem.copyDir({
    source: '/source',
    target: '/target',
    projectRoot: __dirname
})
```

### filesystem.getFile

```js
import * as filesystem from 'rise-filesystem-foundation'
const x = await filesystem.getFile({
    path: '/target/fileA.txt',
    projectRoot: __dirname
})
```

### filesystem.getJsFile

```js
import * as filesystem from 'rise-filesystem-foundation'
const x = await filesystem.getJsFile({
    path: '/target/app.js',
    projectRoot: __dirname
})
```

### filesystem.writeFile

```js
import * as filesystem from 'rise-filesystem-foundation'
filesystem.writeFile({
    path: '/fileA.js',
    content: 'export default {name: "app"}',
    projectRoot: __dirname
})
```

### filesystem.removeFile

```js
import * as filesystem from 'rise-filesystem-foundation'
filesystem.removeFile({
    path: '/fileA.js',
    projectRoot: __dirname
})
```

### filesystem.copyFile

```js
import * as filesystem from 'rise-filesystem-foundation'
filesystem.copyFile({
    source: '/source/fileA.js',
    target: '/target/fileA.js',
    projectRoot: __dirname
})
```

### filesystem.zipFolder

```js
import * as filesystem from 'rise-filesystem-foundation'
await filesystem.zipFolder({
    source: '/source',
    target: '/target',
    name: 'lambdaCode',
    projectRoot: __dirname
})
```

### filesystem.getTextContent

```js
import * as filesystem from 'rise-filesystem-foundation'
const text = await filesystem.getTextContent({
    path: '/text.txt',
    projectRoot: __dirname
})
```

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