Skip to content

Commit 813d577

Browse files
committed
Scaffold: Normalize project
1 parent bb38afd commit 813d577

File tree

6 files changed

+85
-16
lines changed

6 files changed

+85
-16
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: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +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
28+
29+
.DS_Store

LICENSE

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

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

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
1818
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
21+
SOFTWARE.

README.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1-
async-settle
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-settle.png)](http://travis-ci.org/gulpjs/async-settle)
7+
# async-settle
58

6-
Settle your async functions - when you need to know all your parallel functions are complete (success or failure)
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]
10+
11+
Settle an async function. It will always complete successfully with an object of the resulting state.
712

813
Handles completion and errors for callbacks, promises, observables and streams.
914

@@ -47,17 +52,17 @@ Takes a function to execute (`fn`) and a function to call on completion (`callba
4752

4853
#### `fn([done])`
4954

50-
Optionally takes a callback to call when async tasks are complete.
55+
Optionally takes a callback (`done`) to call when async tasks are complete.
5156

52-
Executed in the context of [`async-done`](https://github.com/gulpjs/async-done), with all errors and results being settled.
57+
Executed in the context of [`async-done`][async-done], with all errors and results being settled.
5358

54-
Completion is handled by [`async-done` completion and error resolution](https://github.com/gulpjs/async-done#completion-and-error-resolution).
59+
Completion is handled by [`async-done` completion and error resolution][completions].
5560

5661
#### `callback(error, result)`
5762

5863
Called on completion of `fn` and recieves a settled object as the `result` argument.
5964

60-
Teh `error` argument will always be `null`.
65+
The `error` argument will always be `null`.
6166

6267
#### Settled Object
6368

@@ -70,3 +75,22 @@ Settled values have two properties, `state` and `value`.
7075
## License
7176

7277
MIT
78+
79+
[async-done]: https://github.com/gulpjs/async-done
80+
[completions]: https://github.com/gulpjs/async-done#completion-and-error-resolution
81+
82+
[downloads-image]: http://img.shields.io/npm/dm/async-settle.svg
83+
[npm-url]: https://www.npmjs.com/package/async-settle
84+
[npm-image]: http://img.shields.io/npm/v/async-settle.svg
85+
86+
[travis-url]: https://travis-ci.org/gulpjs/async-settle
87+
[travis-image]: http://img.shields.io/travis/gulpjs/async-settle.svg?label=travis-ci
88+
89+
[appveyor-url]: https://ci.appveyor.com/project/gulpjs/async-settle
90+
[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/async-settle.svg?label=appveyor
91+
92+
[coveralls-url]: https://coveralls.io/r/gulpjs/async-settle
93+
[coveralls-image]: http://img.shields.io/coveralls/gulpjs/async-settle/master.svg
94+
95+
[gitter-url]: https://gitter.im/gulpjs/gulp
96+
[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: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,21 @@
11
{
22
"name": "async-settle",
33
"version": "0.2.1",
4-
"description": "Settle your async functions - when you need to know all your parallel functions are complete (success or failure)",
5-
"author": "Blaine Bublitz <blaine@iceddev.com> (http://iceddev.com/)",
4+
"description": "Settle an async function.",
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
],
99
"repository": "gulpjs/async-settle",
1010
"license": "MIT",
1111
"engines": {
1212
"node": ">= 0.10"
1313
},
1414
"main": "index.js",
15+
"files": [
16+
"index.js",
17+
"LICENSE"
18+
],
1519
"scripts": {
1620
"lint": "eslint . && jscs index.js test/",
1721
"pretest": "npm run lint",
@@ -20,7 +24,7 @@
2024
"coveralls": "npm run cover && istanbul-coveralls"
2125
},
2226
"dependencies": {
23-
"async-done": "^1.1.1"
27+
"async-done": "^1.2.2"
2428
},
2529
"devDependencies": {
2630
"eslint": "^1.7.3",

0 commit comments

Comments
 (0)