Skip to content

Commit 056f7f0

Browse files
phatedphated
committed
Scaffold: Normalize repository
1 parent bc54ec6 commit 056f7f0

16 files changed

+390
-421
lines changed

‎.editorconfig

+2-7
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,11 @@ root = true
33

44
[*]
55
indent_style = space
6-
end_of_line = lf
7-
charset = utf-8
86
indent_size = 2
7+
charset = utf-8
98
trim_trailing_whitespace = true
109
insert_final_newline = true
10+
end_of_line = lf
1111

1212
[*.md]
1313
trim_trailing_whitespace = false
14-
insert_final_newline = false
15-
16-
[test/**/*]
17-
trim_trailing_whitespace = false
18-
insert_final_newline = false

‎.eslintrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "gulp"
3+
}

‎.gitattributes

-9
Original file line numberDiff line numberDiff line change
@@ -1,10 +1 @@
1-
# Enforce Unix newlines
21
* text eol=lf
3-
4-
# binaries
5-
*.ai binary
6-
*.psd binary
7-
*.jpg binary
8-
*.gif binary
9-
*.png binary
10-
*.jpeg binary

‎.gitignore

+30-14
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,31 @@
1-
*.DS_Store
2-
*.sublime-*
3-
_gh_pages
4-
bower_components
5-
node_modules
6-
npm-debug.log
7-
actual
8-
test/actual
9-
temp
10-
tmp
11-
TODO.md
12-
vendor
13-
.idea
14-
benchmark
1+
# Logs
2+
logs
3+
*.log
4+
5+
# Runtime data
6+
pids
7+
*.pid
8+
*.seed
9+
10+
# Directory for instrumented libs generated by jscoverage/JSCover
11+
lib-cov
12+
13+
# Coverage directory used by tools like istanbul
1514
coverage
15+
16+
# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
17+
.grunt
18+
19+
# Compiled binary addons (http://nodejs.org/api/addons.html)
20+
build/Release
21+
22+
# Dependency directory
23+
# Commenting this out is preferred by some people, see
24+
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git-
25+
node_modules
26+
27+
# Users Environment Variables
28+
.lock-wscript
29+
30+
# Garbage files
31+
.DS_Store

‎.jscsrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"preset": "gulp"
3+
}

‎.jshintrc

-18
This file was deleted.

‎.travis.yml

+7-5
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
sudo: false
22
language: node_js
33
node_js:
4-
- "0.10"
5-
- "0.12"
6-
- "iojs"
7-
git:
8-
depth: 10
4+
- '8'
5+
- '6'
6+
- '4'
7+
- '0.12'
8+
- '0.10'
9+
after_script:
10+
- npm run coveralls

‎.verb.md

-68
This file was deleted.

‎LICENSE

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
The MIT License (MIT)
22

3-
Copyright (c) 2015, Jon Schlinkert.
3+
Copyright (c) 2015 Blaine Bublitz <[email protected]>, Eric Schoffstall <[email protected]> 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
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
99
copies of the Software, and to permit persons to whom the Software is
1010
furnished to do so, subject to the following conditions:
1111

12-
The above copyright notice and this permission notice shall be included in
13-
all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1414

1515
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
1616
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
1717
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,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21-
THE SOFTWARE.
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md

+34-53
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,20 @@
1-
# plugin-error [![NPM version](https://badge.fury.io/js/plugin-error.svg)](http://badge.fury.io/js/plugin-error) [![Build Status](https://travis-ci.org/jonschlinkert/plugin-error.svg)](https://travis-ci.org/jonschlinkert/plugin-error)
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>
26

3-
> Error handling for vinyl plugins. Just an abstraction of what's in gulp-util with minor changes.
7+
# plugin-error
48

5-
Install with [npm](https://www.npmjs.com/)
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]
610

7-
```sh
8-
$ npm i plugin-error --save
9-
```
11+
Error handling for Vinyl plugins.
1012

1113
## Usage
1214

