Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 18 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<div align="center">
<h1>iopipe-scripts 🛠📦</h1>
<h1>@iopipe/scripts 🛠📦</h1>

<p>Scripts for IOpipe projects</p>
</div>
Expand All @@ -12,40 +12,45 @@
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
- [Overriding Config](#overriding-config)
- [Thank You](#thank-you)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Requirements

- Node v8.5 +

## Installation

This module is distributed via [npm][npm] which is bundled with [node][node] and
should be installed as one of your project's `devDependencies`:

```
npm install --save-dev iopipe-scripts
yarn add @iopipe/scripts --dev
```

## Usage

This is a CLI and exposes a bin called `iopipe-scripts`. I don't really plan on
documenting or testing it super duper well because it's really specific to my
needs. You'll find all available scripts in `src/scripts`.
This is a CLI and exposes a bin called iopipe-scripts.

This project actually dogfoods itself. If you look in the package.json, you'll find scripts with node src {scriptName}. This serves as an example of some of the things you can do with iopipe-scripts.

A great example of this package in use can be found at the [IOpipe event-info plugin repo](https://github.com/iopipe/iopipe-js-event-info/blob/master/package.json).

This project actually dogfoods itself. If you look in the `package.json`, you'll
find scripts with `node src {scriptName}`. This serves as an example of some
of the things you can do with `iopipe-scripts`.
You'll see that this repo uses scripts for linting, building, testing, and releasing. You'll also find the current recommended usage for eslint, until [this eslint issue is resolved](https://github.com/eslint/eslint/issues/9227).

### Overriding Config

Unlike `react-scripts`, `iopipe-scripts` allows you to specify your own
`@iopipe/scripts` allows you to specify your own
configuration for things and have that plug directly into the way things work
with `iopipe-scripts`. There are various ways that it works, but basically if you
with `@iopipe/scripts`. There are various ways that it works, but basically if you
want to have your own config for something, just add the configuration and
`iopipe-scripts` will use that instead of it's own internal config. In addition,
`iopipe-scripts` exposes its configuration so you can use it and override only
`@iopipe/scripts` will use that instead of it's own internal config. In addition,
`@iopipe/scripts` exposes its configuration so you can use it and override only
the parts of the config you need to.

This can be a very helpful way to make editor integration work for tools like
Expand All @@ -64,7 +69,7 @@ contents of:
Or, for `babel`, a `.babelrc` with:

```
{"presets": ["iopipe-scripts/babel"]}
{"presets": ["./node_modules/@iopipe/scripts/babel"]}
```

Or, for `jest`:
Expand Down