blob: 1df3137871163687ee640556e2a2df44594b39e8 (
plain)
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
|
# stringify-package [](https://npm.im/stringify-package) [](https://npm.im/stringify-package) [](https://travis-ci.org/npm/stringify-package) [](https://ci.appveyor.com/project/npm/stringify-package) [](https://coveralls.io/github/npm/stringify-package?branch=latest)
[`stringify-package`](https://github.com/npm/stringify-package) is a standalone
library for writing out package data as a JSON file. It is extracted from npm.
## Install
`$ npm install stringify-package`
## Table of Contents
* [Example](#example)
* [Features](#features)
* [Contributing](#contributing)
* [API](#api)
* [`stringifyPackage`](#stringifypackage)
### Example
```javascript
const fs = require('fs')
const pkg = { /* ... */ }
fs.writeFile('package.json', stringifyPackage(pkg), 'utf8', cb(err) => {
// ...
})
```
### Features
* Ensures consistent file indentation
To match existing file indentation,
[`detect-indent`](https://npm.im/detect-indent) is recommended.
* Ensures consistent newlines
To match existing newline characters,
[`detect-newline`](https://npm.im/detect-newline) is recommended.
### Contributing
The npm team enthusiastically welcomes contributions and project participation!
There's a bunch of things you can do if you want to contribute! The [Contributor
Guide](CONTRIBUTING.md) has all the information you need for everything from
reporting bugs to contributing entire new features. Please don't hesitate to
jump in if you'd like to, or even ask us questions if something isn't clear.
### API
### <a name="stringifypackage"></a> `> stringifyPackage(data, indent, newline) -> String`
#### Arguments
* `data` - the package data as an object to be stringified
* `indent` - the number of spaces to use for each level of indentation (defaults to 2)
* `newline` - the character(s) to be used as a line terminator
|
