typedoc-plugin-markdown - npm Package Compare versions

Comparing version 1.1.1 to 1.1.2

dist/theme/helpers/compileGroup.js

@@ -11,8 +11,10 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var index_1 = require("typedoc/dist/lib/models/reflections/index");
 var theme_service_1 = require("../theme.service");
-function compileGroup(group, parent) {
+function compileGroup(group, parentKind) {
     var options = theme_service_1.ThemeService.getOptions();
     var md = '';
     if (!options.excludePrivate || !group.allChildrenArePrivate) {
-        md = theme_service_1.ThemeService.compilePartial("members.group.hbs", __assign({}, group));
+        var displayPropertyTable = parentKind && parentKind === index_1.ReflectionKind.Interface && group.title === 'Properties';
+        md = theme_service_1.ThemeService.compilePartial('members.group.hbs', __assign({}, group, { displayPropertyTable: displayPropertyTable }));
     }
@@ -19,0 +21,0 @@ return md;

dist/theme/helpers/getStrippedComment.js

 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+var flavour_enum_1 = require("../enums/flavour.enum");
+var theme_service_1 = require("../theme.service");
 function getStrippedComment(comment) {
+    var options = theme_service_1.ThemeService.getOptions();
+    var lineBreak = options.mdFlavour === flavour_enum_1.Flavour.BITBUCKET ? ' ' : '<br><br>';
     var newComment = '';
     if (comment) {
         if (comment.text) {
-            newComment += comment.text.replace(/\n/g, '');
+            newComment += comment.text.replace(/\n\n/g, lineBreak);
         }
         if (comment.shortText) {
-            newComment += comment.shortText.replace(/\n/g, '');
+            newComment += comment.shortText.replace(/\n\n/g, lineBreak);
         }
@@ -12,0 +16,0 @@ }

dist/theme/helpers/ifDisplayIndex.js

@@ -13,4 +13,6 @@ "use strict";
         (options.mdFlavour === flavour_enum_1.Flavour.GITBOOK && member.kind === index_1.ReflectionKind.Class) ||
-        ((options.mdFlavour === flavour_enum_1.Flavour.GITBOOK && member.kind === index_1.ReflectionKind.ExternalModule && !classModule) &&
-            (options.mdFlavour === flavour_enum_1.Flavour.GITBOOK && member.kind === index_1.ReflectionKind.ExternalModule && !enumModule))) {
+        (options.mdFlavour === flavour_enum_1.Flavour.GITBOOK && member.kind === index_1.ReflectionKind.Interface)
+        ||
+            ((options.mdFlavour === flavour_enum_1.Flavour.GITBOOK && member.kind === index_1.ReflectionKind.ExternalModule && !classModule) &&
+                (options.mdFlavour === flavour_enum_1.Flavour.GITBOOK && member.kind === index_1.ReflectionKind.ExternalModule && !enumModule))) {
         return opts.inverse(this);
@@ -17,0 +19,0 @@ }

package.json

 {
   "name": "typedoc-plugin-markdown",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "A plugin for Typedoc that exposes a theme and options for rendering markdown.",
@@ -13,6 +13,6 @@ "main": "dist/index.js",
     "mocks": "npm run mocks:github && npm run mocks:bitbucket && npm run mocks:gitbook",
-    "mocks:github": "typedoc  ./tests/src --out ./tests/out/github --theme markdown --gitRevision master --media tests/src/media/ --includes tests/src/inc/",
-    "mocks:bitbucket": "typedoc  ./tests/src --out ./tests/out/bitbucket --theme markdown --gitRevision master --media tests/src/media/ --includes tests/src/inc/ --excludePrivate --readme none --mode file --mdFlavour bitbucket --mdSourceRepo 'https://bitbucket.org/owner/repository_name'",
-    "mocks:gitbook": "typedoc  ./tests/src --out ./tests/out/gitbook --theme markdown --gitRevision master --mdFlavour gitbook --media tests/src/media/ --includes tests/src/inc/",
-    "mocks:html": "typedoc --out tests/html tests --media tests/src/media/ --includes tests/src/inc/",
+    "mocks:github": "typedoc ./tests/src --out ./tests/out/github --theme markdown --gitRevision master --media tests/src/media/ --includes tests/src/inc/",
+    "mocks:bitbucket": "typedoc ./tests/src --out ./tests/out/bitbucket --theme markdown --gitRevision master --media tests/src/media/ --includes tests/src/inc/ --excludePrivate --readme none --mode file --mdFlavour bitbucket --mdSourceRepo 'https://bitbucket.org/owner/repository_name'",
+    "mocks:gitbook": "typedoc ./tests/src --out ./tests/out/gitbook --theme markdown --gitRevision master --mdFlavour gitbook --media tests/src/media/ --includes tests/src/inc/",
+    "mocks:html": "typedoc --out tests/out/html tests --media tests/src/media/ --includes tests/src/inc/",
     "lint": "tslint --project ./src/tsconfig.json",
@@ -19,0 +19,0 @@ "prepare": "rm -rf dist && tsc -p ./src/tsconfig.json && npm run copy:static",

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

Native code

Supply chain risk

Contains native code (e.g., compiled binaries or shared libraries). Including native code can obscure malicious behavior.

Found 2 instances 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

Improved metrics

Total package byte prevSize

53566

increased by32.21%

Number of package files

57

increased by3.64%

Lines of code

594

increased by1.37%

Worsened metrics

Number of medium supply chain risk alerts

2

increased byInfinity%

Number of versions

251

decreased by-0.4%

Published versions last week

1

decreased by-50%

Published versions last year

45

decreased by-2.17%

No dependency changes