getsetdeep - npm Package Compare versions

Comparing version 2.1.0 to 3.0.0

LICENSE.md

@@ -1,10 +0,23 @@
-(The MIT License)
+<!-- LICENSEFILE/ -->
 
-Copyright © 2013+ [Bevry Pty Ltd](http://bevry.me) <[e-mail]>
-Copyright © 2011-2012 [Benjamin Lupton](http://balupton.com) <[e-mail]>
+<h1>License</h1>
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Unless stated otherwise all works are:
 
+<ul><li>Copyright &copy; <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>
+
+and licensed under:
+
+<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
+
+<h2>MIT License</h2>
+
+<pre>
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+</pre>
+
+<!-- /LICENSEFILE -->

package.json

 {
-	"name": "getsetdeep",
-	"version": "2.1.0",
-	"description": "Get and set nested variables of an object, includes support for Backbone Models",
-	"homepage": "https://github.com/bevry/getsetdeep",
-	"keywords": [
-		"setDeep","getDeep","set","get","getter","setter","backbone","backbone.js"
-	],
-	"author": "Bevry Pty Ltd <[e-mail]> (http://bevry.me)",
-	"maintainers": [
-		"Benjamin Lupton <[e-mail]> (https://github.com/balupton)"
-	],
-	"contributors": [
-		"Benjamin Lupton <[e-mail]> (https://github.com/balupton)"
-	],
-	"bugs": {
-		"url": "https://github.com/bevry/getsetdeep/issues"
-	},
-	"repository" : {
-		"type": "git",
-		"url": "http://github.com/bevry/getsetdeep.git"
-	},
-	"engines" : {
-		"node": ">=0.4"
-	},
-	"dependencies": {
-		"typechecker": "~2.0.1"
-	},
-	"devDependencies": {
-		"backbone": "~1.0.0",
-		"chai": "~1.5.0",
-		"coffee-script": "~1.6.2",
-		"joe": "~1.2.0",
-		"joe-reporter-console": "~1.2.1"
-	},
-	"directories": {
-		"lib": "./out/lib"
-	},
-	"scripts": {
-		"test": "node ./out/test/getsetdeep-test.js"
-	},
-	"main": "./out/lib/getsetdeep.js"
-}
+  "name": "getsetdeep",
+  "version": "3.0.0",
+  "description": "Get and set nested variables of an object, includes support for Backbone Models",
+  "homepage": "https://github.com/bevry/getsetdeep",
+  "license": "MIT",
+  "keywords": [
+    "setDeep",
+    "getDeep",
+    "set",
+    "get",
+    "getter",
+    "setter",
+    "backbone",
+    "backbone.js"
+  ],
+  "badges": {
+    "list": [
+      "travisci",
+      "npmversion",
+      "npmdownloads",
+      "daviddm",
+      "daviddmdev",
+      "---",
+      "patreon",
+      "opencollective",
+      "gratipay",
+      "flattr",
+      "paypal",
+      "bitcoin",
+      "wishlist",
+      "---",
+      "slackin"
+    ],
+    "config": {
+      "patreonUsername": "bevry",
+      "opencollectiveUsername": "bevry",
+      "gratipayUsername": "bevry",
+      "flattrUsername": "balupton",
+      "paypalURL": "https://bevry.me/paypal",
+      "bitcoinURL": "https://bevry.me/bitcoin",
+      "wishlistURL": "https://bevry.me/wishlist",
+      "slackinURL": "https://slack.bevry.me"
+    }
+  },
+  "author": "Bevry Pty Ltd <[e-mail]> (http://bevry.me)",
+  "maintainers": [
+    "Benjamin Lupton <[e-mail]> (http://balupton.com)"
+  ],
+  "contributors": [
+    "Benjamin Lupton <[e-mail]> (http://balupton.com)",
+    "Sean Fridman <[e-mail]> (http://seanfridman.com)"
+  ],
+  "bugs": {
+    "url": "https://github.com/bevry/getsetdeep/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bevry/getsetdeep.git"
+  },
+  "engines": {
+    "node": ">=0.8"
+  },
+  "editions": [
+    {
+      "description": "Source + ESNext + Require",
+      "directory": "source",
+      "entry": "index.js",
+      "syntaxes": [
+        "javascript",
+        "esnext",
+        "require"
+      ]
+    },
+    {
+      "description": "Babel Compiled + ES2015 + Require",
+      "directory": "es2015",
+      "entry": "index.js",
+      "syntaxes": [
+        "javascript",
+        "es2015",
+        "require"
+      ]
+    }
+  ],
+  "main": "index.js",
+  "browser": "es2015/index.js",
+  "dependencies": {
+    "editions": "^1.3.3",
+    "typechecker": "~2.0.1"
+  },
+  "devDependencies": {
+    "assert-helpers": "^4.5.0",
+    "babel-cli": "^6.26.0",
+    "babel-preset-es2015": "^6.24.1",
+    "backbone": "~1.0.0",
+    "eslint": "^4.16.0",
+    "joe": "^2.0.2",
+    "joe-reporter-console": "^2.0.1",
+    "projectz": "^1.4.0"
+  },
+  "scripts": {
+    "our:setup": "npm run our:setup:npm",
+    "our:setup:npm": "npm install",
+    "our:clean": "rm -Rf ./docs ./es2015 ./es5 ./out",
+    "our:compile": "npm run our:compile:es2015",
+    "our:compile:es2015": "babel ./source --out-dir ./es2015 --presets es2015",
+    "our:meta": "npm run our:meta:projectz",
+    "our:meta:projectz": "projectz compile",
+    "our:verify": "npm run our:verify:eslint",
+    "our:verify:eslint": "eslint --fix ./source",
+    "our:test": "npm run our:verify && npm test",
+    "our:release": "npm run our:release:prepare && npm run our:release:check && npm run our:release:tag && npm run our:release:push",
+    "our:release:prepare": "npm run our:clean && npm run our:compile && npm run our:test && npm run our:meta",
+    "our:release:check": "npm run our:release:check:changelog && npm run our:release:check:dirty",
+    "our:release:check:changelog": "cat ./HISTORY.md | grep v$npm_package_version || (echo add a changelog entry for v$npm_package_version && exit -1)",
+    "our:release:check:dirty": "git diff --exit-code",
+    "our:release:tag": "export MESSAGE=$(cat ./HISTORY.md | sed -n \"/## v$npm_package_version/,/##/p\" | sed 's/## //' | awk 'NR>1{print buf}{buf = $0}') && test \"$MESSAGE\" || (echo 'proper changelog entry not found' && exit -1) && git tag v$npm_package_version -am \"$MESSAGE\"",
+    "our:release:push": "git push origin master && git push origin --tags",
+    "test": "node --harmony ./test.js --joe-reporter=console"
+  }
+}

README.md

@@ -1,23 +0,66 @@
-# Get Set Deep
+<!-- TITLE/ -->
 
-[![Build Status](https://secure.travis-ci.org/bevry/getsetdeep.png?branch=master)](http://travis-ci.org/bevry/getsetdeep)
-[![NPM version](https://badge.fury.io/js/getsetdeep.png)](https://npmjs.org/package/getsetdeep)
-[![Flattr this project](http://api.flattr.com/button/flattr-badge-large.png)](http://flattr.com/thing/344188/balupton-on-Flattr)
+<h1>getsetdeep</h1>
 
+<!-- /TITLE -->
+
+
+<!-- BADGES/ -->
+
+<span class="badge-travisci"><a href="http://travis-ci.org/bevry/getsetdeep" title="Check this project's build status on TravisCI"><img src="https://img.shields.io/travis/bevry/getsetdeep/master.svg" alt="Travis CI Build Status" /></a></span>
+<span class="badge-npmversion"><a href="https://npmjs.org/package/getsetdeep" title="View this project on NPM"><img src="https://img.shields.io/npm/v/getsetdeep.svg" alt="NPM version" /></a></span>
+<span class="badge-npmdownloads"><a href="https://npmjs.org/package/getsetdeep" title="View this project on NPM"><img src="https://img.shields.io/npm/dm/getsetdeep.svg" alt="NPM downloads" /></a></span>
+<span class="badge-daviddm"><a href="https://david-dm.org/bevry/getsetdeep" title="View the status of this project's dependencies on DavidDM"><img src="https://img.shields.io/david/bevry/getsetdeep.svg" alt="Dependency Status" /></a></span>
+<span class="badge-daviddmdev"><a href="https://david-dm.org/bevry/getsetdeep#info=devDependencies" title="View the status of this project's development dependencies on DavidDM"><img src="https://img.shields.io/david/dev/bevry/getsetdeep.svg" alt="Dev Dependency Status" /></a></span>
+<br class="badge-separator" />
+<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
+<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
+<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
+<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
+<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
+<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
+<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
+<br class="badge-separator" />
+<span class="badge-slackin"><a href="https://slack.bevry.me" title="Join this project's slack community"><img src="https://slack.bevry.me/badge.svg" alt="Slack community badge" /></a></span>
+
+<!-- /BADGES -->
+
+
+<!-- DESCRIPTION/ -->
+
 Get and set nested variables of an object, includes support for Backbone Models
 
+<!-- /DESCRIPTION -->
 
-## Install
 
-### Backend
+<!-- INSTALL/ -->
 
-1. [Install Node.js](http://bevry.me/node/install)
-2. `npm install --save getsetdeep`
+<h2>Install</h2>
 
-### Frontend
+<a href="https://npmjs.com" title="npm is a package manager for javascript"><h3>NPM</h3></a><ul>
+<li>Install: <code>npm install --save getsetdeep</code></li>
+<li>Module: <code>require('getsetdeep')</code></li></ul>
 
-1. [See Browserify](http://browserify.org)
+<a href="http://browserify.org" title="Browserify lets you require('modules') in the browser by bundling up all of your dependencies"><h3>Browserify</h3></a><ul>
+<li>Install: <code>npm install --save getsetdeep</code></li>
+<li>Module: <code>require('getsetdeep')</code></li>
+<li>CDN URL: <code>//wzrd.in/bundle/getsetdeep@3.0.0</code></li></ul>
 
+<a href="http://enderjs.com" title="Ender is a full featured package manager for your browser"><h3>Ender</h3></a><ul>
+<li>Install: <code>ender add getsetdeep</code></li>
+<li>Module: <code>require('getsetdeep')</code></li></ul>
 
+<h3><a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a></h3>
 
+<p>This package is published with the following editions:</p>
+
+<ul><li><code>getsetdeep</code> aliases <code>getsetdeep/index.js</code> which uses <a href="https://github.com/bevry/editions" title="Editions are the best way to produce and consume packages you care about.">Editions</a> to automatically select the correct edition for the consumers environment</li>
+<li><code>getsetdeep/source/index.js</code> is Source + <a href="https://babeljs.io/docs/learn-es2015/" title="ECMAScript Next">ESNext</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li>
+<li><code>getsetdeep/es2015/index.js</code> is <a href="https://babeljs.io" title="The compiler for writing next generation JavaScript">Babel</a> Compiled + <a href="http://babeljs.io/docs/plugins/preset-es2015/" title="ECMAScript 2015">ES2015</a> + <a href="https://nodejs.org/dist/latest-v5.x/docs/api/modules.html" title="Node/CJS Modules">Require</a></li></ul>
+
+<p>Older environments may need <a href="https://babeljs.io/docs/usage/polyfill/" title="A polyfill that emulates missing ECMAScript environment features">Babel's Polyfill</a> or something similar.</p>
+
+<!-- /INSTALL -->
+
+
 ## Usage
@@ -29,6 +72,6 @@
 // Import
-var getsetdeep = require('getsetdeep');
+const getsetdeep = require('getsetdeep');
 
 // Prepare
-var obj = {
+const obj = {
 	a: {
@@ -54,11 +97,66 @@ b: {
 
+<!-- HISTORY/ -->
 
-## History
-You can discover the history inside the [History.md](https://github.com/bevry/getsetdeep/blob/master/History.md#files) file
+<h2>History</h2>
 
+<a href="https://github.com/bevry/getsetdeep/blob/master/HISTORY.md#files">Discover the release history by heading on over to the <code>HISTORY.md</code> file.</a>
 
+<!-- /HISTORY -->
 
-## License
-Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT License](http://creativecommons.org/licenses/MIT/)
-<br/>Copyright © 2013+ [Bevry Pty Ltd](http://bevry.me)
-<br/>Copyright © 2011-2012 [Benjamin Arthur Lupton](http://balupton.com)
+
+<!-- CONTRIBUTE/ -->
+
+<h2>Contribute</h2>
+
+<a href="https://github.com/bevry/getsetdeep/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
+
+<!-- /CONTRIBUTE -->
+
+
+<!-- BACKERS/ -->
+
+<h2>Backers</h2>
+
+<h3>Maintainers</h3>
+
+These amazing people are maintaining this project:
+
+<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/getsetdeep/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/getsetdeep">view contributions</a></li></ul>
+
+<h3>Sponsors</h3>
+
+No sponsors yet! Will you be the first?
+
+<span class="badge-patreon"><a href="https://patreon.com/bevry" title="Donate to this project using Patreon"><img src="https://img.shields.io/badge/patreon-donate-yellow.svg" alt="Patreon donate button" /></a></span>
+<span class="badge-opencollective"><a href="https://opencollective.com/bevry" title="Donate to this project using Open Collective"><img src="https://img.shields.io/badge/open%20collective-donate-yellow.svg" alt="Open Collective donate button" /></a></span>
+<span class="badge-gratipay"><a href="https://www.gratipay.com/bevry" title="Donate weekly to this project using Gratipay"><img src="https://img.shields.io/badge/gratipay-donate-yellow.svg" alt="Gratipay donate button" /></a></span>
+<span class="badge-flattr"><a href="https://flattr.com/profile/balupton" title="Donate to this project using Flattr"><img src="https://img.shields.io/badge/flattr-donate-yellow.svg" alt="Flattr donate button" /></a></span>
+<span class="badge-paypal"><a href="https://bevry.me/paypal" title="Donate to this project using Paypal"><img src="https://img.shields.io/badge/paypal-donate-yellow.svg" alt="PayPal donate button" /></a></span>
+<span class="badge-bitcoin"><a href="https://bevry.me/bitcoin" title="Donate once-off to this project using Bitcoin"><img src="https://img.shields.io/badge/bitcoin-donate-yellow.svg" alt="Bitcoin donate button" /></a></span>
+<span class="badge-wishlist"><a href="https://bevry.me/wishlist" title="Buy an item on our wishlist for us"><img src="https://img.shields.io/badge/wishlist-donate-yellow.svg" alt="Wishlist browse button" /></a></span>
+
+<h3>Contributors</h3>
+
+These amazing people have contributed code to this project:
+
+<ul><li><a href="http://balupton.com">Benjamin Lupton</a> — <a href="https://github.com/bevry/getsetdeep/commits?author=balupton" title="View the GitHub contributions of Benjamin Lupton on repository bevry/getsetdeep">view contributions</a></li>
+<li><a href="http://seanfridman.com">Sean Fridman</a> — <a href="https://github.com/bevry/getsetdeep/commits?author=sfrdmn" title="View the GitHub contributions of Sean Fridman on repository bevry/getsetdeep">view contributions</a></li></ul>
+
+<a href="https://github.com/bevry/getsetdeep/blob/master/CONTRIBUTING.md#files">Discover how you can contribute by heading on over to the <code>CONTRIBUTING.md</code> file.</a>
+
+<!-- /BACKERS -->
+
+
+<!-- LICENSE/ -->
+
+<h2>License</h2>
+
+Unless stated otherwise all works are:
+
+<ul><li>Copyright &copy; <a href="http://bevry.me">Bevry Pty Ltd</a></li></ul>
+
+and licensed under:
+
+<ul><li><a href="http://spdx.org/licenses/MIT.html">MIT License</a></li></ul>
+
+<!-- /LICENSE -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

New author

Supply chain risk

A new npm collaborator published a version of the package for the first time. New collaborators are usually benign additions to a project, but do indicate a change to the security surface area of a package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

19691

increased by222.49%

Number of package files

7

increased by16.67%

Lines of code

171

increased by111.11%

Number of lines in readme file

161

increased by155.56%

Worsened metrics

Dependency count

2

increased by100%

Dev dependency count

8

increased by60%

Number of medium supply chain risk alerts

2

increased byInfinity%

Dependency changes

• + Addededitions@^1.3.3

• + Addededitions@1.3.4(transitive)