fix(tools): calculate path to demo files

Closes #2376

Author: bennypowers

.changeset/famous-cars-dress.md

@@ -0,0 +1,5 @@
+---
+"@patternfly/pfe-tools": patch
+---
+
+11ty plugin: calculate path to demo files in more circumstances

tools/pfe-tools/11ty/plugins/custom-elements-manifest.cjs

@@ -18,17 +18,17 @@ const isDir = dir => stat(dir).then(x => x.isDirectory, () => false);
 // TODO: programmable package scopes, etc
 /**
  * @param {*} eleventyConfig
- * @param {import('./types').PluginOptions} _options
+ * @param {import('./types').PluginOptions} pluginOpts
  */
-module.exports = function configFunction(eleventyConfig, _options = {}) {
+module.exports = function configFunction(eleventyConfig, pluginOpts = {}) {
   eleventyConfig.addPlugin(EleventyRenderPlugin);
 
   eleventyConfig.addGlobalData('env', () => process.env);
 
   eleventyConfig.addGlobalData('demos', async function demos() {
     const { Manifest } = await import('../../custom-elements-manifest/lib/Manifest.js');
     const { getPfeConfig } = await import('../../config.js');
-    const options = { ...getPfeConfig(), ..._options };
+    const options = { ...getPfeConfig(), ...pluginOpts };
     const extraDemos = options?.extraDemos ?? [];
 
     // 1. get all packages
@@ -45,7 +45,7 @@ module.exports = function configFunction(eleventyConfig, _options = {}) {
     const { Manifest } = await import('../../custom-elements-manifest/lib/Manifest.js');
     const { DocsPage } = await import('../DocsPage.js');
     const { getPfeConfig } = await import('../../config.js');
-    const options = { ...getPfeConfig(), ..._options };
+    const options = { ...getPfeConfig(), ...pluginOpts };
     const rootDir = options?.rootDir ?? process.cwd();
 
     // 1. get all packages
@@ -54,16 +54,16 @@ module.exports = function configFunction(eleventyConfig, _options = {}) {
     return Manifest.getAll(rootDir)
       .flatMap(manifest =>
         Array.from(manifest.declarations.values(), decl => {
-          // NB: not a great proxy for monorepo
-          const isSinglepackage = decl.module?.path?.startsWith?.('elements/') ?? false;
-          const root = isSinglepackage ? dirname(decl.module.path) : '.';
           const { tagName } = decl;
-          const docsTemplatePath = join(manifest.location, root, tagName, 'docs', `${tagName}.md`);
+          const elementsDir = options.elementsDir ?? 'elements';
+          const root = manifest.location ?? options.rootDir;
+          const docsTemplatePath = join(root, elementsDir, `${tagName}`, 'docs', `${tagName}.md`);
           return new DocsPage(manifest, {
             ...options,
             tagName,
             // only include the template if it exists
-            ...Object.fromEntries(Object.entries({ docsTemplatePath }).filter(([, v]) => existsSync(v)))
+            ...Object.fromEntries(Object.entries({ docsTemplatePath }).filter(([, path]) =>
+              existsSync(path)))
           });
         }));
   });

tools/pfe-tools/config.ts

@@ -20,6 +20,8 @@ export interface PfeConfig {
   rootDir?: string;
   /** object mapping custom element name to page title */
   aliases?: Record<string, string> ;
+  /** Directory containing the custom elements, defaults to `elements` */
+  elementsDir?: string;
   /** absolute URL to the web page representing the repo root in source control, with trailing slash. default 'https://github.com/patternfly/patternfly-elements/tree/main/' */
   sourceControlURLPrefix?: string ;
   /** absolute URL prefix for demos, with trailing slash. Default 'https://patternflyelements.org/' */