@forsakringskassan/docs-generator 1.30.10 → 1.31.0

package/dist/{create-markdown-renderer-BarACCRE.js → create-markdown-renderer-CjwHt5p0.js}

@@ -124,7 +124,7 @@ function getLinkTitle(doc, key, explicitTitle) {
     return explicitTitle;
   }
   const { title, component } = doc.attributes;
-  if (component && component.includes(key)) {
+  if (component && component.some((it) => it.name === key)) {
     return `<code>${key}</code>`;
   } else {
     return title ?? doc.name;

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Component } from 'vue';
+import { Component as Component_2 } from 'vue';
 
 /** @public */
 export declare type AttributeTable = Record<string, AttributeValue>;
@@ -26,6 +26,13 @@ export declare interface CompileOptions {
     attributes: AttributeTable;
 }
 
+declare interface Component {
+    /** component name */
+    name: string;
+    /** optional hint (glob pattern) how to find the component */
+    source?: string;
+}
+
 /**
  * Tiny wrapper to provide type completion for IDE.
  *
@@ -323,7 +330,7 @@ export declare interface NormalizedDocumentAttributes {
     layout?: string;
     status?: string;
     badge?: DocumentBadge;
-    component?: string[];
+    component?: Component[];
     href?: string;
     /** normalized sortorder (defaults to Infinity) */
     sortorder: number;
@@ -432,7 +439,7 @@ export declare function searchProcessor(): Processor;
 export declare function selectableVersionProcessor(pkg: {
     name: string;
     version: string;
-}, container: string): Processor;
+}, container: string, options?: ProcessorOptions): Processor;
 
 /**
  * Options passed from the example compiler to the `setup` function.
@@ -441,7 +448,7 @@ export declare function selectableVersionProcessor(pkg: {
  */
 export declare interface SetupOptions {
     /** The example component expected to be mounted by the application */
-    rootComponent: Component;
+    rootComponent: Component_2;
     /** Where the example should be mounted */
     selector: string;
 }
@@ -462,6 +469,25 @@ export declare interface SourceFiles {
     transform?(doc: Document_2): Document_2;
 }
 
+/**
+ * Processor that provide `componentSourceUrl` template function used for resolving
+ * component source urls.
+ *
+ * @public
+ */
+export declare function sourceUrlProcessor(options: SourceUrlProcessorOptions): Processor;
+
+/**
+ * Options for {@link sourceUrlProcessor}.
+ *
+ * @public
+ */
+export declare interface SourceUrlProcessorOptions extends ProcessorOptions {
+    readonly urlFormat: string;
+    /** File extension used for finding component by name */
+    readonly componentFileExtension?: string;
+}
+
 /* Excluded from this release type: TemplateBlockData */
 
 /**

package/dist/index.js

@@ -3,7 +3,7 @@
 var fs = require('node:fs/promises');
 var path = require('node:path');
 var vendor = require('./vendor-DD1glhBC.js');
-var createMarkdownRenderer = require('./create-markdown-renderer-BarACCRE.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-CjwHt5p0.js');
 var require$$1 = require('crypto');
 require('node:crypto');
 var vueDocgenApi = require('vue-docgen-api');
@@ -211,6 +211,20 @@ function getComponentAlias(attrs) {
     return [];
   }
 }
+function getComponent(attrs) {
+  if (!attrs.component) {
+    return void 0;
+  }
+  return toArray$3(attrs.component).map((it) => {
+    if (typeof it === "string") {
+      return {
+        name: it
+      };
+    } else {
+      return it;
+    }
+  });
+}
 function parseFile$1(filePath, basePath, content) {
   const relative = basePath ? path.relative(basePath, createMarkdownRenderer.normalizePath(filePath)) : createMarkdownRenderer.normalizePath(filePath);
   const parsed = path.parse(relative);
@@ -232,7 +246,7 @@ function parseFile$1(filePath, basePath, content) {
       layout: attributes.layout,
       status: attributes.status,
       badge: getBadge(attributes),
-      component: attributes.component ? toArray$3(attributes.component) : void 0,
+      component: getComponent(attributes),
       sortorder: attributes.sortorder ?? Infinity
     },
     body: blocks.body,
@@ -1670,6 +1684,7 @@ async function serve(options) {
     const key = await keypress();
     switch (key) {
       case "":
+      /* ctrl-c */
       case "q":
         console.log("Shutting down gracefully");
         server.close();
@@ -2085,11 +2100,15 @@ function themeSelectProcessor() {
   };
 }
 
