8000 Scaffold: Normalize readme/description/license/config · gulpjs/async-done@7b66aab · GitHub
[go: up one dir, main page]
Skip to content

Commit 7b66aab

Browse files
phatedphated
committed
Scaffold: Normalize readme/description/license/config
1 parent 3e8e9fd commit 7b66aab

File tree

6 files changed

+96
-31
lines changed

6 files changed

+96
-31
lines changed

‎.editorconfig

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# http://editorconfig.org
2+
root = true
3+
4+
[*]
5+
indent_style = space
6+
indent_size = 2
7+
charset = utf-8
8+
trim_trailing_whitespace = true
9+
insert_final_newline = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

‎.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@ coverage
1616
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
1717
.grunt
1818

19+
# node-waf configuration
20+
.lock-wscript
21+
1922
# Compiled binary addons (http://nodejs.org/api/addons.html)
2023
build/Release
2124

2225
# Dependency directory
23-
# Deployed apps should consider commenting this line out:
24-
# see https://npmjs.org/doc/faq.html#Should-I-check-my-node_modules-folder-into-git
26+
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
2527
node_modules
2628

2729
.DS_Store

‎LICENSE

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,21 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2014 Blaine Bublitz
3+
Copyright (c) 2015 Blaine Bublitz, Eric Schoffstall and other contributors
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy of
6-
this software and associated documentation files (the "Software"), to deal in
7-
the Software without restriction, including without limitation the rights to
8-
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
9-
the Software, and to permit persons to whom the Software is furnished to do so,
10-
subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
1111

1212
The above copyright notice and this permission notice shall be included in all
1313
copies or substantial portions of the Software.
1414

1515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
17-
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
18-
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
19-
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

Lines changed: 39 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,14 @@
1-
async-done
2-
==========
1+
<p align="center">
2+
<a href="http://gulpjs.com">
3+
<img height="257" width="114" src="https://raw.githubusercontent.com/gulpjs/artwork/master/gulp-2x.png">
4+
</a>
5+
</p>
36

4-
[![build status](https://secure.travis-ci.org/gulpjs/async-done.png)](http://travis-ci.org/gulpjs/async-done)
7+
# async-done
58

6-
Handles completion and errors for callbacks, promises, observables, child processes and streams.
9+
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![AppVeyor Build Status][appveyor-image]][appveyor-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]
710

8-
Will run call the function on `nextTick`. This will cause all functions to be async.
11+
Force async using `nextTick` and normalize completion/errors for callbacks, promises, observables, child processes and streams.
912

1013
## Usage
1114

@@ -49,21 +52,21 @@ Optionally takes a callback to call when async tasks are complete.
4952

5053
#### Completion and Error Resolution
5154

52-
* `Callback` called
55+
* `Callback` (`done`) called
5356
- Completion: called with null error
5457
- Error: called with non-null error
5558
* `Stream` or `EventEmitter` returned
56-
- Completion: [end-of-stream](https://www.npmjs.org/package/end-of-stream) module
57-
- Error: [domains](http://nodejs.org/api/domain.html)
59+
- Completion: [end-of-stream][end-of-stream] module
60+
- Error: [domains][domains]
5861
* `Child Process` returned
59-
- Completion [end-of-stream](https://www.npmjs.org/package/end-of-stream) module
60-
- Error: [domains](http://nodejs.org/api/domain.html)
62+
- Completion [end-of-stream][end-of-stream] module
63+
- Error: [domains][domains]
6164
* `Promise` returned
62-
- Completion: [onFulfilled](http://promisesaplus.com/#point-26) method called
63-
- Error: [onRejected](http://promisesaplus.com/#point-30) method called
65+
- Completion: [onFulfilled][promise-onfulfilled] method called
66+
- Error: [onRejected][promise-onrejected] method called
6467
* `Observable` returned
65-
- Completion: [onCompleted](https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/observable.md#rxobservableprototypesubscribeobserver--onnext-onerror-oncompleted) method called
66-
- Error: [onError](https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/observable.md#rxobservableprototypesubscribeobserver--onnext-onerror-oncompleted) method called
68+
- Completion: [onCompleted][observable-subscribe] method called
69+
- Error: [onError][observable-subscribe] method called
6770

6871
__Warning:__ Sync tasks are __not supported__ and your function will never complete if the one of the above strategies is not used to signal completion. However, thrown errors will be caught by the domain.
6972

@@ -84,3 +87,25 @@ Errors can be caused by:
8487
## License
8588

8689
MIT
90+
91+
[end-of-stream]: https://www.npmjs.org/package/end-of-stream
92+
[domains]: http://nodejs.org/api/domain.html
93+
[promise-onfulfilled]: http://promisesaplus.com/#point-26
94+
[promise-onrejected]: http://promisesaplus.com/#point-30
95+
[observable-subscribe]: https://github.com/Reactive-Extensions/RxJS/blob/master/doc/api/core/operators/subscribe.md
96+
97+
[downloads-image]: http://img.shields.io/npm/dm/async-done.svg
98+
[npm-url]: https://npmjs.org/package/async-done
99+
[npm-image]: http://img.shields.io/npm/v/async-done.svg
100+
101+
[travis-url]: https://travis-ci.org/gulpjs/async-done
102+
[travis-image]: http://img.shields.io/travis/gulpjs/async-done.svg?label=travis-ci
103+
104+
[appveyor-url]: https://ci.appveyor.com/project/gulpjs/async-done
105+
[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/async-done.svg?label=appveyor
106+
107+
[coveralls-url]: https://coveralls.io/r/gulpjs/async-done
108+
[coveralls-image]: http://img.shields.io/coveralls/gulpjs/async-done/master.svg
109+
110+
[gitter-url]: https://gitter.im/gulpjs/gulp
111+
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg

‎appveyor.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# http://www.appveyor.com/docs/appveyor-yml
2+
# http://www.appveyor.com/docs/lang/nodejs-iojs
3+
4+
environment:
5+
matrix:
6+
# node.js
7+
- nodejs_version: "0.10"
8+
- nodejs_version: "0.12"
9+
- nodejs_version: "4"
10+
- nodejs_version: "5"
11+
- nodejs_version: "6"
12+
13+
install:
14+
- ps: Install-Product node $env:nodejs_version
15+
- npm install
16+
17+
test_script:
18+
- node --version
19+
- npm --version
20+
- cmd: npm test
21+
22+
build: off
23+
24+
# build version format
25+
version: "{build}"

‎package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"name": "async-done",
33
"version": "1.2.0",
4-
"description": "Handles completion and errors for callbacks, promises, observables and streams.",
5-
"author": "Blaine Bublitz <blaine@iceddev.com> (http://iceddev.com/)",
4+
"description": "Force async using nextTick and normalize completion/errors for callbacks, promises, observables, child processes and streams.",
5+
"author": "Gulp Team <team@gulpjs.com> (http://gulpjs.com/)",
66
"contributors": [
7-
"Blaine Bublitz <blaine@iceddev.com> (http://iceddev.com/)",
7+
"Blaine Bublitz <blaine.bublitz@gmail.com>",
88
"Pawel Kozlowski <pkozlowski.opensource@gmail.com>",
99
"Matthew Podwysocki <matthew.podwysocki@gmail.com>"
1010
],

0 commit comments

Comments
 (0)
0