UNPKG

motion

Version:

motion - moving development forward

github.com/motion/motion

motion/motion

80 lines (79 loc) • 3.45 kB
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
{ "_args": [ [ "vinyl-file@https://registry.npmjs.org/vinyl-file/-/vinyl-file-1.3.0.tgz", "/Users/nw/flint/packages/flint" ] ], "_from": "vinyl-file@>=1.2.1 <2.0.0", "_id": "vinyl-file@1.3.0", "_inCache": true, "_location": "/vinyl-file", "_phantomChildren": {}, "_requested": { "name": "vinyl-file", "raw": "vinyl-file@https://registry.npmjs.org/vinyl-file/-/vinyl-file-1.3.0.tgz", "rawSpec": "https://registry.npmjs.org/vinyl-file/-/vinyl-file-1.3.0.tgz", "scope": null, "spec": "https://registry.npmjs.org/vinyl-file/-/vinyl-file-1.3.0.tgz", "type": "remote" }, "_requiredBy": [ "/gulp-watch" ], "_resolved": "https://registry.npmjs.org/vinyl-file/-/vinyl-file-1.3.0.tgz", "_shasum": "aa05634d3a867ba91447bedbb34afcb26f44f6e7", "_shrinkwrap": null, "_spec": "vinyl-file@https://registry.npmjs.org/vinyl-file/-/vinyl-file-1.3.0.tgz", "_where": "/Users/nw/flint/packages/flint", "author": { "email": "sindresorhus@gmail.com", "name": "Sindre Sorhus", "url": "sindresorhus.com" }, "bugs": { "url": "https://github.com/sindresorhus/vinyl-file/issues" }, "dependencies": { "graceful-fs": "^4.1.2", "strip-bom": "^2.0.0", "strip-bom-stream": "^1.0.0", "vinyl": "^1.1.0" }, "description": "Create a vinyl file from an actual file", "devDependencies": { "ava": "0.0.4", "is-stream": "^1.0.0", "xo": "*" }, "engines": { "node": ">=0.10.0" }, "files": [ "index.js" ], "homepage": "https://github.com/sindresorhus/vinyl-file#readme", "keywords": [ "file", "format", "fs", "gulp", "gulpfriendly", "read", "vinyl", "virtual" ], "license": "MIT", "name": "vinyl-file", "optionalDependencies": {}, "readme": "# vinyl-file [![Build Status](https://travis-ci.org/sindresorhus/vinyl-file.svg?branch=master)](https://travis-ci.org/sindresorhus/vinyl-file)\n\n> Create a [vinyl file](https://github.com/wearefractal/vinyl) from an actual file\n\n\n## Install\n\n```\n$ npm install --save vinyl-file\n```\n\n\n## Usage\n\n```js\nconst vinylFile = require('vinyl-file');\nconst file = vinylFile.readSync('index.js');\n\nconsole.log(file.path);\n//=> '/Users/sindresorhus/dev/vinyl-file/index.js'\n\nconsole.log(file.cwd);\n//=> '/Users/sindresorhus/dev/vinyl-file'\n```\n\n\n## API\n\n### read(path, [options], callback)\n\nCreate a vinyl file and pass it to the callback.\n\n### readSync(path, [options])\n\nCreate a vinyl file synchronously and return it.\n\n#### options\n\n##### base\n\nType: `string` \nDefault: `process.cwd()`\n\nOverride the `base` of the vinyl file.\n\n##### cwd\n\nType: `string` \nDefault: `process.cwd()`\n\nOverride the `cwd` (current working directory) of the vinyl file.\n\n##### buffer\n\nType: `boolean` \nDefault: `true`\n\nSetting this to `false` will return `file.contents` as a stream. This is useful when working with large files. **Note:** Plugins might not implement support for streams.\n\n##### read\n\nType: `boolean` \nDefault: `true`\n\nSetting this to `false` will return `file.contents` as null and not read the file at all.\n\n\n## License\n\nMIT © [Sindre Sorhus](http://sindresorhus.com)\n", "readmeFilename": "readme.md", "repository": { "type": "git", "url": "git+https://github.com/sindresorhus/vinyl-file.git" }, "scripts": { "test": "xo && node test.js" }, "version": "1.3.0" }