quick and dirty product name replacement

Author: josh-heyer

advocacy_docs/playground/1/01_examples/expression-replacement.mdx

@@ -0,0 +1,43 @@
+---
+title: "{{name.ln}} examples"
+navTitle: "{{name.short}}"
+description: "{{name.ln}} v{{version.full}} provides functionality for replacing simple expressions representing product names and versions"
+displayBanner: "{{name.ln}} v{{version.full}} is not a real product, but it plays one in the playground"
+product: "Expression Replacement"
+version: "1.0.1"
+---
+
+
+
+This functionality allows for writing documentation when the future (or current) name of a product is subject to change. It is based on the metadata in `src/constants/products.js` combined with product names and versions (defined via either filesystem or frontmatter) and allows multiple forms of a product name as well as transformations of semantic version numbers. 
+
+## Example products.js data definition
+
+```javascript
+"Expression Replacement": {
+  name: "Name and Version Expression Replacement Syntax",
+  shortName: "Expression Replacement",
+  abbreviation: "ExpRel",
+  commonCommandName: "{{name().type}}",
+}
+```
+
+## Examples of invocation
+
+| Expression                                        | Replacement                                   | Source                                                                                            |
+|---------------------------------------------------|-----------------------------------------------|---------------------------------------------------------------------------------------------------|
+| `\{{name.ln}}`                                    | {{name.ln}}                                   | product definition - `.name`                                                                      |
+| `\{{name.short}}`                                 | {{name.short}}                                | product definition - `.shortName`                                                                 |
+| `\{{name.abbr}}`                                  | {{name.abbr}}                                 | product definition - `.abbreviation`                                                              |
+| `\{{name.ccn}}`                                   | {{name.ccn}}                                  | product definition - `.commonCommandName`                                                         |
+| `\{{name(pgd).short}}`                            | {{name(pgd).short}}                           | PGD product definition - `.shortName`                                                             |
+| `\{{version.full}}`                               | {{version.full}}                              | frontmatter - `version:`                                                                          |
+| `\{{version(pgd).short}}`                         | {{version(pgd).short}}                        | filesystem directory version for latest product version                                           |
+| `\{{version(pgd).major}}.\{{version(pgd).minor}}` | {{version(pgd).major}}.{{version(pgd).minor}} | frontmatter - `version:` for latest product version. Parsed as semver, truncated at minor version |
+ 
+## Scope
+
+Expressions should be parsed in all Markdown elements containing rendered content, including code blocks and inline code. Frontmatter-sourced version information is not currently available in code. 
+
+Additionally, expressions will be replaced in certain frontmatter-defined values; initially, these include "title", "navTitle", "description" and "displayBanner".
+

gatsby-config.js

@@ -380,6 +380,7 @@ module.exports = {
         ],
         remarkPlugins: [
           [require("./src/plugins/code-in-tables")],
+          [require("./src/plugins/replacement-expression")],
           [
             require("remark-admonitions"),
             {

gatsby-node.js

@@ -7,6 +7,9 @@ const { createFilePath } = require(`gatsby-source-filesystem`);
 const { exec, execSync } = require("child_process");
 const util = require("node:util");
 const execAsync = util.promisify(exec);
+let expressionReplacement = import(
+  "./src/constants/expression-replacement.mjs"
+).then((module) => (expressionReplacement = module.default));
 
 const {
   replacePathVersion,
@@ -156,12 +159,12 @@ exports.onCreateNode = async ({
     Object.assign(nodeFields, {
       product: relativeFilePath.split("/")[1],
       version: relativeFilePath.split("/")[2],
-      topic: "null",
+      topic: "",
     });
   } else if (nodeFields.docType === "advocacy") {
     Object.assign(nodeFields, {
-      product: "null",
-      version: "0",
+      product: "",
+      version: "",
       topic: relativeFilePath.split("/")[2],
     });
   }
@@ -192,6 +195,7 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
             legacyRedirects
             legacyRedirectsGenerated
             navigation
+            product
             showInteractiveBadge
             hideToC
             deepToC
@@ -292,6 +296,21 @@ exports.createPages = async ({ actions, graphql, reporter }) => {
 
     const node = curr.mdxNode;
 
+    // do expression replacements in frontmatter
+    const replacementArgs = {
+      currentProduct: node.fields.product || node.frontmatter.product,
+      currentVersion: node.fields.version || node.frontmatter.version,
+      currentFullVersion: node.frontmatter.version,
+      productVersions,
+      filename: node.fileAbsolutePath,
+    };
+    for (let fmk of ["title", "navTitle", "description", "displayBanner"]) {
+      node.frontmatter[fmk] = expressionReplacement({
+        text: node.frontmatter[fmk],
+        ...replacementArgs,
+      });
+    }
+
     // build navigation tree
     const navigationDepth = 1;
     let navRoot = curr;