UNPKG

canonical

Version:

Canonical code style linter and formatter for JavaScript, SCSS and CSS.

80 lines (79 loc) 4.92 kB
{ "_args": [ [ "write@https://registry.npmjs.org/write/-/write-0.2.1.tgz", "/Users/gajus/Documents/dev/canonical-code-style/canonical" ] ], "_from": "write@>=0.2.1 <0.3.0", "_id": "write@0.2.1", "_inCache": true, "_location": "/write", "_phantomChildren": {}, "_requested": { "name": "write", "raw": "write@https://registry.npmjs.org/write/-/write-0.2.1.tgz", "rawSpec": "https://registry.npmjs.org/write/-/write-0.2.1.tgz", "scope": null, "spec": "https://registry.npmjs.org/write/-/write-0.2.1.tgz", "type": "remote" }, "_requiredBy": [ "/flat-cache" ], "_resolved": "https://registry.npmjs.org/write/-/write-0.2.1.tgz", "_shasum": "5fc03828e264cea3fe91455476f7a3c566cb0757", "_shrinkwrap": null, "_spec": "write@https://registry.npmjs.org/write/-/write-0.2.1.tgz", "_where": "/Users/gajus/Documents/dev/canonical-code-style/canonical", "author": { "name": "Jon Schlinkert", "url": "https://github.com/jonschlinkert" }, "bugs": { "url": "https://github.com/jonschlinkert/write/issues" }, "dependencies": { "mkdirp": "^0.5.1" }, "description": "Write files to disk, creating intermediate directories if they don't exist.", "devDependencies": { "async": "^1.4.0", "delete": "^0.2.1", "mocha": "^2.2.5", "should": "^7.0.2" }, "engines": { "node": ">=0.10.0" }, "files": [ "index.js" ], "homepage": "https://github.com/jonschlinkert/write", "keywords": [ "file", "filepath", "files", "filesystem", "folder", "fs", "fs.writeFile", "fs.writeFileSync", "path", "write" ], "license": "MIT", "main": "index.js", "name": "write", "optionalDependencies": {}, "readme": "# write [![NPM version](https://badge.fury.io/js/write.svg)](http://badge.fury.io/js/write) [![Build Status](https://travis-ci.org/jonschlinkert/write.svg)](https://travis-ci.org/jonschlinkert/write)\n\n> Write files to disk, creating intermediate directories if they don't exist.\n\nInstall with [npm](https://www.npmjs.com/)\n\n```sh\n$ npm i write --save\n```\n\n## API docs\n\n### [writeFile](index.js#L32)\n\nAsynchronously write a file to disk. Creates any intermediate directories if they don't already exist.\n\n**Params**\n\n* `dest` **{String}**: Destination file path\n* `str` **{String}**: String to write to disk.\n* `callback` **{Function}**\n\n**Example**\n\n```js\nvar writeFile = require('write');\nwriteFile('foo.txt', 'This is content to write.', function(err) {\n if (err) console.log(err);\n});\n```\n\n### [.writeFile.sync](index.js#L64)\n\nSynchronously write files to disk. Creates any intermediate directories if they don't already exist.\n\n**Params**\n\n* `dest` **{String}**: Destination file path\n* `str` **{String}**: String to write to disk.\n\n**Example**\n\n```js\nvar writeFile = require('write');\nwriteFile.sync('foo.txt', 'This is content to write.');\n```\n\n### [.writeFile.stream](index.js#L87)\n\nUses `fs.createWriteStream`, but also creates any intermediate directories if they don't already exist.\n\n**Params**\n\n* `dest` **{String}**: Destination file path\n* `returns` **{Stream}**: Returns a write stream.\n\n**Example**\n\n```js\nvar write = require('write');\nwrite.stream('foo.txt');\n```\n\n## Related\n\n* [delete](https://github.com/jonschlinkert/delete): Delete files and folders and any intermediate directories if they exist (sync and async).\n* [read-yaml](https://github.com/jonschlinkert/read-yaml): Very thin wrapper around js-yaml for directly reading in YAML files.\n* [read-json](https://github.com/azer/read-json): Reads and parses a JSON file.\n* [read-data](https://github.com/jonschlinkert/read-data): Read JSON or YAML files.\n* [write-yaml](https://github.com/jonschlinkert/write-yaml): Write YAML. Converts JSON to YAML writes it to the specified file.\n* [write-json](https://github.com/jonschlinkert/write-json): Write a JSON to file disk, also creates directories in the dest path if they… [more](https://github.com/jonschlinkert/write-json)\n\n## Running tests\n\nInstall dev dependencies:\n\n```sh\n$ npm i -d && npm test\n```\n\n## Contributing\n\nPull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/write/issues/new)\n\n## Author\n\n**Jon Schlinkert**\n\n+ [github/jonschlinkert](https://github.com/jonschlinkert)\n+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert)\n\n## License\n\nCopyright © 2015 Jon Schlinkert\nReleased under the MIT license.\n\n***\n\n_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on July 29, 2015._\n\n<!-- deps:mocha -->", "readmeFilename": "README.md", "repository": { "type": "git", "url": "git+https://github.com/jonschlinkert/write.git" }, "scripts": { "test": "mocha" }, "version": "0.2.1" }