npm - docgen-tool - Versions diffs - 2.1.3 → 3.0.1 - Mend

docgen-tool 2.1.3 → 3.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (113) hide show

package/dist/source/require/docgen.css ADDED Viewed

@@ -0,0 +1,138 @@
+pre {
+  font-size: 12px; /*todo - move to webknife*/
+}
+section blockquote p,
+section li p {
+  margin: 0;
+}
+.w-table {
+  width: 100%;
+}
+/******************************** TABLE OF CONTENTS ****************************/
+/*Table of contents button to initiate show/hide*/
+#dg-navigator {
+  float: right;
+  background-color: #4d4d4d;
+  color: white;
+  text-align: right;
+  padding: 10px 20px 10px 20px;
+  margin-right: 200px;
+  border-radius: 0 0 10px 10px;
+  cursor: pointer;
+  font-weight: bold;
+}
+/*Table of contents container*/
+#dg-toc {
+  color: white;
+  background-color: #4d4d4d;
+}
+#dg-toc table {
+  table-layout: auto;
+  width: 100%;
+}
+#dg-toc div {
+  padding: 15px 0 15px 0;
+}
+/*Columns in table of contents*/
+#dg-toc td {
+  border-right: 1px solid #666;
+  vertical-align: top;
+  text-align: left;
+  padding: 0 20px 0 20px;
+}
+#dg-toc ul {
+  padding: 0;
+  list-style-type: none;
+}
+#dg-toc li {
+  font-weight: bold;
+}
+#dg-toc table td a {
+  color: white;
+  font-weight: normal;
+  text-decoration: none;
+  margin-left: 10px;
+}
+#dg-toc table td a:hover {
+  text-decoration: underline;
+}
+#dg-tocFixedColumn {
+  border-right: none;
+}
+#dg-toc table #dg-tocFixedColumn a {
+  vertical-align: middle;
+  margin-left: 4px;
+}
+.dg-tocGroup {
+  width: 22%;
+}
+.dg-tocHeading {
+  font-size: 16px;
+}
+.dg-tocIcon {
+  width: 18px;
+  height: 18px;
+  float: left;
+}
+.dg-tocIcon svg {
+  fill: white;
+}
+/*
+	Page table of contents
+*/
+.dg-pageToc {
+  list-style: none;
+  padding: 10px;
+  border: 1px solid #999;
+  background-color: #eee;
+}
+/*
+	Class to make a heading look invisible in web page, but still appear in the PDF table of contents
+		- display:none, visibily: hidden, zero dimensions, and offscreen positioning don't work
+		- so instead take it out of the flow and make it small and translucent
+*/
+.dg-hiddenTitle {
+  display: block;
+  border: none;
+  margin: 0;
+  padding: 0;
+  width: 1px;
+  height: 1px;
+  overflow: hidden;
+  position: absolute;
+  background-color: transparent;
+}
+.dg-fakeHeading {
+  /*todo - move to webknife*/
+  text-decoration: none;
+  font-weight: bold;
+  color: #385691;
+  padding-bottom: 5px;
+  border-bottom: 1px solid #999;
+  margin: 20px 0 20px 0;
+  font-size: 16px;
+  padding-bottom: 4px;
+}

package/dist/source/require/katexInjector.js ADDED Viewed

@@ -0,0 +1,18 @@
+$(document).ready(function () {
+  //mathematical expressions using katex, if enabled
+  $('.dg-katexMath').each(function () {
+    var texTxt = $(this).text();
+    el = $(this).get(0);
+    if (el.tagName == 'DIV') {
+      addDisp = '\\displaystyle';
+    } else {
+      addDisp = '';
+    }
+    try {
+      katex.render(addDisp + texTxt, el);
+    } catch (err) {
+      $(this).html("<span class='err'>" + err);
+    }
+  });
+});

package/dist/source/require/print.css ADDED Viewed

@@ -0,0 +1,26 @@
+html {
+  background-color: white; /*otherwise background artefacts appear as a feint outline in PDF*/
+}
+.dg-pageToc {
+  display: none;
+}
+#dg-toc,
+#dg-navigator,
+header,
+footer {
+  display: none;
+}
+.dg-avoidBreak,
+#dg-content th,
+#dg-content tr,
+#dg-content blockquote,
+#dg-content pre {
+  page-break-inside: avoid;
+}
+.dg-forceBreak {
+  page-break-after: always;
+}

package/{source → dist/source}/templates/main.html RENAMED Viewed

