swagger-parser - npm Package Compare versions

Comparing version 5.0.6 to 6.0.0

CHANGELOG.md

@@ -6,2 +6,11 @@ # Change Log
 
+## [v6.0.0](https://github.com/APIDevTools/swagger-parser/tree/v6.0.0) (2018-10-05)
+
+- Dropped support for [Bower](https://www.npmjs.com/package/bower), since it has been deprecated
+
+- Removed the [`debug`](https://npmjs.com/package/debug) dependency
+
+[Full Changelog](https://github.com/APIDevTools/swagger-parser/compare/v5.0.0...v6.0.0)
+
+
 ## [v5.0.0](https://github.com/APIDevTools/swagger-parser/tree/v5.0.0) (2018-05-25)
@@ -8,0 +17,0 @@

lib/util.js

 'use strict';
 
-var debug = require('debug'),
-    util = require('util');
+var util = require('util');
 
@@ -10,11 +9,4 @@ exports.format = util.format;
 /**
- * Writes messages to stdout.
- * Log messages are suppressed by default, but can be enabled by setting the DEBUG variable.
- * @type {function}
- */
-exports.debug = debug('swagger:parser');
-
-/**
  * Regular Expression that matches Swagger path params.
  */
 exports.swaggerParamRegExp = /\{([^/}]+)}/g;

lib/validators/schema.js

@@ -17,4 +17,2 @@ 'use strict';
 function validateSchema (api) {
-  util.debug('Validating against the Swagger schema');
-
   // Choose the appropriate schema (Swagger or OpenAPI)
@@ -27,6 +25,3 @@ var schema = api.swagger
 
-  if (isValid) {
-    util.debug('    Validated successfully');
-  }
-  else {
+  if (!isValid) {
     var err = ZSchema.getLastError();
@@ -33,0 +28,0 @@ var message = 'Swagger schema validation failed. \n' + formatZSchemaError(err.details);

lib/validators/spec.js

@@ -22,4 +22,2 @@ 'use strict';
 
-  util.debug('Validating against the Swagger spec');
-
   var paths = Object.keys(api.paths || {});
@@ -41,4 +39,2 @@ var operationIds = [];
   });
-
-  util.debug('    Validated successfully');
 }
@@ -45,0 +41,0 @@

package.json

 {
   "name": "swagger-parser",
-  "version": "5.0.6",
+  "version": "6.0.0",
   "description": "Swagger 2.0 and OpenAPI 3.0 parser and validator for Node and browsers",
@@ -26,36 +26,42 @@ "keywords": [
   },
+  "homepage": "https://apidevtools.org/swagger-parser",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/APIDevTools/swagger-parser.git"
+  },
   "license": "MIT",
-  "homepage": "https://apidevtools.org/swagger-parser",
   "main": "lib/index.js",
+  "files": [
+    "dist/swagger-parser.js",
+    "dist/swagger-parser.js.map",
+    "dist/swagger-parser.min.js",
+    "dist/swagger-parser.min.js.map",
+    "lib"
+  ],
   "scripts": {
     "lint": "eslint lib test www/js/src --fix",
-    "build": "npm run lint && npm run browserify && npm run build-www",
-    "browserify": "simplifyify lib/index.js --outfile dist/swagger-parser.js --standalone SwaggerParser --bundle --debug --minify",
-    "watch": "npm run browserify -- --watch & npm run browserify-www -- --watch",
-    "mocha": "mocha",
-    "istanbul": "istanbul cover _mocha --dir coverage/node",
-    "karma": "karma start --single-run",
-    "test": "npm run browserify -- --test && npm run istanbul && npm run karma",
+    "build": "npm run build:browser && npm run build:website && npm run build:sass",
+    "build:browser": "simplifyify lib/index.js --outfile dist/swagger-parser.js --standalone SwaggerParser --bundle --debug --minify",
+    "build:website": "simplifyify www/js/src/index.js --outfile www/js/bundle.js --bundle --debug --minify",
+    "build:sass": "node-sass --source-map true --output-style compressed www/css/style.scss www/css/style.min.css",
+    "test": "npm run test:node && npm run test:browser",
+    "test:node": "mocha",
+    "test:browser": "karma start --single-run",
+    "coverage": "npm run coverage:node && npm run coverage:browser",
+    "coverage:node": "nyc --reporter=text --reporter=lcov --report-dir coverage/node mocha",
+    "coverage:browser": "npm run build:browser -- --coverage && npm run test:browser -- --coverage",
     "upgrade": "npm-check -u",
     "bump": "bump --prompt --grep dist/* --tag --push --all",
-    "release": "npm run upgrade && npm run build-www && npm test && npm run bump && npm publish",
-    "build-www": "npm run sass && npm run browserify-www",
-    "browserify-www": "simplifyify www/js/src/index.js --outfile www/js/bundle.js --bundle --debug --minify",
-    "sass": "node-sass --source-map true --output-style compressed www/css/style.scss www/css/style.min.css",
+    "release": "npm run upgrade && npm run build && npm test && npm run bump && npm publish",
     "start": "http-server -o -c-1"
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/APIDevTools/swagger-parser.git"
-  },
   "devDependencies": {
-    "bower": "^1.8.2",
-    "chai": "^4.1.2",
-    "codacy-coverage": "^3.0.0",
+    "chai": "^4.2.0",
+    "codacy-coverage": "^3.1.0",
     "coveralls": "^3.0.2",
-    "eslint": "^5.4.0",
-    "eslint-config-modular": "^4.1.2",
+    "eslint": "^5.6.1",
+    "eslint-config-modular": "^4.2.2",
     "http-server": "^0.11.1",
-    "istanbul": "^0.4.5",
     "karma": "^3.0.0",
+    "karma-chai": "^0.1.0",
     "karma-chrome-launcher": "^2.2.0",
@@ -66,3 +72,3 @@ "karma-cli": "^1.0.1",
     "karma-firefox-launcher": "^1.1.0",
-    "karma-host-environment": "^1.1.3",
+    "karma-host-environment": "^1.1.6",
     "karma-ie-launcher": "^1.0.0",
@@ -75,17 +81,17 @@ "karma-mocha": "^1.3.0",
     "node-sass": "^4.9.3",
-    "npm-check": "^5.8.0",
-    "simplifyify": "^4.0.3",
+    "npm-check": "^5.9.0",
+    "nyc": "^13.0.1",
+    "simplifyify": "^6.0.1",
     "superagent": "^3.8.2",
-    "version-bump-prompt": "^4.0.0"
+    "version-bump-prompt": "^4.2.1"
   },
   "dependencies": {
     "call-me-maybe": "^1.0.1",
-    "debug": "^3.1.0",
-    "json-schema-ref-parser": "^5.1.3",
-    "ono": "^4.0.6",
+    "json-schema-ref-parser": "^6.0.0",
+    "ono": "^4.0.10",
     "openapi-schema-validation": "^0.4.2",
-    "swagger-methods": "^1.0.4",
+    "swagger-methods": "^1.0.6",
     "swagger-schema-official": "2.0.0-bab6bed",
-    "z-schema": "^3.23.0"
+    "z-schema": "^3.24.1"
   }
-}
+}