-function selectableVersionProcessor(pkg, container) {
+function selectableVersionProcessor(pkg, container, options) {
+  const { enabled = true } = options ?? {};
   return {
     name: "selectable-version-processor",
     after: "generate-docs",
     handler(context) {
+      if (!enabled) {
+        return;
+      }
       context.addTemplateBlock(container, "version", {
         filename: "partials/selectable-version.html",
         data: { pkg }
@@ -2219,6 +2238,29 @@ function versionProcessor(pkg, container, options) {
   };
 }
 
+function sourceUrlProcessor(options) {
+  const {
+    enabled = true,
+    urlFormat,
+    componentFileExtension = "vue"
+  } = options;
+  function componentSourceUrl(component) {
+    const filename = component.source ?? `${component.name}.${componentFileExtension}`;
+    const path = getExampleImport(["./"], filename);
+    return interpolate(urlFormat, { path });
+  }
+  return {
+    after: "generate-docs",
+    name: "source-url-processor",
+    async handler(context) {
+      if (!enabled) {
+        return;
+      }
+      context.setTemplateData("componentSourceUrl", componentSourceUrl);
+    }
+  };
+}
+
 function generateIndex(entries) {
   const index = {
     terms: [],
@@ -2243,9 +2285,9 @@ function generateIndex(entries) {
 function extractTerms(doc) {
   const { title, component } = doc.attributes;
   if (title && component) {
-    return component.map((it) => `${title} (${it})`);
+    return component.map((it) => `${title} (${it.name})`);
   } else if (component) {
-    return component;
+    return component.map((it) => it.name);
   } else if (title) {
     return [title];
   } else {
@@ -2317,6 +2359,7 @@ exports.motdProcessor = motdProcessor;
 exports.navigationFileReader = navigationFileReader;
 exports.searchProcessor = searchProcessor;
 exports.selectableVersionProcessor = selectableVersionProcessor;
+exports.sourceUrlProcessor = sourceUrlProcessor;
 exports.themeSelectProcessor = themeSelectProcessor;
 exports.topnavProcessor = topnavProcessor;
 exports.versionBannerProcessor = versionBannerProcessor;

package/dist/markdown.d.ts

@@ -1,3 +1,10 @@
+declare interface Component {
+    /** component name */
+    name: string;
+    /** optional hint (glob pattern) how to find the component */
+    source?: string;
+}
+
 /**
  * @public
  */
@@ -200,7 +207,7 @@ export declare interface NormalizedDocumentAttributes {
     layout?: string;
     status?: string;
     badge?: DocumentBadge;
-    component?: string[];
+    component?: Component[];
     href?: string;
     /** normalized sortorder (defaults to Infinity) */
     sortorder: number;

package/dist/markdown.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var createMarkdownRenderer = require('./create-markdown-renderer-BarACCRE.js');
+var createMarkdownRenderer = require('./create-markdown-renderer-CjwHt5p0.js');
 require('./vendor-DD1glhBC.js');
 require('node:url');
 require('node:path');

package/dist/runtime.js

@@ -6138,6 +6138,7 @@ var init_linear2 = __esm({
             break;
           case 1:
             this._point = 2;
+          // falls through
           default:
             this._context.lineTo(x3, y3);
             break;
@@ -6318,6 +6319,7 @@ var init_bump = __esm({
           }
           case 1:
             this._point = 2;
+          // falls through
           default: {
             if (this._x) this._context.bezierCurveTo(this._x0 = (this._x0 + x3) / 2, this._y0, this._x0, y3, x3, y3);
             else this._context.bezierCurveTo(this._x0, this._y0 = (this._y0 + y3) / 2, x3, this._y0, x3, y3);
@@ -6372,6 +6374,7 @@ var init_basis2 = __esm({
         switch (this._point) {
           case 3:
             point2(this, this._x1, this._y1);
+          // falls through
           case 2:
             this._context.lineTo(this._x1, this._y1);
             break;
@@ -6392,6 +6395,7 @@ var init_basis2 = __esm({
           case 2:
             this._point = 3;
             this._context.lineTo((5 * this._x0 + this._x1) / 6, (5 * this._y0 + this._y1) / 6);
+          // falls through
           default:
             point2(this, x3, y3);
             break;
@@ -6510,6 +6514,7 @@ var init_basisOpen = __esm({
             break;
           case 3:
             this._point = 4;
+          // falls through
           default:
             point2(this, x3, y3);
             break;
@@ -6622,6 +6627,7 @@ var init_cardinal = __esm({
             break;
           case 2:
             this._point = 3;
+          // falls through
           default:
             point3(this, x3, y3);
             break;
@@ -6753,6 +6759,7 @@ var init_cardinalOpen = __esm({
             break;
           case 3:
             this._point = 4;
+          // falls through
           default:
             point3(this, x3, y3);
             break;
@@ -6836,6 +6843,7 @@ var init_catmullRom = __esm({
             break;
           case 2:
             this._point = 3;
+          // falls through
           default:
             point4(this, x3, y3);
             break;
@@ -6981,6 +6989,7 @@ var init_catmullRomOpen = __esm({
             break;
           case 3:
             this._point = 4;
+          // falls through
           default:
             point4(this, x3, y3);
             break;
@@ -7230,6 +7239,7 @@ var init_step = __esm({
             break;
           case 1:
             this._point = 2;
+          // falls through
           default: {
             if (this._t <= 0) {
               this._context.lineTo(this._x, y3);
@@ -11022,12 +11032,14 @@ function slice2(begin, end2) {
 }
 function token(type3) {
   switch (type3) {
+    // \0 \t \n \r \s whitespace token
     case 0:
     case 9:
     case 10:
     case 13:
     case 32:
       return 5;
+    // ! + , / > @ ~ isolate token
     case 33:
     case 43:
     case 44:
@@ -11035,17 +11047,21 @@ function token(type3) {
     case 62:
     case 64:
     case 126:
+    // ; { } breakpoint token
     case 59:
     case 123:
     case 125:
       return 4;
+    // : accompanied token
     case 58:
       return 3;
+    // " ' ( [ opening delimit token
     case 34:
     case 39:
     case 40:
     case 91:
       return 2;
+    // ) ] closing delimit token
     case 41:
     case 93:
       return 1;
@@ -11078,17 +11094,21 @@ function escaping(index3, count) {
 function delimiter(type3) {
   while (next2())
     switch (character) {
+      // ] ) " '
       case type3:
         return position;
+      // " '
       case 34:
       case 39:
         if (type3 !== 34 && type3 !== 39)
           delimiter(character);
         break;
+      // (
       case 40:
         if (type3 === 41)
           delimiter(type3);
         break;
+      // \
       case 92:
         next2();
         break;
@@ -11143,26 +11163,31 @@ function parse(value2, root3, parent, rule, rules, rulesets, pseudo, points, dec
   var characters2 = type3;
   while (scanning)
     switch (previous2 = character2, character2 = next2()) {
+      // (
       case 40:
         if (previous2 != 108 && charat(characters2, length2 - 1) == 58) {
           if (indexof(characters2 += replace(delimit(character2), "&", "&\f"), "&\f") != -1)
             ampersand = -1;
           break;
         }
+      // " ' [
       case 34:
       case 39:
       case 91:
         characters2 += delimit(character2);
         break;
+      // \t \n \r \s
       case 9:
       case 10:
       case 13:
       case 32:
         characters2 += whitespace(previous2);
         break;
+      // \
       case 92:
         characters2 += escaping(caret() - 1, 7);
         continue;
+      // /
       case 47:
         switch (peek()) {
           case 42:
@@ -11173,22 +11198,28 @@ function parse(value2, root3, parent, rule, rules, rulesets, pseudo, points, dec
             characters2 += "/";
         }
         break;
+      // {
       case 123 * variable:
         points[index3++] = strlen(characters2) * ampersand;
+      // } ; \0
       case 125 * variable:
       case 59:
       case 0:
         switch (character2) {
+          // \0 }
           case 0:
           case 125:
             scanning = 0;
+          // ;
           case 59 + offset:
             if (ampersand == -1) characters2 = replace(characters2, /\f/g, "");
             if (property2 > 0 && strlen(characters2) - length2)
               append2(property2 > 32 ? declaration(characters2 + ";", rule, parent, length2 - 1, declarations) : declaration(replace(characters2, " ", "") + ";", rule, parent, length2 - 2, declarations), declarations);
             break;
+          // @ ;
           case 59:
             characters2 += ";";
+          // { rule/at-rule
           default:
             append2(reference = ruleset(characters2, root3, parent, index3, offset, rules, points, type3, props = [], children2 = [], length2, rulesets), rulesets);
             if (character2 === 123)
@@ -11196,6 +11227,7 @@ function parse(value2, root3, parent, rule, rules, rulesets, pseudo, points, dec
                 parse(characters2, root3, reference, reference, props, rulesets, length2, points, children2);
               else
                 switch (atrule === 99 && charat(characters2, 3) === 110 ? 100 : atrule) {
+                  // d l m s
                   case 100:
                   case 108:
                   case 109:
@@ -11208,6 +11240,7 @@ function parse(value2, root3, parent, rule, rules, rulesets, pseudo, points, dec
         }
         index3 = offset = property2 = 0, variable = ampersand = 1, type3 = characters2 = "", length2 = pseudo;
         break;
+      // :
       case 58:
         length2 = 1 + strlen(characters2), property2 = previous2;
       default:
@@ -11218,17 +11251,21 @@ function parse(value2, root3, parent, rule, rules, rulesets, pseudo, points, dec
             continue;
         }
         switch (characters2 += from(character2), character2 * variable) {
+          // &
           case 38:
             ampersand = offset > 0 ? 1 : (characters2 += "\f", -1);
             break;
+          // ,
           case 44:
             points[index3++] = (strlen(characters2) - 1) * ampersand, ampersand = 1;
             break;
+          // @
           case 64:
             if (peek() === 45)
               characters2 += delimit(next2());
             atrule = peek(), offset = length2 = strlen(type3 = characters2 += identifier(caret())), character2++;
             break;
+          // -
           case 45:
             if (previous2 === 45 && strlen(characters2) == 2)
               variable = 0;
@@ -22180,6 +22217,7 @@ var init_katex = __esm({
             case "mspace":
             case "mtext":
               break;
+            // Do nothing yet.
             case "mo": {
               var child = node3.children[0];
               if (node3.children.length === 1 && child instanceof mathMLTree.TextNode) {
@@ -172765,6 +172803,7 @@ var require_cytoscape_cjs = __commonJS({
         warn("Do not assign mappings to elements without corresponding data (i.e. ele `" + ele.id() + "` has no mapping for property `" + prop.name + "` with data field `" + prop.field + "`); try a `[" + prop.field + "]` selector to limit scope to elements with `" + prop.field + "` defined");
       };
       switch (prop.mapped) {
+        // flatten the property if mapped
         case types.mapData: {
           var fields = prop.field.split(".");
           var fieldVal = _p.data;
@@ -172825,6 +172864,7 @@ var require_cytoscape_cjs = __commonJS({
           prop = flatProp;
           break;
         }
+        // direct mapping
         case types.data: {
           var _fields = prop.field.split(".");
           var _fieldVal = _p.data;
@@ -172862,6 +172902,7 @@ var require_cytoscape_cjs = __commonJS({
         }
         case void 0:
           break;
+        // just set the property
         default:
           return false;
       }
@@ -202230,6 +202271,8 @@ var require_semver = __commonJS({
             this.inc("patch", identifier2, identifierBase);
             this.inc("pre", identifier2, identifierBase);
             break;
+          // If the input is a non-prerelease version, this acts the same as
+          // prepatch.
           case "prerelease":
             if (this.prerelease.length === 0) {
               this.inc("patch", identifier2, identifierBase);
@@ -202257,6 +202300,8 @@ var require_semver = __commonJS({
             }
             this.prerelease = [];
             break;
+          // This probably shouldn't be used publicly.
+          // 1.0.0 'pre' would become 1.0.0-0 which is the wrong direction.
           case "pre": {
             const base = Number(identifierBase) ? 1 : 0;
             if (!identifier2 && identifierBase === false) {
@@ -203300,6 +203345,7 @@ var require_min_version = __commonJS({
                 compver.prerelease.push(0);
               }
               compver.raw = compver.format();
+            /* fallthrough */
             case "":
             case ">=":
               if (!setMin || gt(compver, setMin)) {
@@ -203309,6 +203355,7 @@ var require_min_version = __commonJS({
             case "<":
             case "<=":
               break;
+            /* istanbul ignore next */
             default:
               throw new Error(`Unexpected operation: ${comparator.operator}`);
           }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.47.5"
+      "packageVersion": "7.47.6"
     }
   ]
 }

package/package.json

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

package/templates/component.template.html

@@ -8,7 +8,12 @@
     <dt>Komponent</dt>
     <dd>
         {% for component in doc.attributes.component %}
-        <code>{{ component }}</code>{% if not loop.last %}, {% endif %} {% endfor %}
+        <code>
+            {% if componentSourceUrl and componentSourceUrl(component) %}
+            <a href="{{ componentSourceUrl(component) }}">{{ component.name }}</a>
+            {% else %} {{ component.name }} {% endif %}
+        </code>
+        {% if not loop.last %}, {% endif %} {% endfor %}
     </dd>
     {% endif %}