@forsakringskassan/docs-generator 2.9.0 → 2.9.2

package/dist/compile-example.js

@@ -105,6 +105,7 @@ async function compileExample(batch) {
       external,
       tsconfig,
       define: {
+        "process.env.NODE_ENV": JSON.stringify("development"),
         "process.env.DOCS_ICON_LIB": JSON.stringify(iconLib)
       },
       plugins: [

package/dist/index.d.ts

@@ -371,6 +371,7 @@ export declare interface NavigationSection {
     readonly path: string;
     readonly sortorder: number;
     readonly children: NavigationNode[];
+    readonly visible: boolean;
 }
 
 /**
@@ -619,6 +620,8 @@ export declare function themeSelectProcessor(): Processor;
 export declare interface TopnavEntry {
     path: string;
     title: string;
+    sortorder?: number;
+    visible?: boolean;
 }
 
 /**

package/dist/index.js

@@ -440,6 +440,7 @@ function generateNavigation(entries) {
       key,
       sortorder: index,
       children: [],
+      visible: true,
       ...it
     };
   });
@@ -447,7 +448,8 @@ function generateNavigation(entries) {
     key: ".",
     path: "./index.html",
     sortorder: Infinity,
-    children
+    children,
+    visible: true
   };
 }
 function topnavProcessor(filename, title) {
@@ -789,6 +791,16 @@ async function translateAPI(filePath) {
   const props = api.props ? translateProps(api.props) : [];
   const events = api.events ? translateEvents(api.events) : [];
   const slots = api.slots ? translateSlots(api.slots) : [];
+  for (const event of events) {
+    if (!event.name.startsWith("update:")) {
+      continue;
+    }
+    const prop = event.name.slice("update:".length);
+    const entry = props.find((it) => it.name === prop);
+    if (entry) {
+      entry.name = prop === "modelValue" ? "v-model" : `v-model:${prop}`;
+    }
+  }
   return {
     props,
     events,
@@ -1337,18 +1349,20 @@ function getParentKey(name) {
 }
 function generateNavtree(docs) {
   const section = {};
-  function createSection(key, title, sortorder) {
+  function createSection(key, title, sortorder, { visible } = {}) {
     const existing = section[key];
     if (existing) {
       existing.title = title;
       existing.sortorder = sortorder;
+      existing.visible = visible ?? true;
     } else {
       const node = {
         key,
         title,
         path: "",
         sortorder,
-        children: []
+        children: [],
+        visible: visible ?? true
       };
       section[key] = node;
       if (key !== ".") {
@@ -1368,7 +1382,8 @@ function generateNavtree(docs) {
       title: parentKey.split("/").at(-1) ?? "(missing title)",
       path: "",
       sortorder: Infinity,
-      children: []
+      children: [],
+      visible: true
     };
     section[parentKey] = parent;
     let anchestor = parentKey;
@@ -1384,7 +1399,8 @@ function generateNavtree(docs) {
         title: "",
         path: "",
         sortorder: Infinity,
-        children: [current]
+        children: [current],
+        visible: true
       };
       section[anchestor] = node;
       current = node;
@@ -1415,7 +1431,7 @@ function generateNavtree(docs) {
     }
     if (!doc.visible) {
       if (isSection) {
-        createSection(name, title, sortorder);
+        createSection(name, title, sortorder, { visible: false });
       }
       continue;
     }
@@ -1438,13 +1454,15 @@ function generateNavtree(docs) {
         existing.path = leafNode.path;
         existing.sortorder = sortorder;
         existing.children.unshift(leafNode);
+        existing.visible = true;
       } else {
         const sectionNode = {
           key: name,
           title,
           path: leafNode.path,
           sortorder,
-          children: [leafNode]
+          children: [leafNode],
+          visible: true
         };
         section[name] = sectionNode;
         parent.children.push(sectionNode);
@@ -1469,7 +1487,8 @@ function generateNavtree(docs) {
       title: "",
       path: "",
       sortorder: Infinity,
-      children: []
+      children: [],
+      visible: true
     };
   }
 }
@@ -2005,9 +2024,10 @@ async function compileVendor(assetFolder, vendor, options) {
     platform: "browser",
     tsconfig,
     define: {
-      "process.env.NODE_ENV": JSON.stringify(
-        process.env.NODE_ENV ?? "production"
-      )
+      "process.env.NODE_ENV": JSON.stringify("development"),
+      __VUE_OPTIONS_API__: "true",
+      __VUE_PROD_DEVTOOLS__: "true",
+      __VUE_PROD_HYDRATION_MISMATCH_DETAILS__: "false"
     },
     alias: vendor.alias ? { [`${vendor.package}`]: vendor.alias } : void 0,
     ...options
@@ -2237,14 +2257,16 @@ function createContext(templateLoader) {
     title: "",
     path: "",
     sortorder: Infinity,
-    children: []
+    children: [],
+    visible: true
   };
   let sidenav = {
     key: ".",
     title: "",
     path: "",
     sortorder: Infinity,
-    children: []
+    children: [],
+    visible: true
   };
   const templateData = {};
   return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forsakringskassan/docs-generator",
-  "version": "2.9.0",
+  "version": "2.9.2",
   "description": "Documentation generator",
   "keywords": [
     "documentation"

package/templates/partials/topnav.html

@@ -5,10 +5,11 @@
         {% set navPath = nav.path | replace("html", "") %}
         {% set navPath = navPath | replace(".", "") %}
         {% set activePage = navPath in doc.fileInfo.fullPath %}
+        {% if nav.visible %}
         <li class="docs-topnav__item {% if activePage %}highlight{% endif %}">
             <a class="docs-topnav__anchor" href="{{ nav.path | relative(doc) }}"> {{ nav.title }} </a>
         </li>
-        {%- endfor -%}
+        {% endif %} {%- endfor -%}
         <li class="docs-topnav__item docs-topnav__item--more" style="visibility: hidden">
             <button type="button" class="docs-topnav__anchor" aria-expanded="false">
                 <span>Mer</span>
@@ -23,10 +24,11 @@
                     {% set navPath = nav.path | replace("html", "") %}
                     {% set navPath = navPath | replace(".", "") %}
                     {% set activePage = navPath in doc.fileInfo.fullPath %}
+                    {% if nav.visible %}
                     <li class="docs-contextmenu__item {% if activePage %}highlight{% endif %}" style="display: none">
                         <a class="docs-contextmenu__anchor" href="{{ nav.path | relative(doc) }}"> {{ nav.title }} </a>
                     </li>
-                    {%- endfor -%}
+                    {% endif %} {%- endfor -%}
                 </ul>
             </div>
         </li>