# firescript-builder

> Firescript project builder module for Firescript

Latest version **0.3.0** (published 2021-08-04) · MIT license · 0 weekly downloads

## Install

```sh
npm install firescript-builder
pnpm add firescript-builder
yarn add firescript-builder
bun add firescript-builder
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2021-08-04 |
| First published | 2020-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 15.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andi Heinkelein |
| Maintainers | firetux |
| Keywords | firescript, fire, firescript-module, builder, project, init |

## Links

- npm: https://www.npmjs.com/package/firescript-builder
- npm.io page: https://npm.io/package/firescript-builder

## Dependencies (2)

- [firescript-firefs](https://npm.io/package/firescript-firefs.md) ^0.3.0
- [firescript-runtime](https://npm.io/package/firescript-runtime.md) ^0.3.12

## Recent versions

- 0.3.0 (latest) — 2021-08-04
- 0.2.10 — 2021-07-16
- 0.2.9 — 2021-06-23
- 0.2.8 — 2021-01-14
- 0.2.7 — 2021-01-14
- 0.2.6 — 2020-12-15
- 0.2.5 — 2020-12-04
- 0.2.4 — 2020-12-01
- 0.2.3 — 2020-10-27
- 0.2.2 — 2020-10-26
- 0.2.1 — 2020-10-22
- 0.2.0 — 2020-10-19
- 0.1.5 — 2020-09-24
- 0.1.4 — 2020-09-04
- 0.1.3 — 2020-09-04
- … 4 more at https://npm.io/package/firescript-builder/versions

## README

Firescript builder
==================

Firescript project builder module used by the `firescript build` command.

### Usage

```js
import { FirescriptBuilder } from 'firescript-builder'

const builder = new FirescriptBuilder({
  srcDir: `${process.cwd()}/src/`,
  destDir: `${process.cwd()}/dist/`
})

const files = await builder.build()
console.log('Affected files:', files)
```

### Methods

#### *async* build([*str* srcDir], [*str* destDir]) => *arr* affectedFiles

Build project, it parse, lint and transpiles all .fire files.

```js
const files = await builder.build()
console.log('Affected files:', files)
```

**Arguments:**  

| Name:     | Flags:     | Description:              |
| --------- | ---------- | ------------------------- |
| *scrDir*  | `optional` | Overwrites `this.srcDir`  |
| *destDir* | `optional` | Overwrites `this.destDir` |

**Returns:**  

Returns An *array* of affected files.

#### *async* copy(*arr* filePattern, [*str* srcDir], [*str* destDir]) => *arr* affectedFiles

Copies files who matching on of the filePattern from `srcDir` to `destDir`

```js
const filePattern = [
  'package.json'
  'README.md',
  'templates/**/*.js'
]

const files = await builder.copy(filePattern)
console.log('Affected files:', files)
```

**Arguments:**  

| Name:         | Flags:     | Description:                      |
| ------------- | ---------- | --------------------------------- |
| *filePattern* | `required` | Defines an array of file patterns |
| *scrDir*      | `optional` | Overwrites `this.srcDir`          |
| *destDir*     | `optional` | Overwrites `this.destDir`         |

**Returns:**

Returns An *array* of affected files.

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