README.md

@@ -13,3 +13,2 @@ Swagger/OpenAPI Parser
 [![npm](https://img.shields.io/npm/v/swagger-parser.svg)](https://www.npmjs.com/package/swagger-parser)
-[![Bower](https://img.shields.io/bower/v/swagger-parser.svg)](http://bower.io/)
 [![License](https://img.shields.io/npm/l/swagger-parser.svg)](LICENSE)
@@ -85,21 +84,19 @@
 #### Web Browsers
-Install using [bower](http://bower.io/):
+Reference [`swagger-parser.js`](dist/swagger-parser.js) or [`swagger-parser.min.js`](dist/swagger-parser.min.js) in your HTML:
 
-```bash
-bower install swagger-parser
-```
-
-Then reference [`swagger-parser.js`](dist/swagger-parser.js) or [`swagger-parser.min.js`](dist/swagger-parser.min.js) in your HTML:
-
 ```html
-<script src="bower_components/swagger-parser/dist/swagger-parser.js"></script>
+<script src="https://cdn.rawgit.com/JS-DevTools/swagger-parser/dist/swagger-parser.js"></script>
+<script>
+  SwaggerParser.validate(myAPI, function(err, api) {
+    if (err) {
+      console.error(err);
+    }
+    else {
+      console.log("API name: %s, Version: %s", api.info.title, api.info.version);
+    }
+  });
+</script>
 ```
 
-Or, if you're using AMD (Require.js), then import it into your module:
 
-```javascript
-define(["swagger-parser"], function(SwaggerParser) { /* your module's code */ })
-```
-
-
 API Documentation
@@ -127,5 +124,3 @@ --------------------------
 4. __Run the tests__<br>
-`npm run mocha` (test in Node)<br>
-`npm run karma` (test in web browsers)<br>
-`npm test` (test in Node and browsers, and report code coverage)
+`npm test`
 
@@ -132,0 +127,0 @@ 5. __Start the local web server__<br>

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

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

Environment variable access

Supply chain risk

Package accesses environment variables, which may be a sign of credential stuffing or data theft.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

3869121

increased by3.77%

Dependency count

7

decreased by-12.5%

Lines of code

27646

increased by2.15%

Number of low supply chain risk alerts

14

decreased by-12.5%

Worsened metrics

Number of package files

13

decreased by-7.14%

Number of lines in readme file

131

decreased by-3.68%

Number of medium supply chain risk alerts

16

increased by14.29%

Dependency changes

• + Addedjson-schema-ref-parser@6.1.0(transitive)

• - Removeddebug@^3.1.0

• - Removeddebug@3.2.7(transitive)

• - Removedjson-schema-ref-parser@5.1.3(transitive)

• - Removedms@2.1.3(transitive)

• Updatedjson-schema-ref-parser@^6.0.0

• Updatedono@^4.0.10

• Updatedswagger-methods@^1.0.6

• Updatedz-schema@^3.24.1