@@ -1,93 +1,93 @@
-<!doctype html>
-<html>
- <head>
-  <meta http-equiv="X-UA-Compatible" content="IE=edge" ><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
-  <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
-  <meta charset="UTF-8">
-  <title></title>
-  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
-  <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css" />
-  <link rel="stylesheet" href="require/webknife/highlight.min.css" type="text/css" />
-  <link rel="stylesheet" href="require/docgen.css" type="text/css" />
-  <link rel="stylesheet" href="require/print.css" media="print" />
-  <!--load scripts second-->
-  <script src="require/webknife/framework.min.js"></script>
-  <script src="require/webknife/framework.icons.js"></script>
-  <script src="require/webknife/highlight.min.js"></script>
-  <!--inline scripts last-->
-<script type="text/javascript">
-$(document).ready( function () {
-  $("#dg-toc").hide(); //hide the table of contents
-  //instantiate an svg injector to show SVG icons
-  var injector = new svgInject();
-  injector.inject();
-  //code syntax highlighting
-  $('pre code, .w-inline-code').each(function(i, block) {
-    hljs.highlightBlock(block);
-  });
-  //toggle visibility of table of contents
-  $("#dg-navigator").click(function()
-  {
-    $("#dg-toc").slideToggle("fast");
-    $(this).toggleClass("active");
-  });
-});
-</script>
-<script type="text/x-mathjax-config">
-//MathJax configuration is the same as used by math.stackexchange.com
-MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX","TeX"], linebreaks: { automatic:true }, EqnChunk: (MathJax.Hub.Browser.isMobile ? 10 : 50) },
-  tex2jax: { inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, ignoreClass: "tex2jax_ignore|dno" },
-  TeX: {  noUndefined: { attributes: { mathcolor: "red", mathbackground: "#FFEEEE", mathsize: "90%" } }, Macros: { href: "{}" } },
-  messageStyle: "none"
-});
-</script>
-</head>
-<body>
-<div id="dg-toc"></div>
-<div id="dg-navigator">Table of contents</div>
-<header>
- <div class="w-fixed-width">
-  <a id="dg-homelink" href="">
-    <div id="dg-logo">
-      <span id="dg-title"></span> <span id="dg-web-title-version" style="font-weight:normal;"></span>
-    </div>
-  </a>
-  <div>
-    <span id="dg-backlink"></span>
-  </div>
- </div>
-</header>
-<section id="dg-content">
-</section>
- <footer>
-  <div><p class="w-fixed-width"><span id="dg-web-footer">.</p></div>
-  <div class="w-fixed-width">
-    <p><span id="dg-copyright"></span></p>
-    <p>
-      <span id="dg-marking"></span>
-      <span id="dg-legalese"></span>
-      <span id="dg-attribution"></span>
-    </p>
-  </div>
- </footer>
- </body>
-</html>
+<!doctype html>
+<html>
+ <head>
+  <meta http-equiv="X-UA-Compatible" content="IE=edge" ><!--Prevent IE using compatibility mode on local or intranet pages. Do not put scripts before this line.-->
+  <meta name="viewport" content="width=device-width, user-scalable=yes"><!--Mobile device scaling-->
+  <meta charset="UTF-8">
+  <title></title>
+  <!--load stylesheets first (rationale: https://developers.google.com/speed/docs/best-practices/rtt#PutStylesBeforeScripts)-->
+  <link rel="stylesheet" href="require/webknife/framework.min.css" type="text/css" />
+  <link rel="stylesheet" href="require/webknife/highlight.min.css" type="text/css" />
+  <link rel="stylesheet" href="require/docgen.css" type="text/css" />
+  <link rel="stylesheet" href="require/print.css" media="print" />
+  <!--load scripts second-->
+  <script src="require/webknife/framework.min.js"></script>
+  <script src="require/webknife/framework.icons.js"></script>
+  <script src="require/webknife/highlight.min.js"></script>
+  <!--inline scripts last-->
+<script type="text/javascript">
+$(document).ready( function () {
+  $("#dg-toc").hide(); //hide the table of contents
+  //instantiate an svg injector to show SVG icons
+  var injector = new svgInject();
+  injector.inject();
+  //code syntax highlighting
+  $('pre code, .w-inline-code').each(function(i, block) {
+    hljs.highlightBlock(block);
+  });
+  //toggle visibility of table of contents
+  $("#dg-navigator").click(function()
+  {
+    $("#dg-toc").slideToggle("fast");
+    $(this).toggleClass("active");
+  });
+});
+</script>
+<script type="text/x-mathjax-config">
+//MathJax configuration is the same as used by math.stackexchange.com
+MathJax.Hub.Config({"HTML-CSS": { preferredFont: "TeX", availableFonts: ["STIX","TeX"], linebreaks: { automatic:true }, EqnChunk: (MathJax.Hub.Browser.isMobile ? 10 : 50) },
+  tex2jax: { inlineMath: [ ["$", "$"], ["\\\\(","\\\\)"] ], displayMath: [ ["$$","$$"], ["\\[", "\\]"] ], processEscapes: true, ignoreClass: "tex2jax_ignore|dno" },
+  TeX: {  noUndefined: { attributes: { mathcolor: "red", mathbackground: "#FFEEEE", mathsize: "90%" } }, Macros: { href: "{}" } },
+  messageStyle: "none"
+});
+</script>
+</head>
+<body>
+<div id="dg-toc"></div>
+<div id="dg-navigator">Table of contents</div>
+<header>
+ <div class="w-fixed-width">
+  <a id="dg-homelink" href="">
+    <div id="dg-logo">
+      <span id="dg-title"></span> <span id="dg-web-title-version" style="font-weight:normal;"></span>
+    </div>
+  </a>
+  <div>
+    <span id="dg-backlink"></span>
+  </div>
+ </div>
+</header>
+<section id="dg-content">
+</section>
+ <footer>
+  <div><p class="w-fixed-width"><span id="dg-web-footer">.</p></div>
+  <div class="w-fixed-width">
+    <p><span id="dg-copyright"></span></p>
+    <p>
+      <span id="dg-marking"></span>
+      <span id="dg-legalese"></span>
+      <span id="dg-attribution"></span>
+    </p>
+  </div>
+ </footer>
+ </body>
+</html>

package/package.json CHANGED Viewed

@@ -1,35 +1,65 @@
 {
   "name": "docgen-tool",
-  "version": "2.1.3",
+  "version": "3.0.1",
   "description": "A tool for creating HTML and PDF documentation",
-  "main": "docgen",
-  "bin" : { "docgen" : "./docgen" },
+  "main": "dist/docgen.js",
+  "bin": {
+    "docgen": "dist/docgen.js"
+  },
+  "files": [
+    "dist/*"
+  ],
+  "scripts": {
+    "dev": "ts-node docgen.js run",
+    "build": "tsc -p tsconfig.json",
+    "run:build": "dist/docgen.js",
+    "build:docs": "ts-node docgen.js run -i ./source/user-guide -o ./docs -p -m -n -d 40000",
+    "test": "npm run prettier:check",
+    "test:run": "ts-node docgen.js run -i ./source/__test__/test-run -o ./source/__test__/test-run-output",
+    "prettier:check": "prettier --check 'docgen.js' '*.{js,json,css,less}'",
+    "prettier:fix": "prettier --write 'docgen.js' '*.{js,json,css,less}'"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "*.{js,json,css,less}": "prettier --write",
+    "docgen": "prettier --write"
+  },
   "dependencies": {
-    "rsvp": "3.0.18",
-    "commander": "2.8.1",
-    "cheerio": "0.19.0",
-    "markdown-it": "4.2.1",
-    "moment" : "2.10.3",
-    "z-schema": "3.10.2",
-    "chalk": "1.0.0",
-    "spawn-args": "0.1.0",
-    "cli-spinner": "0.2.1",
-    "image-size": "0.3.5",
-    "fs-extra": "0.18.4"
+    "chalk": "^4.1.0",
+    "cheerio": "^1.0.0-rc.12",
+    "cli-spinner": "^0.2.10",
+    "commander": "^11.0.0",
+    "fs-extra": "^11.1.1",
+    "husky": "^4.3.0",
+    "image-size": "^1.0.2",
+    "lint-staged": "^10.5.1",
+    "markdown-it": "^13.0.1",
+    "moment": "^2.29.4",
+    "rsvp": "^4.8.5",
+    "spawn-args": "^0.2.0",
+    "z-schema": "^6.0.1"
   },
   "devDependencies": {
-    },
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "@types/node": "^20.3.1",
+    "eslint": "^8.43.0",
+    "eslint-config-prettier": "^8.8.0",
+    "prettier": "^2.1.2",
+    "ts-node": "^10.9.1",
+    "tslib": "^2.5.3",
+    "typescript": "^5.1.3"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/mtmacdonald/docgen"
   },
-  "author": "Mark Macdonald",
+  "author": "Inkit Inc. and contributors",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/mtmacdonald/docgen/issues"
   },
-  "homepage": "https://github.com/mtmacdonald/docgen"
-}
+  "homepage": "http://mtmacdonald.github.io/docgen/docs/index.html"
+}

package/.npmignore DELETED Viewed

	@@ -1,2 +0,0 @@
1	- node_modules
2	- example/output