Skip to content

Commit

Permalink
Moved the NPM package to the @jsdevtools scope
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesMessinger committed Feb 19, 2020
1 parent 3c893b0 commit 6be69ce
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 11 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ EZ Spawn adheres to [Semantic Versioning](http://semver.org/).



[v3.0.0](https://github.com/JS-DevTools/ez-spawn/tree/v3.0.0) (2020-02-19)
----------------------------------------------------------------------------------------------------

- Moved EZ Spawn to the [@JSDevTools scope](https://www.npmjs.com/org/jsdevtools) on NPM

- The "ez-spawn" NPM package is now just a wrapper around the scoped "@jsdevtools/ez-spawn" package

[Full Changelog](https://github.com/JS-DevTools/ez-spawn/compare/v5.1.1...v3.0.0)



[v2.1.0](https://github.com/JS-DevTools/ez-spawn/tree/v2.1.0) (2018-12-21)
----------------------------------------------------------------------------------------------------

Expand Down
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
EZ-Spawn
EZ Spawn
=======================

#### Simple, consistent process spawning
Expand All @@ -9,8 +9,8 @@ EZ-Spawn
[![Coverage Status](https://coveralls.io/repos/github/JS-DevTools/ez-spawn/badge.svg?branch=master)](https://coveralls.io/github/JS-DevTools/ez-spawn?branch=master)
[![Dependencies](https://david-dm.org/JS-DevTools/ez-spawn.svg)](https://david-dm.org/JS-DevTools/ez-spawn)

[![npm](https://img.shields.io/npm/v/ez-spawn.svg?maxAge=43200)](https://www.npmjs.com/package/ez-spawn)
[![License](https://img.shields.io/npm/l/ez-spawn.svg?maxAge=2592000)](LICENSE)
[![npm](https://img.shields.io/npm/v/@jsdevtools/ez-spawn.svg?maxAge=43200)](https://www.npmjs.com/package/@jsdevtools/ez-spawn)
[![License](https://img.shields.io/npm/l/@jsdevtools/ez-spawn.svg?maxAge=2592000)](LICENSE)



Expand Down Expand Up @@ -41,7 +41,7 @@ Examples
--------------------------

```javascript
const ezSpawn = require('ez-spawn');
const ezSpawn = require('@jsdevtools/ez-spawn');

// These are all identical
ezSpawn.sync(`git commit -am "Fixed a bug"`); // Pass program and args as a string
Expand Down Expand Up @@ -76,18 +76,18 @@ Installation
Install using [npm](https://docs.npmjs.com/about-npm/):

```bash
npm install ez-spawn
npm install @jsdevtools/ez-spawn
```

Then require it in your code:

```javascript
// Require the whole package
const ezSpawn = require("ez-spawn");
const ezSpawn = require("@jsdevtools/ez-spawn");

// Or require "sync" or "async" directly
const ezSpawnSync = require("ez-spawn").sync;
const ezSpawnAsync = require("ez-spawn").async;
const ezSpawnSync = require("@jsdevtools/ez-spawn").sync;
const ezSpawnAsync = require("@jsdevtools/ez-spawn").async;
```


Expand Down Expand Up @@ -196,7 +196,7 @@ Error Handling
--------------------------
All sorts of errors can occur when spawning processes. Node's built-in [`spawn`](https://nodejs.org/api/child_process.html#child_process_child_process_spawn_command_args_options) and [`spawnSync`](https://nodejs.org/api/child_process.html#child_process_child_process_spawnsync_command_args_options) functions handle different types of errors in different ways. Sometimes they throw the error, somtimes they emit an ["error" event](https://nodejs.org/docs/latest/api/child_process.html#child_process_event_error), and sometimes they return an object with an `error` property. They also don't treat non-zero exit codes as errors. So it's up to you to handle all these different types of errors, and check the exit code too.

EZ-Spawn simplifies things by treating all errors the same. If any error occurs, or if the process exits with a non-zero exit code, then an error is thrown. The error will have all the same properties as the [`Process` object](#process-object), such as `status`, `stderr`, `signal`, etc.
EZ Spawn simplifies things by treating all errors the same. If any error occurs, or if the process exits with a non-zero exit code, then an error is thrown. The error will have all the same properties as the [`Process` object](#process-object), such as `status`, `stderr`, `signal`, etc.

```javascript
try {
Expand Down Expand Up @@ -228,7 +228,7 @@ To build/test the project locally on your computer:

License
--------------------------
ez-spawn is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.
EZ Spawn is 100% free and open-source, under the [MIT license](LICENSE). Use it however you want.


Big Thanks To
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "ez-spawn",
"name": "@jsdevtools/ez-spawn",
"version": "2.1.6",
"description": "Simple, consistent sync or async process spawning",
"keywords": [
Expand Down

0 comments on commit 6be69ce

Please sign in to comment.