sutro-jsdoc-theme - npm Package Compare versions

Comparing version 0.0.1 to 1.1.0

package.json

 {
-  "_from": "github:arnog/sutro-jsdoc-theme",
-  "_id": "sutro-jsdoc-theme@0.0.1",
-  "_inBundle": false,
-  "_integrity": "",
-  "_location": "/sutro-jsdoc-theme",
-  "_phantomChildren": {},
-  "_requested": {
-    "type": "git",
-    "raw": "sutro-jsdoc-theme@github:arnog/sutro-jsdoc-theme",
-    "name": "sutro-jsdoc-theme",
-    "escapedName": "sutro-jsdoc-theme",
-    "rawSpec": "github:arnog/sutro-jsdoc-theme",
-    "saveSpec": "github:arnog/sutro-jsdoc-theme",
-    "fetchSpec": null,
-    "gitCommittish": null
-  },
-  "_requiredBy": [
-    "#DEV:/",
-    "#USER"
-  ],
-  "_resolved": "github:arnog/sutro-jsdoc-theme#45bbf6048c421004dbda018e445b2f1a9842a27b",
-  "_spec": "sutro-jsdoc-theme@github:arnog/sutro-jsdoc-theme",
-  "_where": "/Users/arnog/Dropbox/mathlive/source/_mathlive",
   "author": {
@@ -32,14 +9,2 @@ "name": "Arno Gourdol",
   },
-  "bundleDependencies": false,
-  "contributors": [
-    {
-      "name": "Hung Luu",
-      "email": "[e-mail]"
-    },
-    {
-      "name": "Nijiko Yonskai",
-      "email": "[e-mail]"
-    }
-  ],
-  "deprecated": false,
   "description": "JSDoc theme based on Namis, based Minami",
@@ -60,3 +25,2 @@ "homepage": "https://github.com/arnog/sutro-jsdoc-theme#readme",
   "license": "Apache-2.0",
-  "main": "publish.js",
   "name": "sutro-jsdoc-theme",
@@ -70,3 +34,3 @@ "repository": {
   },
-  "version": "0.0.1"
+  "version": "1.1.0"
 }

publish.js

@@ -70,10 +70,10 @@ /*global env: true */
     if (item.optional) {
-        attributes.push('opt');
+        attributes.push('?');
     }
 
     if (item.nullable === true) {
-        attributes.push('nullable');
+        attributes.push('nullable');        // Note: there are no nullable types in JS
     }
     else if (item.nullable === false) {
-        attributes.push('non-null');
+        attributes.push('!');               // In JS (well, TS), this indicates a non-null value
     }
@@ -88,2 +88,3 @@
 
+
     if (item.variable) {
@@ -100,3 +101,3 @@ itemName = '…' + itemName;
     if (typeString) {
-        itemName = util.format('%s<span class="signature-type">: %s</span>', itemName, typeString);
+        itemName = util.format('%s<span class="signature-type">: %s</span>', itemName, typeString.join(" | "));
     }
@@ -118,2 +119,5 @@
         item.type.names.forEach(function(name) {
+            name = name.replace(/Array\.<([a-zA-Z]*)>/, '$1[]');
+            name = name.replace(/Object\.<([a-zA-Z]*), ([a-zA-Z]*)>/, '[$1]:$2');
+            name = name.replace(/Object\.<([a-zA-Z]*)>/, '[$1]');
             types.push( linkto(name, htmlsafe(name)) );
@@ -178,3 +182,3 @@ });
     if (returnTypes.length) {
-        returnTypesString = util.format( ' &rarr; %s %s', attribsString, returnTypes.join('|') );
+        returnTypesString = util.format( ': %s %s', attribsString, returnTypes.join(' | ') );
     }
@@ -630,3 +634,3 @@
     // output pretty-printed source files by default
-    var outputSourceFiles = conf.default && conf.default.outputSourceFiles !== false
+    var outputSourceFiles = opts && opts.outputSourceFiles !== false
         ? true
@@ -633,0 +637,0 @@ : false;

README.md

@@ -46,3 +46,2 @@ # Sutro
         "monospaceLinks": false,
-        "outputSourceFiles": true,
         "linenums": true,
@@ -57,2 +56,3 @@ "includeDate": false,
     "opts": {
+        "outputSourceFiles": true,
         "access": "all",
@@ -73,2 +73,3 @@ "template": "node_modules/sutro-jsdoc-theme",
 - `readme`: the file to include in the generated documentation as the "home page"
+- `outputSourceFiles`: if `true`, include prettyfied source files in
 
@@ -78,3 +79,2 @@ The  keys in the `templates` section are specific to Sutro:
 - `monospaceLinks`
-- `outputSourceFiles`: if `true`, include prettyfied source files in
 the documentation
@@ -81,0 +81,0 @@ - `linenums`: if `true`, include line numbers in prettyfied output

Fixed alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

484203

increased by0.49%

Lines of code

1979

increased by4.38%

Number of low quality alerts

1

decreased by-50%

No dependency changes