lazy-cache
Advanced tools
lazy-cache - npm Package Compare versions
Comparing version 2.0.1 to 2.0.2
| { | ||
| "name": "lazy-cache", | ||
| "description": "Cache requires to be lazy-loaded when needed.", | ||
| "version": "2.0.1", | ||
| "version": "2.0.2", | ||
| "homepage": "https://github.com/jonschlinkert/lazy-cache", | ||
| "author": "Jon Schlinkert (https://github.com/jonschlinkert)", | ||
| "contributors": [ | ||
| "Brian Woodward <brian.woodward@gmail.com> (https://github.com/doowb)", | ||
| "Jon Schlinkert <jon.schlinkert@sellside.com> (http://twitter.com/jonschlinkert)" | ||
| ], | ||
| "repository": "jonschlinkert/lazy-cache", | ||
@@ -22,2 +26,5 @@ "bugs": { | ||
| }, | ||
| "dependencies": { | ||
| "set-getter": "^0.1.0" | ||
| }, | ||
| "devDependencies": { | ||
@@ -62,6 +69,3 @@ "ansi-cyan": "^0.1.1", | ||
| ] | ||
| }, | ||
| "dependencies": { | ||
| "set-getter": "^0.1.0" | ||
| } | ||
| } |
@@ -1,2 +0,2 @@ | ||
| # lazy-cache [](https://www.npmjs.com/package/lazy-cache) [](https://npmjs.org/package/lazy-cache) [](https://travis-ci.org/jonschlinkert/lazy-cache) | ||
| # lazy-cache [](https://www.npmjs.com/package/lazy-cache) [](https://npmjs.org/package/lazy-cache) [](https://npmjs.org/package/lazy-cache) [](https://travis-ci.org/jonschlinkert/lazy-cache) | ||
@@ -10,8 +10,40 @@ > Cache requires to be lazy-loaded when needed. | ||
| ```sh | ||
| $ npm install lazy-cache --save | ||
| $ npm install --save lazy-cache | ||
| ``` | ||
| ## Heads up! | ||
| It's suprising how many libraries are in the average dependency tree that don't belong there for one reason or another. Either because they were accidentally listed as `dependencies` instead of `devDepedencies`, or they are required in a file as variables, but the variable is never actually used (poor linting), and so on. Or because the maintainer made the decision to add the deps, even though they will never ([or can't ever](https://github.com/felixge/node-dateformat/issues/36)) be used by 99.9% of users. | ||
| Worse, many libraries like chalk and [shelljs](https://github.com/eslint/eslint/issues/7316) actually execute code when `require()` is called!? (shelljs was modifying the `String.prototype`, and chalk loops over some objects to dynamically create methods). In other words, they do something like this: | ||
| ```js | ||
| // in the main export of a library, if you do this it will | ||
| // automatically modify the String.prototype _globally_, | ||
| // the moment node.js loads the dependency tree | ||
| String.prototype.foo = function() {}; | ||
| // same if you do something like this | ||
| // (dont' do this, ever. wrap this kind of code in a function | ||
| // and allow implementors to decide when to call it) | ||
| while (foo) { | ||
| // do stuff | ||
| } | ||
| ``` | ||
| In any case, just having these libraries in your dependency tree somewhere means that their code will excecute the moment you run your application _even if the libraries are never called by your application or any other code anywhere in the tree_. | ||
| **solution** | ||
| lazy-cache doesn't use any "magic", it uses native, plain-vanilla, tried and true javascript getters to call node's `require()` system. | ||
| **Faster, safer code** | ||
| There main advantage to this, the main is that `require`s are loaded on demand, so only code that is actually used will ever be loaded. As a result, applications will load faster (sometimes much faster - we've seen load times drop from ~1 second to less than 50 milliseconds). | ||
| Moreover, in some cases this also avoids inadvertently loading libraries that execute code or modifies globals, etc. | ||
| **webpack users** | ||
| If you use webpack and are experiencing issues, try using [unlazy-loader](https://github.com/doowb/unlazy-loader), a webpack loader that _fixes the webpack bug_ that prevents webpack from working with native javascript getters. | ||
| If you use webpack and are experiencing issues with lazy-cache, this is a known bug caused by webpack, not lazy-cache. There is a solution though, you can use [unlazy-loader](https://github.com/doowb/unlazy-loader), a webpack loader that _fixes the webpack bug_. | ||
@@ -26,4 +58,3 @@ ## Usage | ||
| The module is also added as a property to the `lazy` function | ||
| so it can be called without having to call a function first. | ||
| The module is also added as a property to the `lazy` function so it can be called without having to call a function first. | ||
@@ -111,4 +142,2 @@ ```js | ||
| In certain rare edge cases it may be necessary to unlazy all lazy-cached dependencies (5 reported cases after ~30 million downloads). | ||
| To force lazy-cache to immediately invoke all dependencies, do: | ||
@@ -120,27 +149,30 @@ | ||
| ## Related projects | ||
| ## About | ||
| You might also be interested in these projects: | ||
| ### Related projects | ||
| [lint-deps](https://www.npmjs.com/package/lint-deps): CLI tool that tells you when dependencies are missing from package.json and offers you a… [more](https://www.npmjs.com/package/lint-deps) | [homepage](https://github.com/jonschlinkert/lint-deps) | ||
| [lint-deps](https://www.npmjs.com/package/lint-deps): CLI tool that tells you when dependencies are missing from package.json and offers you a… [more](https://github.com/jonschlinkert/lint-deps) | [homepage](https://github.com/jonschlinkert/lint-deps "CLI tool that tells you when dependencies are missing from package.json and offers you a choice to install them. Also tells you when dependencies are listed in package.json but are not being used anywhere in your project. Node.js command line tool and API") | ||
| ## Contributing | ||
| ### Contributing | ||
| Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/lazy-cache/issues/new). | ||
| Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new). | ||
| ## Building docs | ||
| ### Contributors | ||
| Generate readme and API documentation with [verb](https://github.com/verbose/verb): | ||
| | **Commits** | **Contributor**<br/> | | ||
| | --- | --- | | ||
| | 31 | [jonschlinkert](https://github.com/jonschlinkert) | | ||
| | 27 | [doowb](https://github.com/doowb) | | ||
| ```sh | ||
| $ npm install verb && npm run docs | ||
| ``` | ||
| ### Building docs | ||
| Or, if [verb](https://github.com/verbose/verb) is installed globally: | ||
| _(This document was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme) (a [verb](https://github.com/verbose/verb) generator), please don't edit the readme directly. Any changes to the readme must be made in [.verb.md](.verb.md).)_ | ||
| To generate the readme and API documentation with [verb](https://github.com/verbose/verb): | ||
| ```sh | ||
| $ verb | ||
| $ npm install -g verb verb-generate-readme && verb | ||
| ``` | ||
| ## Running tests | ||
| ### Running tests | ||
@@ -153,3 +185,3 @@ Install dev dependencies: | ||
| ## Author | ||
| ### Author | ||
@@ -161,3 +193,3 @@ **Jon Schlinkert** | ||
| ## License | ||
| ### License | ||
@@ -169,2 +201,2 @@ Copyright © 2016, [Jon Schlinkert](https://github.com/jonschlinkert). | ||
| _This file was generated by [verb](https://github.com/verbose/verb), v0.9.0, on April 28, 2016._ | ||
| _This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.2.0, on November 07, 2016._ |
New alerts
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
Fixed alerts
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
Improved metrics
- Total package byte prevSize
- increased by35.7%
10958
- Number of lines in readme file
- increased by19.63%
195
No dependency changes