@ng-doc/utils 16.1.1 → 16.2.0

package/html/html-post-processor.d.ts

@@ -1,9 +1,10 @@
 import { NgDocHeading } from '@ng-doc/core';
-import { AddUsedKeyword, GetKeyword } from './plugins/keywords.plugin';
+import { AddKeyword, GetKeyword } from './plugins/keywords.plugin';
 export interface NgDocHtmlPostProcessorConfig {
     headings?: NgDocHeading[];
     route?: string;
-    addUsedKeyword?: AddUsedKeyword;
+    addUsedKeyword?: AddKeyword;
+    addPotentialKeyword?: AddKeyword;
     getKeyword?: GetKeyword;
 }
 /**

package/html/plugins/keywords.plugin.d.ts

@@ -1,12 +1,13 @@
 import { NgDocKeyword } from '@ng-doc/core/interfaces';
 import { Element } from 'hast';
-export type AddUsedKeyword = (keyword: string) => void;
+export type AddKeyword = (keyword: string) => void;
 export type GetKeyword = (keyword: string) => NgDocKeyword | undefined;
 /**
  *
  * @param entityStore
  * @param entity
  * @param addUsedKeyword
+ * @param addPotentialKeyword
  * @param getKeyword
  */
-export default function keywordsPlugin(addUsedKeyword?: AddUsedKeyword, getKeyword?: GetKeyword): (tree: Element) => void;
+export default function keywordsPlugin(addUsedKeyword?: AddKeyword, addPotentialKeyword?: AddKeyword, getKeyword?: GetKeyword): (tree: Element) => void;

package/index.js

@@ -15025,9 +15025,10 @@ const languages = ['typescript', 'ts'];
  * @param entityStore
  * @param entity
  * @param addUsedKeyword
+ * @param addPotentialKeyword
  * @param getKeyword
  */
-function keywordsPlugin(addUsedKeyword, getKeyword) {
+function keywordsPlugin(addUsedKeyword, addPotentialKeyword, getKeyword) {
   return tree => visitParents(tree, 'element', (node, ancestors) => {
     if (!isCodeNode(node)) {
       return;
@@ -15036,13 +15037,13 @@ function keywordsPlugin(addUsedKeyword, getKeyword) {
     const lang = node.properties?.['lang']?.toString() || '';
     if (isInlineCode || languages.includes(lang)) {
       visitParents(node, 'text', (node, ancestors) => {
-        if (hasLinkAncestor(ancestors) || !getKeyword || !addUsedKeyword) {
+        if (hasLinkAncestor(ancestors) || !getKeyword || !addUsedKeyword || !addPotentialKeyword) {
           return;
         }
         const parent = ancestors[ancestors.length - 1];
         const index = parent.children.indexOf(node);
         // Parse the text for words that we can convert to links
-        const nodes = getNodes(node, parent, isInlineCode, addUsedKeyword, getKeyword);
+        const nodes = getNodes(node, parent, isInlineCode, addUsedKeyword, addPotentialKeyword, getKeyword);
         // Replace the text node with the links and leftover text nodes
         // eslint-disable-next-line @typescript-eslint/ban-ts-comment
         // @ts-ignore
@@ -15061,15 +15062,16 @@ function keywordsPlugin(addUsedKeyword, getKeyword) {
  * @param inlineLink
  * @param e
  * @param addUsedKeyword
+ * @param addPotentialKeyword
  * @param getKeyword
  */
-function getNodes(node, parent, inlineLink, addUsedKeyword, getKeyword) {
+function getNodes(node, parent, inlineLink, addUsedKeyword, addPotentialKeyword, getKeyword) {
   const KeywordRegExp = /([A-Za-z0-9_.-/*]+)/;
   return toString(node).split(KeywordRegExp).filter(word => word.length).map(word => {
+    const keyword = getKeyword(word);
     if (KeywordRegExp.test(word)) {
-      addUsedKeyword(word);
+      keyword ? addUsedKeyword(word) : addPotentialKeyword(word);
     }
-    const keyword = getKeyword(word);
     if (inlineLink && /^\*\w+/gm.test(word) && !keyword) {
       console.log(`\n${chalk.blue('NgDoc:')} ${chalk.yellow(`Keyword "${word}" is missing.`)}`);
     }
@@ -15189,7 +15191,7 @@ async function htmlPostProcessor(html, config) {
     languages: {
       twig
     }
-  }).use(sluggerPlugin, config.headings).use(rehypeMinifyWhitespace).use(autolinkHeading, config.route).use(keywordsPlugin, config.addUsedKeyword, config.getKeyword).use(markElementsPlugin).use(markCodeBlocksPlugin).process(html).then(file => file.toString());
+  }).use(sluggerPlugin, config.headings).use(rehypeMinifyWhitespace).use(autolinkHeading, config.route).use(keywordsPlugin, config.addUsedKeyword, config.addPotentialKeyword, config.getKeyword).use(markElementsPlugin).use(markCodeBlocksPlugin).process(html).then(file => file.toString());
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ng-doc/utils",
-  "version": "16.1.1",
+  "version": "16.2.0",
   "type": "module",
   "dependencies": {
     "rehype": "12.0.1",