Prettier

Author: fiznool

.github/dependabot.yml

@@ -1,21 +1,21 @@
 version: 2
 updates:
-- package-ecosystem: npm
-  directory: "/"
-  schedule:
-    interval: daily
-  open-pull-requests-limit: 10
-  ignore:
-  - dependency-name: eslint
-    versions:
-    - 7.18.0
-    - 7.19.0
-    - 7.20.0
-    - 7.21.0
-    - 7.22.0
-    - 7.23.0
-    - 7.24.0
-  - dependency-name: mocha
-    versions:
-    - 8.3.0
-    - 8.3.1
+  - package-ecosystem: npm
+    directory: '/'
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    ignore:
+      - dependency-name: eslint
+        versions:
+          - 7.18.0
+          - 7.19.0
+          - 7.20.0
+          - 7.21.0
+          - 7.22.0
+          - 7.23.0
+          - 7.24.0
+      - dependency-name: mocha
+        versions:
+          - 8.3.0
+          - 8.3.1

.github/workflows/nodejs.yml

@@ -2,26 +2,25 @@ name: Node.js CI
 
 on:
   push:
-    branches: [ master ]
+    branches: [master]
   pull_request:
-    branches: [ master ]
+    branches: [master]
 
 jobs:
   build:
-
     runs-on: ubuntu-latest
 
     strategy:
       matrix:
         node-version: [10.x, 12.x, 14.x]
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
-      with:
-        node-version: ${{ matrix.node-version }}
-    - run: npm ci
-    - run: npm test
-      env:
-        CI: true
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm test
+        env:
+          CI: true

.prettierrc

@@ -0,0 +1,5 @@
+{
+  "bracketSpacing": true,
+  "singleQuote": true,
+  "trailingComma": "all"
+}

CHANGELOG.md

@@ -1,24 +1,33 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [2.0.1] - 2020-12-02
+
 ### Updated
+
 - Update dependencies and test against node 14.
 
 ## [2.0.0] - 2020-03-25
+
 ### Fixed
+
 - Ensure `done` callback is not called multiple times #4
 - Support bodyparser's 'type' option as function #5
 
 ### Breaking
+
 - Remove support for node < 10
 
 ## [1.1.0] - 2016-03-18
+
 ### Added
+
 - Ability to set a custom `Content-Type` for the expected XML-formatted request.
 
 ## 1.0.0 - 2015-12-19
+
 Initial Release.
 
 [2.0.1]: https://github.com/fiznool/body-parser-xml/compare/v2.0.0...v2.0.1

README.md

@@ -22,14 +22,14 @@ This library adds an `xml` method to the `body-parser` object.
 
 Initialise like so:
 
-``` js
+```js
 const bodyParser = require('body-parser');
 require('body-parser-xml')(bodyParser);
 ```
 
 Once initialised, you can use it just like any other `body-parser` middleware:
 
-``` js
+```js
 const app = require('express')();
 app.use(bodyParser.xml());
 ```
@@ -48,7 +48,7 @@ If you need to match against a custom `Content-Type` header, pass in the `type`
 
 You can also pass in options:
 
-``` js
+```js
 app.use(bodyParser.xml(options));
 ```
 
@@ -68,7 +68,7 @@ Controls the maximum request body size. If this is a number, then the value spec
 
 #### type
 
-The type option is used to determine what media type the middleware will parse. This option can be a string, array of strings, or a function. If not a function, type option is passed directly to the type-is library and this can be an extension name (like xml), a mime type (like application/xml), or a mime type with a wildcard (like */* or */xml). If a function, the type option is called as fn(req) and the request is parsed if it returns a truthy value. Defaults to `['*/xml', '+xml']`.
+The type option is used to determine what media type the middleware will parse. This option can be a string, array of strings, or a function. If not a function, type option is passed directly to the type-is library and this can be an extension name (like xml), a mime type (like application/xml), or a mime type with a wildcard (like _/_ or _/xml). If a function, the type option is called as fn(req) and the request is parsed if it returns a truthy value. Defaults to `['_/xml', '+xml']`.
 
 #### verify
 
@@ -80,30 +80,31 @@ This option controls the behaviour of the XML parser. You can pass any option th
 
 ## Example
 
-``` js
+```js
 const express = require('express');
 const bodyParser = require('body-parser');
 
 require('body-parser-xml')(bodyParser);
 
 const app = express();
-app.use(bodyParser.xml({
-  limit: '1MB',   // Reject payload bigger than 1 MB
-  xmlParseOptions: {
-    normalize: true,     // Trim whitespace inside text nodes
-    normalizeTags: true, // Transform tags to lowercase
-    explicitArray: false // Only put nodes in array if >1
-  }
-}));
-
-app.post('/users', function(req, res, body) {
+app.use(
+  bodyParser.xml({
+    limit: '1MB', // Reject payload bigger than 1 MB
+    xmlParseOptions: {
+      normalize: true, // Trim whitespace inside text nodes
+      normalizeTags: true, // Transform tags to lowercase
+      explicitArray: false, // Only put nodes in array if >1
+    },
+  }),
+);
+
+app.post('/users', function (req, res, body) {
   // Any request with an XML payload will be parsed
   // and a JavaScript object produced on req.body
   // corresponding to the request payload.
   console.log(req.body);
   res.status(200).end();
 });
-
 ```
 
 ## Motivation

index.js

@@ -4,8 +4,8 @@ const xml2js = require('xml2js');
 
 const DEFAULT_TYPES = ['*/xml', '+xml'];
 
-module.exports = function(bodyParser) {
-  if(bodyParser.xml) {
+module.exports = function (bodyParser) {
+  if (bodyParser.xml) {
     // We already setup the XML parser.
     // End early.
     return;
@@ -19,22 +19,26 @@ module.exports = function(bodyParser) {
     const textParser = bodyParser.text(options);
     return function xmlParser(req, res, next) {
       // First, run the body through the text parser.
-      textParser(req, res, function(err) {
-        if(err) { return next(err); }
-        if(typeof req.body !== 'string') { return next(); }
+      textParser(req, res, function (err) {
+        if (err) {
+          return next(err);
+        }
+        if (typeof req.body !== 'string') {
+          return next();
+        }
 
         // Then, parse as XML.
         const xmlParseOptions = {
           ...options.xmlParseOptions,
           // Always opt-in to async mode.
-          async: true
+          async: true,
         };
         const parser = new xml2js.Parser(xmlParseOptions);
 
         // In some cases xml2js.Parser parseString() can throw an error after executing the callback.
 
-        parser.parseString(req.body, function(err, xml) {
-          if(err) {
+        parser.parseString(req.body, function (err, xml) {
+          if (err) {
             err.status = 400;
             return next(err);
           }
@@ -50,8 +54,8 @@ module.exports = function(bodyParser) {
   Object.defineProperty(bodyParser, 'xml', {
     configurable: true,
     enumerable: true,
-    get: function() {
+    get: function () {
       return xml;
-    }
+    },
   });
 };