Comparing version 0.0.1 to 1.0.0
{ | ||
"name": "mask-json", | ||
"version": "0.0.1", | ||
"version": "1.0.0", | ||
"repository": { | ||
@@ -9,3 +9,2 @@ "type": "git", | ||
"description": "Redacts values in objects.", | ||
"main": "./dist/index.js", | ||
"keywords": [ | ||
@@ -27,29 +26,15 @@ "mask", | ||
"license": "SEE LICENSE IN LICENSE", | ||
"options": { | ||
"changelog": "-o seegno -r mask-json --only-pulls --use-commit-body --title 'Changelog' --date-format '/ YYYY-MM-DD'", | ||
"mocha": "--compilers js:babel-core/register --recursive test" | ||
}, | ||
"scripts": { | ||
"build": "rm -rf dist/* && babel src/ --out-dir dist/", | ||
"changelog": "github-changes $npm_package_options_changelog", | ||
"lint": "eslint src test && jscs src test", | ||
"test": "NODE_ENV=test mocha $npm_package_options_mocha" | ||
"changelog": "github-changelog-generator --future-release=$npm_package_version --owner=seegno --repo=mask-json > CHANGELOG.md", | ||
"lint": "eslint src test", | ||
"test": "NODE_ENV=test mocha test", | ||
"version": "npm run changelog --future-release=$npm_package_version && git add -A CHANGELOG.md" | ||
}, | ||
"dependencies": { | ||
"lodash": "^3.1.0" | ||
"lodash": "^4.17.4" | ||
}, | ||
"devDependencies": { | ||
"babel-cli": "^6.1.1", | ||
"babel-core": "^6.2.1", | ||
"babel-eslint": "^4.1.3", | ||
"babel-plugin-add-module-exports": "^0.0.4", | ||
"babel-plugin-transform-es2015-modules-commonjs": "^6.1.3", | ||
"babel-plugin-transform-export-extensions": "^6.1.4", | ||
"babel-plugin-transform-strict-mode": "^6.1.4", | ||
"eslint": "^1.8.0", | ||
"eslint-config-seegno": "^1.1.1", | ||
"eslint-plugin-babel": "^2.1.1", | ||
"github-changes": "^1.0.0", | ||
"jscs": "^2.5.0", | ||
"jscs-config-seegno": "^1.0.1", | ||
"@uphold/github-changelog-generator": "^0.4.1", | ||
"eslint": "^3.18.0", | ||
"eslint-config-seegno": "^9.0.0", | ||
"mocha": "^2.0.1", | ||
@@ -56,0 +41,0 @@ "pre-commit": "^1.0.10", |
@@ -7,9 +7,7 @@ # mask-json | ||
[![npm version][npm-image]][npm-url] | ||
[![npm downloads][downloads-image]][downloads-url] | ||
[![build status][travis-image]][travis-url] | ||
[![npm version][npm-image]][downloads-url] [![npm downloads][downloads-image]][downloads-url] [![build status][travis-image]][travis-url] | ||
## Installation | ||
Install the package via `npm`: | ||
Install the package via `npm`: | ||
@@ -22,18 +20,19 @@ ``` | ||
#### Arguments | ||
### Arguments | ||
1. `collection` *(Array)*: An array of keys to redact. | ||
2. `[options]` *(Object)*: An optional object with the following options: | ||
1. `collection` _(Array)_: An array of keys to redact. | ||
2. `[options]` _(Object)_: An optional object with the following options: | ||
| Option | Default value | Description | | ||
|---------------|----------------|------------------------------| | ||
| _replacement_ | _--REDACTED--_ | The default value to replace | | ||
Option | Default value | Description | ||
------------- | -------------- | ----------------------------------------------------- | ||
_ignoreCase_ | false | Whether to ignore case sensitivity when matching keys | ||
_replacement_ | _--REDACTED--_ | The default value to replace | ||
#### Returns | ||
### Returns | ||
*(Function)*: Returns a function that will redact values from a given object. | ||
_(Function)_: Returns a function that will redact values from a given object. | ||
#### Example | ||
### Example | ||
```js | ||
```javascript | ||
var blacklist = ['password', 'secret']; | ||
@@ -49,6 +48,12 @@ var maskJson = require('mask-json')(blacklist); | ||
```js | ||
```javascript | ||
$ npm test | ||
``` | ||
## Release | ||
```sh | ||
npm version [<new version> | major | minor | patch] -m "Release %s" | ||
``` | ||
## License | ||
@@ -62,3 +67,3 @@ | ||
[npm-url]: https://npmjs.org/package/mask-json | ||
[travis-image]: https://travis-ci.org/seegno/mask-json.svg | ||
[travis-image]: https://img.shields.io/travis/seegno/mask-json.svg | ||
[travis-url]: https://travis-ci.org/seegno/mask-json |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
6
0
66
5442
5
30
+ Addedlodash@4.17.21(transitive)
- Removedlodash@3.10.1(transitive)
Updatedlodash@^4.17.4