apidoc - npm Package Compare versions

Comparing version 0.23.0 to 0.24.0

CHANGELOG.md

 # apiDoc Changelog
 
+#### 0.24.0
+
+* Fix output when offline (#894) by @SecretAgentKen
+* Increase require.js timeout (#889) by @NicolasCARPi
+* Use Prism.js instead of deprecated prettify.js (#888) by @NicolasCARPi
+
 #### 0.23.0
@@ -4,0 +10,0 @@

example/example.js

@@ -15,3 +15,3 @@ /**
  *
- * @apiExample {curl} Curl example
+ * @apiExample {bash} Curl example
  * curl -H "Authorization: token 5f048fe" -i https://api.example.com/user/4711
@@ -96,3 +96,3 @@ * @apiExample {js} Javascript example
  *
- * @apiExample {curl} Curl example
+ * @apiExample {bash} Curl example
  * curl -X DELETE -H "Authorization: token 5f048fe" -i https://api.example.com/user/4711
@@ -99,0 +99,0 @@ * @apiExample {js} Javascript example

package.json

 {
   "name": "apidoc",
-  "version": "0.23.0",
+  "version": "0.24.0",
   "description": "RESTful web API Documentation Generator",
@@ -40,6 +40,6 @@ "author": "Peter Rottmann <[e-mail]>",
     "handlebars": "^4.7.6",
-    "lodash": "^4.17.15",
+    "lodash": "^4.17.19",
     "markdown-it": "^10.0.0",
-    "nodemon": "^2.0.3",
-    "winston": "^3.2.1"
+    "nodemon": "^2.0.4",
+    "winston": "^3.3.3"
   },
@@ -51,3 +51,3 @@ "devDependencies": {
     "jquery": "3.4.1",
-    "jshint": "^2.11.0",
+    "jshint": "^2.11.1",
     "lodash-cli": "^4.17.5",
@@ -54,0 +54,0 @@ "mocha": "^6.2.3",

template/main.js

@@ -11,3 +11,3 @@ require.config({
         pathToRegexp: './vendor/path-to-regexp/index',
-        prettify: './vendor/prettify/prettify',
+        prismjs: './vendor/prism',
         semver: './vendor/semver.min',
@@ -34,8 +34,8 @@ utilsSampleRequest: './utils/send_sample_request',
         },
-        prettify: {
-            exports: 'prettyPrint'
-        }
+        prismjs: {
+            exports: 'Prism'
+        },
     },
     urlArgs: 'v=' + (new Date()).getTime(),
-    waitSeconds: 15
+    waitSeconds: 150
 });
@@ -50,3 +50,3 @@
     'apiData',
-    'prettify',
+    'prismjs',
     'utilsSampleRequest',
@@ -58,3 +58,3 @@ 'semver',
     'list'
-], function($, _, locale, Handlebars, apiProject, apiData, prettyPrint, sampleRequest, semver, WebFont) {
+], function($, _, locale, Handlebars, apiProject, apiData, Prism, sampleRequest, semver, WebFont) {
 
@@ -65,4 +65,8 @@ // Load google web fonts.
             // Only init after fonts are loaded.
-            init($, _, locale, Handlebars, apiProject, apiData, prettyPrint, sampleRequest, semver);
+            init($, _, locale, Handlebars, apiProject, apiData, Prism, sampleRequest, semver);
         },
+        inactive: function() {
+            // Run init, even if loading fonts fails
+            init($, _, locale, Handlebars, apiProject, apiData, Prism, sampleRequest, semver);
+        },
         google: {
@@ -74,3 +78,3 @@ families: ['Source Code Pro', 'Source Sans Pro:n4,n6,n7']
 
-function init($, _, locale, Handlebars, apiProject, apiData, prettyPrint, sampleRequest, semver) {
+function init($, _, locale, Handlebars, apiProject, apiData, Prism, sampleRequest, semver) {
     var api = apiData.api;
@@ -532,2 +536,3 @@
         sampleRequest.initDynamic();
+        Prism.highlightAll()
     }
@@ -543,5 +548,2 @@ initDynamic();
 
-    // Pre- / Code-Format
-    prettyPrint();
-
     //
@@ -915,2 +917,3 @@ // HTML-Template specific jQuery-Functions
     }
+    Prism.highlightAll()
 }

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

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

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Mixed license

License

(Experimental) Package contains multiple licenses.

Found 1 instance in 1 package

Improved metrics

Number of low license alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

1478835

decreased by-6.39%

Number of package files

67

decreased by-45.97%

Lines of code

4843

decreased by-19.42%

Dependency changes

• Updatedlodash@^4.17.19

• Updatednodemon@^2.0.4

• Updatedwinston@^3.3.3