1315
```js
1416
var PluginError = require('plugin-error');
15-
```
16-
17-
### new PluginError(pluginName, message[, options]);
18-
19-
**Params**
20-
21-
* `pluginName` should be the module name of your plugin
22-
* `message` **{String|Object}**: may be a string or an existing error object
23-
* `options` **{Object}**
24-
25-
**Behavior:**
26-
27-
* By default the stack will not be shown. Set `options.showStack` to true if you think the stack is important for your error.
28-
* If you pass an error object as the message the stack will be pulled from that, otherwise one will be created.
29-
* If you pass in a custom stack string you need to include the message along with that.
30-
* Error properties will be included in `err.toString()`, but may be omitted by including `{showProperties: false}` in the options.
3117

32-
**Examples**
33-
34-
All of the following are acceptable forms of instantiation:
35-
36-
```javascript
3718
var err = new PluginError('test', {
3819
message: 'something broke'
3920
});
@@ -45,44 +26,44 @@ var err = new PluginError({
4526

4627
var err = new PluginError('test', 'something broke');
4728

48-
var err = new PluginError('test', 'something broke', {showStack: true});
29+
var err = new PluginError('test', 'something broke', { showStack: true });
4930

5031
var existingError = new Error('OMG');
51-
var err = new PluginError('test', existingError, {showStack: true});
32+
var err = new PluginError('test', existingError, { showStack: true });
5233
```
5334

54-
## Related projects
55-
56-
* [assemble](http://assemble.io): Static site generator for Grunt.js, Yeoman and Node.js. Used by Zurb Foundation, Zurb Ink, H5BP/Effeckt,… [more](http://assemble.io)
57-
* [gulp-util](https://github.com/wearefractal/gulp-util#readme): Utility functions for gulp plugins
58-
* [gulp](http://gulpjs.com): The streaming build system
59-
* [generate](https://github.com/generate/generate): Project generator, for node.js.
60-
* [verb](https://github.com/assemble/verb): Documentation generator for GitHub projects. Extremely powerful, easy to use, can generate anything from API… [more](https://github.com/assemble/verb)
35+
## API
6136

62-
## Running tests
37+
### `new PluginError(pluginName, message[, options])`
6338

64-
Install dev dependencies:
39+
Error constructor that takes:
40+
* `pluginName` - a `String` that should be the module name of your plugin
41+
* `message` - a `String` message or an existing `Error` object
42+
* `options` - an `Object` of your options
6543

66-
```sh
67-
$ npm i -d && npm test
68-
```
69-
70-
## Contributing
44+
**Behavior:**
7145

72-
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/plugin-error/issues/new)
46+
* By default the stack will not be shown. Set `options.showStack` to true if you think the stack is important for your error.
47+
* If you pass an error object as the message the stack will be pulled from that, otherwise one will be created.
48+
* If you pass in a custom stack string you need to include the message along with that.
49+
* Error properties will be included in `err.toString()`, but may be omitted by including `{ showProperties: false }` in the options.
7350

74-
## Author
51+
## License
7552

76-
**Jon Schlinkert**
53+
MIT
7754

78-
+ [github/jonschlinkert](https://github.com/jonschlinkert)
79-
+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)
55+
[downloads-image]: http://img.shields.io/npm/dm/plugin-error.svg
56+
[npm-url]: https://www.npmjs.com/package/plugin-error
57+
[npm-image]: http://img.shields.io/npm/v/plugin-error.svg
8058

81-
## License
59+
[travis-url]: https://travis-ci.org/gulpjs/plugin-error
60+
[travis-image]: http://img.shields.io/travis/gulpjs/plugin-error.svg?label=travis-ci
8261

83-
Copyright © 2015 Jon Schlinkert
84-
Released under the MIT license.
62+
[appveyor-url]: https://ci.appveyor.com/project/gulpjs/plugin-error
63+
[appveyor-image]: https://img.shields.io/appveyor/ci/gulpjs/plugin-error.svg?label=appveyor
8564

86-
***
65+
[coveralls-url]: https://coveralls.io/r/gulpjs/plugin-error
66+
[coveralls-image]: http://img.shields.io/coveralls/gulpjs/plugin-error/master.svg
8767

88-
_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on May 31, 2015._
68+
[gitter-url]: https://gitter.im/gulpjs/gulp
69+
[gitter-image]: https://badges.gitter.im/gulpjs/gulp.svg

‎appveyor.yml

+25
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: "6"
11+
- nodejs_version: "8"
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}"

0 commit comments

Comments
 (0)