-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
52 lines (52 loc) · 4.09 KB
/
package.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
{
"name": "vinyl",
"description": "A virtual file format",
"version": "0.4.3",
"homepage": "http://github.com/wearefractal/vinyl",
"repository": {
"type": "git",
"url": "git://github.com/wearefractal/vinyl.git"
},
"author": {
"name": "Fractal",
"email": "contact@wearefractal.com",
"url": "http://wearefractal.com/"
},
"main": "./index.js",
"dependencies": {
"clone-stats": "^0.0.1",
"lodash": "^2.4.1"
},
"devDependencies": {
"mocha": "^1.17.0",
"should": "^4.0.4",
"mocha-lcov-reporter": "^0.0.1",
"coveralls": "^2.6.1",
"istanbul": "^0.3.0",
"rimraf": "^2.2.5",
"jshint": "^2.4.1",
"buffer-equal": "0.0.1",
"lodash.templatesettings": "^2.4.1",
"event-stream": "^3.1.0"
},
"scripts": {
"test": "istanbul cover node_modules/mocha/bin/_mocha -- --reporter spec && jshint .",
"coveralls": "istanbul cover _mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | coveralls && rm -rf ./coverage"
},
"engines": {
"node": ">= 0.9"
},
"licenses": [
{
"type": "MIT",
"url": "http://github.com/wearefractal/vinyl/raw/master/LICENSE"
}
],
"readme": "# vinyl [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Dependency Status](https://david-dm.org/wearefractal/vinyl.png?theme=shields.io)](https://david-dm.org/wearefractal/vinyl)\n\n\n## Information\n\n<table>\n<tr> \n<td>Package</td><td>vinyl</td>\n</tr>\n<tr>\n<td>Description</td>\n<td>A virtual file format</td>\n</tr>\n<tr>\n<td>Node Version</td>\n<td>>= 0.9</td>\n</tr>\n</table>\n\n## What is this?\n\nRead this for more info about how this plays into the grand scheme of things https://medium.com/@eschoff/3828e8126466\n\n## File\n\n```javascript\nvar File = require('vinyl');\n\nvar coffeeFile = new File({\n cwd: \"/\",\n base: \"/test/\",\n path: \"/test/file.coffee\",\n contents: new Buffer(\"test = 123\")\n});\n```\n\n### constructor(options)\n\n#### options.cwd\n\nType: `String` \nDefault: `process.cwd()`\n\n#### options.base\n\nUsed for relative pathing. Typically where a glob starts.\n\nType: `String` \nDefault: `options.cwd`\n\n#### options.path\n\nFull path to the file.\n\nType: `String` \nDefault: `null`\n\n#### options.stat\n\nThe result of an fs.stat call. See [fs.Stats](http://nodejs.org/api/fs.html#fs_class_fs_stats) for more information.\n\nType: `fs.Stats` \nDefault: `null`\n\n#### options.contents\n\nFile contents.\n\nType: `Buffer, Stream, or null` \nDefault: `null`\n\n### isBuffer()\n\nReturns true if file.contents is a Buffer.\n\n### isStream()\n\nReturns true if file.contents is a Stream.\n\n### isNull()\n\nReturns true if file.contents is null.\n\n### clone()\n\nReturns a new File object with all attributes cloned. Custom attributes are deep-cloned.\n\n### pipe(stream[, opt])\n\nIf file.contents is a Buffer, it will write it to the stream.\n\nIf file.contents is a Stream, it will pipe it to the stream.\n\nIf file.contents is null, it will do nothing.\n\nIf opt.end is false, the destination stream will not be ended (same as node core).\n\nReturns the stream.\n\n### inspect()\n\nReturns a pretty String interpretation of the File. Useful for console.log.\n\n### relative\n\nReturns path.relative for the file base and file path.\n\nExample:\n\n```javascript\nvar file = new File({\n cwd: \"/\",\n base: \"/test/\",\n path: \"/test/file.coffee\"\n});\n\nconsole.log(file.relative); // file.coffee\n```\n\n[npm-url]: https://npmjs.org/package/vinyl\n[npm-image]: https://badge.fury.io/js/vinyl.png\n[travis-url]: https://travis-ci.org/wearefractal/vinyl\n[travis-image]: https://travis-ci.org/wearefractal/vinyl.png?branch=master\n[coveralls-url]: https://coveralls.io/r/wearefractal/vinyl\n[coveralls-image]: https://coveralls.io/repos/wearefractal/vinyl/badge.png\n[depstat-url]: https://david-dm.org/wearefractal/vinyl\n[depstat-image]: https://david-dm.org/wearefractal/vinyl.png\n",
"readmeFilename": "README.md",
"bugs": {
"url": "https://github.com/wearefractal/vinyl/issues"
},
"_id": "vinyl@0.4.3",
"_from": "vinyl@^0.4.0"
}