Release 0.0.1

Author: niftylettuce

.babelrc

@@ -0,0 +1,5 @@
+{
+  "presets": [ "crocodile" ],
+  "sourceMaps": "inline",
+  "plugins": [ "add-module-exports" ]
+}

.eslintignore

@@ -0,0 +1 @@
+lib

.eslintrc

@@ -0,0 +1,3 @@
+{
+  "extends": "crocodile"
+}

.gitignore

@@ -0,0 +1,11 @@
+
+# osx
+.DS_Store
+
+# project
+node_modules/
+logs
+*.log
+npm-debug.log*
+*.idea
+lib

.npmignore

@@ -0,0 +1 @@
+src

LICENSE

@@ -0,0 +1,9 @@
+The MIT License
+
+Copyright (c) 2017- Nick Baugh <niftylettuce@gmail.com>
+
+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.

Readme.md

@@ -0,0 +1,102 @@
+
+# mongoose-validation-error-transform
+
+[![Slack Status][slack-image]][slack-url]
+[![NPM version][npm-image]][npm-url]
+[![Standard JS Style][standard-image]][standard-url]
+[![MIT License][license-image]][license-url]
+
+> Automatically transform [Mongoose][mongoose] validation error message(s) to a humanized and readable format, built for [CrocodileJS][crocodile-url].
+
+
+## Index
+
+* [Install](#install)
+* [Usage](#usage)
+* [License](#license)
+
+
+## Install
+
+```bash
+npm install --save mongoose-validation-error-transform
+```
+
+> You may also want to use [mongoose-beautiful-unique-validation][mongoose-beautiful-unique-validation] too (see [this comment][comment])!
+
+
+## Usage
+
+```js
+const mongooseValidationErrorTransform = require('mongoose-validation-error-transform');
+
+mongoose.plugin(mongooseValidationErrorTransform, {
+
+  //
+  // these are the default options you can override
+  // (you don't need to specify this object otherwise)
+  //
+
+  // should we capitalize the first letter of the message?
+  capitalize: true,
+
+  // should we convert `full_name` => `Full name`?
+  humanize: true,
+
+  // how should we join together multiple validation errors?
+  transform: function(messages) {
+    return messages.join(', ');
+  }
+
+});
+```
+
+If you have a Mongoose schema defined with a required String field `full_name`,
+and if there is an error with a missing `full_name` on a document - then it will
+automatically rewrite the message of `"full_name" is required` to
+`"Full name is required"`.
+
+If there are multiple validation error messages, such as:
+
+* `"full_name" is required`
+* `"age" is not at least (18)`
+
+Then it will rewrite the error message to `Full name is required, Age is not at least (18)`.
+
+Of course - by modifying the options mentioned above, you can transform the messages however you'd like.
+
+For example, if you'd like to output a `<ul>` HTML tag with `<li>` for each error (but only of course if there's more than one error):
+
+```js
+mongoose.plugin(mongooseValidationErrorTransform, {
+  transform: function(messages) {
+    if (messages.length === 1) return messages[0];
+    return `<ul><li>${messages.join('</li><li>')}</li></ul>`;
+  }
+});
+```
+
+This would output the following for the previous example:
+
+```html
+<ul><li>Full name is required</li><li>Age is not at least (18)</li></ul>
+```
+
+
+## License
+
+[MIT][license-url]
+
+
+[license-image]: http://img.shields.io/badge/license-MIT-blue.svg
+[license-url]: LICENSE
+[npm-image]: https://img.shields.io/npm/v/mongoose-validation-error-transform.svg
+[npm-url]: https://npmjs.org/package/mongoose-validation-error-transform
+[crocodile-url]: https://crocodilejs.com
+[standard-image]: https://img.shields.io/badge/code%20style-standard%2Bes7-brightgreen.svg
+[standard-url]: https://github.com/crocodilejs/eslint-config-crocodile
+[slack-image]: http://slack.crocodilejs.com/badge.svg
+[slack-url]: http://slack.crocodilejs.com
+[mongoose]: https://github.com/Automattic/mongoose
+[comment]: https://github.com/Automattic/mongoose/issues/2284#issuecomment-320810641
+[mongoose-beautiful-unique-validation]: https://github.com/matteodelabre/mongoose-beautiful-unique-validation

package.json

@@ -0,0 +1,52 @@
+{
+  "name": "mongoose-validation-error-transform",
+  "description": "Automatically transform Mongoose validation error message(s) to a humanized and readable format",
+  "version": "0.0.1",
+  "author": "Nick Baugh <niftylettuce@gmail.com>",
+  "bugs": "https://github.com/niftylettuce/mongoose-validation-error-transform/issues",
+  "devDependencies": {
+    "babel-cli": "^6.11.4",
+    "babel-plugin-add-module-exports": "^0.2.1",
+    "babel-preset-crocodile": "^1.0.0",
+    "eslint-config-crocodile": "^1.0.0"
+  },
+  "engines": {
+    "node": ">= 6.x"
+  },
+  "homepage": "https://github.com/niftylettuce/mongoose-validation-error-transform",
+  "keywords": [
+    "mongoose",
+    "validation",
+    "error",
+    "transform",
+    "messages",
+    "unique",
+    "beautiful",
+    "errors",
+    "err",
+    "handler",
+    "handling",
+    "pretty",
+    "print",
+    "alert",
+    "mongodb",
+    "mongo",
+    "custom",
+    "parse",
+    "parser",
+    "parsing"
+  ],
+  "license": "MIT",
+  "main": "lib/index.js",
+  "repository": "niftylettuce/mongoose-validation-error-transform",
+  "scripts": {
+    "compile": "rm -rf lib/ && babel -d lib src",
+    "lint": "eslint .",
+    "prepublish": "npm run test",
+    "test": "npm run lint"
+  },
+  "dependencies": {
+    "lodash": "^4.17.4",
+    "underscore.string": "^3.3.4"
+  }
+}

src/index.js

@@ -0,0 +1,45 @@
+
+const s = require('underscore.string');
+const _ = require('lodash');
+
+export default function mongooseValidationErrorTransform(schema, options) {
+
+  options = _.defaults(options || {}, {
+    capitalize: true,
+    humanize: true,
+    transform: messages => messages.join(', ')
+  });
+
+  function humanizePath(err, doc, next) {
+
+    if (err.name !== 'ValidationError' || !_.isObject(err.errors))
+      return next(err);
+
+    err.message = options.transform(_.map(
+      _.values(err.errors),
+      error => {
+        if (!_.isString(error.path))
+          return options.capitalize ? s.capitalize(error.message) : error.message;
+        if (options.humanize)
+          error.message = error.message.replace(
+            new RegExp(error.path, 'g'),
+            s.humanize(error.path)
+          );
+        if (options.capitalize)
+          error.message = s.capitalize(error.message);
+        return error.message;
+      }
+    ));
+
+    next(err);
+
+  }
+
+  schema.post('save', humanizePath);
+  schema.post('update', humanizePath);
+  schema.post('findOneAndUpdate', humanizePath);
+  schema.post('insertMany', humanizePath);
+
+  return schema;
+
+}