sails-stdlib - npm Package Compare versions

Comparing version 0.5.0 to 0.5.1

CHANGELOG.md

 # sails-stdlib Changelog
 
-## <sub>v0.9.0</sub>
-#### _Oct 1, 2016_ — [Diff](https://github.com/lodash/lodash/compare/v0.3.1...v0.9.0) — [Docs](https://github.com/sailsjs/stdlib/tree/v0.9.0/README.md)
+## <sub>v1.0.0</sub>
+#### _Dec 1, 2016_ — [Diff](https://github.com/treelinehq/stdlib/compare/v0.3.1...v1.0.0) — [Docs](https://github.com/treelinehq/stdlib/tree/v1.0.0/README.md)
 
@@ -6,0 +6,0 @@ * Initial release

package.json

 {
   "name": "sails-stdlib",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Standard library for Node/Sails applications. Hand-picked and maintained by the Sails.js core team.",
@@ -21,9 +21,9 @@ "scripts": {
   "author": "The Treeline Company",
-  "license": "",
+  "license": "MIT",
   "dependencies": {
     "machine": "^13.0.0-11",
-    "machinepack-arrays": "git://github.com/treelinehq/machinepack-arrays.git#7fe90acaf248e7316727bc73eadfd5ed9783bc46",
-    "machinepack-booleans": "git://github.com/treelinehq/machinepack-booleans.git#2e13754fa11293aed3a7f9fd5b46f94e66c9ba2f",
+    "machinepack-arrays": "git://github.com/treelinehq/machinepack-arrays.git#b0359f31e24a306a8a05207f7ad8dfbc42b8f995",
+    "machinepack-booleans": "git://github.com/treelinehq/machinepack-booleans.git#ae639e06ca108fb930650ffa5b6546f3b8e596de",
     "machinepack-console": "git://github.com/treelinehq/machinepack-console.git#ec09bcffcb89a446b3d3043b897094c266effeff",
-    "machinepack-datetime": "git://github.com/sgress454/machinepack-datetime.git#cfd0cd473053655fdca8c7f3a3f5cac185c48f5f",
+    "machinepack-datetime": "git://github.com/sgress454/machinepack-datetime.git#618a3d78303cc476175d8e0f87bba8258cfea1d5",
     "machinepack-dictionaries": "git://github.com/treelinehq/machinepack-dictionaries.git#bfef6436cccd4d7eff6cf4cf1d04edd1fbba1070",
@@ -35,5 +35,5 @@ "machinepack-emailaddresses": "git://github.com/mikermcneil/machinepack-emailaddresses.git#f88649f4acfe428d31641e2abff718d9c86beeaf",
     "machinepack-ifthen": "git://github.com/treelinehq/machinepack-ifthen.git#2faacb7c60a1d3f3118df7e585c1e228bc5a5940",
-    "machinepack-json": "git://github.com/treelinehq/machinepack-json.git#eb06d9fb954989eca0ab97ae0aa2fa198905409d",
+    "machinepack-json": "git://github.com/treelinehq/machinepack-json.git#cb9b172d24d8a5f6a12f3ad63d95d6985fb2bd70",
     "machinepack-mailgun": "git://github.com/particlebanana/machinepack-mailgun.git#d473ed00e7195297226740b01a87b01e4149a545",
-    "machinepack-math": "git://github.com/treelinehq/machinepack-math.git#44080905c745ad242503ce785bde3d0248197cfe",
+    "machinepack-math": "git://github.com/treelinehq/machinepack-math.git#e33233cc2129098b297eafc14c17dcf88f714244",
     "machinepack-numbers": "git://github.com/treelinehq/machinepack-numbers.git#cdbbccef1fa7e6cbc9549b2b70415c7316ebaa79",
@@ -47,6 +47,6 @@ "machinepack-passwords": "git://github.com/mikermcneil/machinepack-passwords.git#bebca157df5ed12384b40afef94f27a421403bcd",
     "machinepack-sockets": "git://github.com/sgress454/machinepack-sockets.git#fb11a52098943251189e2f0dcbb452341e9f033f",
-    "machinepack-strings": "git://github.com/treelinehq/machinepack-strings.git#e4a588c4428785c395ebe111515f1069e8c23c7d",
+    "machinepack-strings": "git://github.com/treelinehq/machinepack-strings.git#6f429144064c573da4d92226b22d4a7a14d22e94",
     "machinepack-urls": "git://github.com/mikermcneil/machinepack-urls.git#49388b3bdba5c9a780834c2c5d29d388a1cf4d90",
     "machinepack-util": "git://github.com/treelinehq/machinepack-util.git#39939223130279a0214e41e515a4326a90ff914b",
-    "machinepack-waterline": "git://github.com/treelinehq/machinepack-waterline.git#52f9cd244c958b933d3bdb969022af07661241c1"
+    "machinepack-waterline": "git://github.com/treelinehq/machinepack-waterline.git#a1062c552c55e1ddb3e314d7fadd5e8f4d8f3863"
   },
@@ -53,0 +53,0 @@ "repository": {

README.md

@@ -1,3 +0,211 @@
-# Still a work in progress.
+# sails-stdlib
 
--m
+> ### WARNING
+> 
+> The Sails standard library is experimental and may undergo rapid changes until the release of Sails v1.0 later this year (2016).
+
+Standard library for Node/Sails applications.
+
+This package contains a set of hand-picked, trusted modules recommended by the Sails core team.
+
+
+## Installation   [![NPM version](https://badge.fury.io/js/sails-stdlib.svg)](http://npmjs.com/package/sails-stdlib)
+
+```bash
+npm install sails-stdlib --save
+```
+
+
+## Usage
+
+```js
+var stdlib = require('sails-stdlib');
+
+var Gravatar = stdlib('gravatar'); // << just like doing `require('machinepack-gravatar');`
+var Mailgun = stdlib('mailgun'); // << just like doing `require('machinepack-mailgun');`
+```
+
+
+## Bugs &nbsp; [![NPM version](https://badge.fury.io/js/sails-stdlib.svg)](http://npmjs.com/package/sails-stdlib)
+
+To report a bug, [click here](http://sailsjs.com/bugs).  Someone will look into it ASAP.
+
+In the mean time, if you see how to fix the problem and have a moment to prepare a patch, feel free to submit a pull request to the appropriate repo.  Thanks for taking the time to help out!
+
+> Please be aware that we can't merge any unsolicited PRs that contain changes to usage, including additional methods or options.
+> With this project, we're trying really hard to keep things consistent between individual methods, and that means being
+> vigilant about the effect of any usage change in the grand scheme of the library.
+
+
+## Contributing
+
+Please observe the guidelines and conventions laid out in the [Sails project contribution guide](http://sailsjs.com/contribute) when opening issues or submitting pull requests.
+
+[![NPM](https://nodei.co/npm/sails-stdlib.png?downloads=true)](http://npmjs.com/package/sails-stdlib)
+
+
+
+## Help
+
+First, please check out the [relevant documentation](#documentation).  If you have further questions or are having trouble, click [here](http://sailsjs.com/support).
+
+
+### Documentation
+
+##### General
+- [ifthen](http://node-machine.org/machinepack-ifthen)
+- [strings](http://node-machine.org/machinepack-strings)
+- [numbers](http://node-machine.org/machinepack-numbers)
+- [booleans](http://node-machine.org/machinepack-booleans)
+- [dictionaries](http://node-machine.org/machinepack-dictionaries)
+- [arrays](http://node-machine.org/machinepack-arrays)
+- [json](http://node-machine.org/machinepack-json)
+- [datetime](http://node-machine.org/machinepack-datetime/)
+- [math](http://node-machine.org/machinepack-math)
+- [paths](http://node-machine.org/machinepack-paths)
+- [urls](http://node-machine.org/machinepack-urls)
+- [emailaddresses](http://node-machine.org/machinepack-emailaddresses)
+
+##### Scripts and NPM Packages
+- [fs](http://node-machine.org/machinepack-fs)
+- [http](http://node-machine.org/machinepack-http)
+- [process](http://node-machine.org/machinepack-process)
+- [console](http://node-machine.org/machinepack-console)
+- [util](http://node-machine.org/machinepack-util)
+
+##### App Servers & Web APIs
+- [waterline](http://node-machine.org/machinepack-waterline)
+- [sockets](http://node-machine.org/machinepack-sockets)
+- [reqres](http://node-machine.org/machinepack-reqres)
+- [sessionauth](http://node-machine.org/machinepack-sessionauth)
+- [passwords](http://node-machine.org/machinepack-passwords)
+- [mailgun](http://node-machine.org/machinepack-mailgun)
+- [gravatar](http://node-machine.org/machinepack-gravatar)
+
+
+
+### Example
+
+```js
+var stdlib = require('sails-stdlib');
+var Gravatar = stdlib('gravatar');
+var Mailgun = stdlib('mailgun');
+
+
+// Get a gravatar for an email address.
+// (http://node-machine.org/machinepack-gravatar/get-image-url)
+var imageUrl = Gravatar.getImageUrl({
+  emailAddress: '[e-mail]',
+  gravatarSize: 400
+}).execSync();
+
+
+// Send an html email.
+// (http://node-machine.org/machinepack-mailgun/send-html-email)
+Mailgun.sendHtmlEmail({
+  apiKey: 'key-3432afa32e9401482aba183c13f3',
+  domain: 'sandbox5f89931913a9ab31130131350101.mailgun.og',
+  fromEmail: '[e-mail]',
+  fromName: 'Harold Greaseworthy',
+  toName: 'Amy Gonzales',
+  subject: 'Welcome, Amy!',
+  htmlMessage: 'Amy,\nThanks for joining our community. If you have any questions, please don\'t hesitate to send them our way. Feel free to reply to this email directly.\n\nSincerely,\nThe Management'
+}).exec(function (err) {
+  if (err) {
+    console.error('Failed to send email. Details:',err);
+    return;
+  }
+
+  console.log('Email sent!');
+
+});
+```
+
+
+
+## FAQ
+
+
+#### I have an idea for how to improve...
+
+We'd like to hear it!  The best way to share your ideas is to contribute (see below).
+
+
+#### I wish this supported...
+
+We are constantly looking for ways to improve this library. If we're missing something you need from a particular pack,
+tweet at [@sailsjs](https://twitter.com/sailsjs) to explain your use case and we'll see what we can do.
+If you're in a hurry, just look up the repo for the package in question from the list below, then create a fork.
+
+
+#### Where's the code?
+
+Each package in the standard library lives in its own repository:
+
+##### General
+- [ifthen](https://github.com/treelinehq/machinepack-ifthen)
+- [strings](https://github.com/treelinehq/machinepack-strings)
+- [numbers](https://github.com/treelinehq/machinepack-numbers)
+- [booleans](https://github.com/treelinehq/machinepack-booleans)
+- [dictionaries](https://github.com/treelinehq/machinepack-dictionaries)
+- [arrays](https://github.com/treelinehq/machinepack-arrays)
+- [json](https://github.com/treelinehq/machinepack-json)
+- [datetime](https://github.com/sgress454/machinepack-datetime/)
+- [math](https://github.com/treelinehq/machinepack-math)
+- [paths](https://github.com/treelinehq/machinepack-paths)
+- [urls](https://github.com/mikermcneil/machinepack-urls)
+- [emailaddresses](https://github.com/mikermcneil/machinepack-emailaddresses)
+
+##### Scripts and NPM Packages
+- [fs](https://github.com/mikermcneil/machinepack-fs)
+- [http](https://github.com/mikermcneil/machinepack-http)
+- [process](https://github.com/treelinehq/machinepack-process)
+- [console](https://github.com/treelinehq/machinepack-console)
+- [util](https://github.com/treelinehq/machinepack-util)
+
+##### App Servers & Web APIs
+- [waterline](https://github.com/treelinehq/machinepack-waterline)
+- [sockets](https://github.com/sgress454/machinepack-sockets)
+- [reqres](https://github.com/mikermcneil/machinepack-reqres)
+- [sessionauth](https://github.com/treelinehq/machinepack-sessionauth)
+- [passwords](https://github.com/mikermcneil/machinepack-passwords)
+- [mailgun](https://github.com/particlebanana/machinepack-mailgun)
+- [gravatar](https://github.com/irlnathan/machinepack-gravatar)
+
+
+#### Where's the changelog?
+
+The [CHANGELOG.md file in this repo](./CHANGELOG.md) contains a record of usage changes for all of the packs in the standard library (in other words, any minor or major version bumps to the dependencies listed in the package.json file).  This makes the changelog more accurate and easier to update, since it saves contributors from having to maintain individual changelogs in at least 20 different repos.
+
+
+#### Does this use semver?
+
+Dependency versions are pinned, and all releases of `sails-stdlib` are carefully tested to ensure strict semantic versioning.
+
+
+#### Does this support custom builds?
+
+You can install and use any of the packages in this repo individually.  Just require the machinepack directly.
+
+
+#### How do I run the tests?
+
+Tests for each package are implemented in its repo.
+
+
+#### What does the future hold?
+
+The roadmap for this library is flexible and we're open to ideas.  The important thing is that we remain relentlessly focused on stability and versatility,
+while keeping the library relatively lightweight and the usage intuitive.  Secondary to that, most of the immediate-term
+improvements we're interested in making are related to performance.
+
+
+#### I'd like to help work on this.
+
+Awesome!  Tweet [@sailsjs](https://twitter.com/sailsjs) and let us know the minimum # of hours per week you'll
+be able to commit, and someone from the core team will contact you ASAP.
+
+
+## License
+
+This package, like the [Sails framework](http://sailsjs.com), is free and open-source under the [MIT License](http://sailsjs.com/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

Git dependency

Supply chain risk

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

Found 7 instances 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

Git dependency

Supply chain risk

Contains a dependency which resolves to a remote git URL. Dependencies fetched from git URLs are not immutable can be used to inject untrusted code or reduce the likelihood of a reproducible install.

Found 7 instances in 1 package

Misc. License Issues

License

(Experimental) A package's licensing information has fine-grained problems.

Found 2 instances in 1 package

Improved metrics

Total package byte prevSize

18024

increased by83.64%

Number of medium license alerts

0

decreased by-100%

Number of lines in readme file

212

increased by5200%

Dependency changes

• Updatedmachinepack-arrays@git://github.com/treelinehq/machinepack-arrays.git#b0359f31e24a306a8a05207f7ad8dfbc42b8f995

• Updatedmachinepack-booleans@git://github.com/treelinehq/machinepack-booleans.git#ae639e06ca108fb930650ffa5b6546f3b8e596de

• Updatedmachinepack-datetime@git://github.com/sgress454/machinepack-datetime.git#618a3d78303cc476175d8e0f87bba8258cfea1d5

• Updatedmachinepack-json@git://github.com/treelinehq/machinepack-json.git#cb9b172d24d8a5f6a12f3ad63d95d6985fb2bd70

• Updatedmachinepack-math@git://github.com/treelinehq/machinepack-math.git#e33233cc2129098b297eafc14c17dcf88f714244

• Updatedmachinepack-strings@git://github.com/treelinehq/machinepack-strings.git#6f429144064c573da4d92226b22d4a7a14d22e94

• Updatedmachinepack-waterline@git://github.com/treelinehq/machinepack-waterline.git#a1062c552c55e1ddb3e314d7fadd5e8f4d8f3863