# @timkendrick/skivvy-package-react-app

> ESLint/Mocha/ES6/JSX/Browserify/Stylus app tasks

Latest version **0.1.3** (published 2015-08-31) · ISC license · 0 weekly downloads

## Install

```sh
npm install @timkendrick/skivvy-package-react-app
pnpm add @timkendrick/skivvy-package-react-app
yarn add @timkendrick/skivvy-package-react-app
bun add @timkendrick/skivvy-package-react-app
```

## 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.1.3 |
| Published | 2015-08-31 |
| First published | 2015-06-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 11 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Tim Kendrick |
| Maintainers | timkendrick |
| Keywords | skivvy-package |

## Links

- npm: https://www.npmjs.com/package/@timkendrick/skivvy-package-react-app
- Repository: https://github.com/timkendrick/skivvy-package-react
- Homepage: https://github.com/timkendrick/skivvy-package-react#readme
- Issues: https://github.com/timkendrick/skivvy-package-react/issues
- npm.io page: https://npm.io/package/@timkendrick/skivvy-package-react-app

## Dependencies (11)

- [babel-eslint](https://npm.io/package/babel-eslint.md) ^4.1.1
- [skivvy-factory](https://npm.io/package/skivvy-factory.md) ^0.1.3
- [eslint-plugin-react](https://npm.io/package/eslint-plugin-react.md) ^3.3.0
- [@skivvy/skivvy-package-copy](https://npm.io/package/@skivvy/skivvy-package-copy.md) ^0.1.4
- [@skivvy/skivvy-package-clean](https://npm.io/package/@skivvy/skivvy-package-clean.md) ^0.1.6
- [@skivvy/skivvy-package-mocha](https://npm.io/package/@skivvy/skivvy-package-mocha.md) ^0.1.5
- [@skivvy/skivvy-package-serve](https://npm.io/package/@skivvy/skivvy-package-serve.md) ^0.1.1
- [@skivvy/skivvy-package-watch](https://npm.io/package/@skivvy/skivvy-package-watch.md) ^0.1.2
- [@skivvy/skivvy-package-eslint](https://npm.io/package/@skivvy/skivvy-package-eslint.md) ^0.1.3
- [@skivvy/skivvy-package-stylus](https://npm.io/package/@skivvy/skivvy-package-stylus.md) ^0.1.3
- [@skivvy/skivvy-package-browserify](https://npm.io/package/@skivvy/skivvy-package-browserify.md) ^0.1.4

## Recent versions

- 0.1.3 (latest) — 2015-08-31
- 0.1.2 — 2015-08-31
- 0.1.1 — 2015-08-31
- 0.1.0 — 2015-06-10

## README

# Skivvy package: `@timkendrick/react-app`
[![npm version](https://img.shields.io/npm/v/@timkendrick/skivvy-package-react-app.svg)](https://www.npmjs.com/package/@timkendrick/skivvy-package-react-app)
![Stability](https://img.shields.io/badge/stability-stable-brightgreen.svg)
[![Build Status](https://travis-ci.org/timkendrick/skivvy-package-react-app.svg?branch=master)](https://travis-ci.org/timkendrick/skivvy-package-react-app)

> ESLint/Mocha/ES6/JSX/Browserify/Stylus app tasks


## Installation

```bash
skivvy install @timkendrick/react-app
```


## Overview

This package allows you to perform ESLint/Mocha/ES6/JSX/Browserify/Stylus app tasks from within the [Skivvy](https://www.npmjs.com/package/skivvy) task runner.


## Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `source` | `object` | No | N/A | Paths to source files |
| `source.scripts` | `string` | No | `"src/scripts"` | Path to JS source files |
| `source.styles` | `string` | No | `"src/styles"` | Path to Stylus source files |
| `source.templates` | `string` | No | `"src/templates"` | Path to HTML page templates folder |
| `source.assets` | `string` | No | `"src/assets"` | Path to assets folder |
| `tests` | `string` | No | `"test"` | Path to test root |
| `destination` | `string` | No | `"dist"` | Path to destination root |
| `port` | `number` | No | `3000` | Port to use for preview server |
| `debug` | `boolean` | No | `false` | Whether to run the tasks in dev mode |


## Included tasks

### `test`

Lint source files and run unit tests

#### Usage:

```bash
skivvy run test
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `scripts` | `string` | No | `"<%= package.source.scripts %>"` | Path to JS source files |
| `tests` | `string` | No | `"<%= package.tests %>"` | Path to test root |
| `mocha` | `string` | No | `"<%= package.tests %>/**/*.spec.js"` | Path to Mocha specs |


### `build`

Run the `test` task, clean destination folder, copy assets and compile source files

If the package's `debug` configuration setting is `true`, this task will watch for changes.

#### Usage:

```bash
skivvy run build
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `source` | `object` | No | N/A | Paths to source files |
| `source.scripts` | `string` | No | `"<%= package.source.scripts %>"` | Path to JS source files |
| `source.js` | `string` | No | `"<%= package.source.scripts %>/index.js"` | Path to JS entry point |
| `source.styles` | `string` | No | `"<%= package.source.styles %>"` | Path to Stylus source files |
| `source.stylus` | `string` | No | `"<%= package.source.styles %>/index.styl"` | Path to Stylus entry point |
| `source.assets` | `string` | No | `"<%= package.source.assets %>"` | Path to assets folder |
| `source.index` | `string` | No | `"<%= package.source.templates %>/index.html"` | Path to HTML page template |
| `destination.root` | `string` | No | `"<%= package.destination %>"` | Path to destination root folder |
| `destination.index` | `string` | No | `"<%= package.destination %>/index.html"` | Path to destination HTML file |
| `destination.js` | `string` | No | `"<%= package.destination %>/js/app.js"` | Path to destination JS file |
| `destination.css` | `string` | No | `"<%= package.destination %>/css/app.css"` | Path to destination CSS file |


### `serve`

Run the `build` task and launch a preview server

#### Usage:

```bash
skivvy run serve
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `root` | `string` | No | `"<%= package.destination %>"` | Path to destination root |
| `port` | `number` | No | `"<%= package.port %>"` | Port to use for preview server |
| `watch` | `boolean` | No | `"<%= package.debug %>"` | Whether to reload on file changes |


### `create-app`

Create a new app component

#### Usage:

```bash
skivvy run create-app
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `name` | `string` | No | N/A | App component name |
| `destination` | `string` | No | `"<%= package.source.scripts %>/apps"` | Path to app components folder |



### `create-view`

Create a new view component

#### Usage:

```bash
skivvy run create-view
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `name` | `string` | No | N/A | View component name |
| `destination` | `string` | No | `"<%= package.source.scripts %>/views"` | Path to view components folder |



### `create-component`

Create a new component

#### Usage:

```bash
skivvy run create-component
```


#### Configuration settings:

| Name | Type | Required | Default | Description |
| ---- | ---- | -------- | ------- | ----------- |
| `name` | `string` | No | N/A | Component name |
| `destination` | `string` | No | `"<%= package.source.scripts %>/components"` | Components folder |

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