CLI toolbox for common scripts for my projects
+Scripts for IOpipe projects
-
-## The problem
-
-I do a bunch of open source and want to make it easier to maintain so many
-projects.
-
-## This solution
-
-This is a CLI that abstracts away all configuration for my open source projects
-for linting, testing, building, and more.
-
## Table of Contents
+
+- [Requirements](#requirements)
- [Installation](#installation)
- [Usage](#usage)
-- [Inspiration](#inspiration)
-- [Other Solutions](#other-solutions)
-- [Contributors](#contributors)
-- [LICENSE](#license)
+ - [Overriding Config](#overriding-config)
+- [Thank You](#thank-you)
+## 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 kcd-scripts
+yarn add @iopipe/scripts --dev
```
## Usage
-This is a CLI and exposes a bin called `kcd-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 `kcd-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).
+
+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`, `kcd-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 `kcd-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
-`kcd-scripts` will use that instead of it's own internal config. In addition,
-`kcd-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
@@ -82,7 +60,7 @@ So, if we were to do this for ESLint, you could create an `.eslintrc` with the
contents of:
```
-{"extends": "./node_modules/kcd-scripts/eslint.js"}
+{"extends": "./node_modules/iopipe-scripts/eslint.js"}
```
> Note: for now, you'll have to include an `.eslintignore` in your project until
@@ -91,69 +69,23 @@ contents of:
Or, for `babel`, a `.babelrc` with:
```
-{"presets": ["kcd-scripts/babel"]}
+{"presets": ["./node_modules/@iopipe/scripts/babel"]}
```
Or, for `jest`:
```javascript
-const {jest: jestConfig} = require('kcd-scripts/config')
+const { jest: jestConfig } = require('iopipe-scripts/config');
module.exports = Object.assign(jestConfig, {
// your overrides here
-})
+});
```
-> Note: `kcd-scripts` intentionally does not merge things for you when you start
+> Note: `iopipe-scripts` intentionally does not merge things for you when you start
> configuring things to make it less magical and more straightforward. Extending
> can take place on your terms. I think this is actually a great way to do this.
-## Inspiration
-
-This is inspired by `react-scripts`.
-
-## Other Solutions
-
-I'm not aware of any, if you are please [make a pull request][prs] and add it
-here! Again, this is a very specific-to-me solution.
-
-## Contributors
-
-Thanks goes to these people ([emoji key][emojis]):
-
-
-| [
