@@ -11,12 +11,16 @@ const RHDSAlphabetizeTagsPlugin = require('./alphabetize-tags.cjs');
1111const RHDSShortcodesPlugin = require ( './shortcodes.cjs' ) ;
1212const { parse } = require ( 'async-csv' ) ;
1313
14- /** @typedef {object } EleventyTransformContext */
14+ /**
15+ * @typedef {object } EleventyTransformContext the `this` binding for transform functions
16+ * @property {string } outputPath the path the page will be written to
17+ * @property {string } inputPath the path to the page's input file (e.g. template or paginator)
18+ */
1519
1620/**
1721 * Replace paths in demo files from the dev SPA's format to 11ty's format
1822 * @this {EleventyTransformContext}
19- * @param {string } content
23+ * @param {string } content the HTML content to replace
2024 */
2125function demoPaths ( content ) {
2226 const { outputPath, inputPath } = this ;
@@ -42,18 +46,23 @@ function demoPaths(content) {
4246}
4347
4448// Rewrite DEMO lightdom css relative URLs
45- const LIGHTDOM_HREF_RE = / h r e f = " \. (?< pathname > .* - l i g h t d o m \. c s s ) " / g;
49+ const LIGHTDOM_HREF_RE = / h r e f = " \. (?< pathname > .* - l i g h t d o m . * \. c s s ) " / g;
4650const LIGHTDOM_PATH_RE = / h r e f = " \. ( .* ) " / ;
4751
4852/**
49- * @param {string | number | Date } dateStr
53+ * @param {string | number | Date } dateStr iso date string
54+ * @param {Intl.DateTimeFormatOptions } options date format options
5055 */
5156function prettyDate ( dateStr , options = { } ) {
5257 const { dateStyle = 'medium' } = options ;
5358 return new Intl . DateTimeFormat ( 'en-US' , { dateStyle } )
5459 . format ( new Date ( dateStr ) ) ;
5560}
5661
62+ /**
63+ * @param {string } tagName e.g. pf-jazz-hands
64+ * @param {import("@patternfly/pfe-tools/config.js").PfeConfig } config pfe tools repo config
65+ */
5766function getTagNameSlug ( tagName , config ) {
5867 const name = config ?. aliases ?. [ tagName ] ?? tagName . replace ( `${ config ?. tagPrefix ?? 'rh' } , '' ) ;
5968 return slugify ( name , {
@@ -90,7 +99,7 @@ function getFilesToCopy() {
9099 . filter ( ent => ent . isDirectory ( ) )
91100 . map ( ent => ent . name ) ;
92101
93- /** @type {import('@patternfly/pfe-tools/config.js').PfeConfig }*/
102+ /** @type {import('@patternfly/pfe-tools/config.js').PfeConfig } */
94103 const config = require ( '../../.pfe.config.json' ) ;
95104
96105 // Copy all component and core files to _site
@@ -103,6 +112,10 @@ function getFilesToCopy() {
103112 } ) ) ;
104113}
105114
115+ /**
116+ * @param {{ slug: number; } } a first
117+ * @param {{ slug: number; } } b next
118+ */
106119function alphabeticallyBySlug ( a , b ) {
107120 return (
108121 a . slug < b . slug ? - 1
@@ -111,7 +124,7 @@ function alphabeticallyBySlug(a, b) {
111124 ) ;
112125}
113126
114- /** @param {import('@11ty/eleventy/src/UserConfig') } eleventyConfig */
127+ /** @param {import('@11ty/eleventy/src/UserConfig') } eleventyConfig user config */
115128module . exports = function ( eleventyConfig , { tagsToAlphabetize } ) {
116129 eleventyConfig . addDataExtension ( 'yml, yaml' , contents => yaml . load ( contents ) ) ;
117130
@@ -145,7 +158,7 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) {
145158 const { pfeconfig } = eleventyConfig ?. globalData ?? { } ;
146159 const { aliases } = pfeconfig ;
147160
148- if ( inputPath === './docs/elements/demos .html' ) {
161+ if ( inputPath === './docs/elements/demo .html' ) {
149162 const tagNameMatch = outputPath . match ( / \/ e l e m e n t s \/ (?< tagName > [ - \w ] + ) \/ d e m o \/ / ) ;
150163 if ( tagNameMatch ) {
151164 const { tagName } = tagNameMatch . groups ;
@@ -158,17 +171,17 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) {
158171
159172 // does the tagName exist in the aliases object?
160173 const key = Object . keys ( modifiedAliases ) . find ( key => modifiedAliases [ key ] === tagName ) ;
161-
162- const prefixedTagName = ` ${ pfeconfig ?. tagPrefix } - ${ tagName } ` ;
174+ const { deslugify } = await import ( '@patternfly/pfe-tools/config.js' ) ;
175+ const prefixedTagName = deslugify ( tagName , path . join ( __dirname , '../..' ) ) ;
163176 const redirect = { new : key ?? prefixedTagName , old : tagName } ;
164177 const matches = content . match ( LIGHTDOM_HREF_RE ) ;
165178 if ( matches ) {
166179 for ( const match of matches ) {
167180 const [ , path ] = match . match ( LIGHTDOM_PATH_RE ) ?? [ ] ;
168181 const { pathname } = new URL ( path , `file:///${ outputPath } ) ;
169- content = content . replace ( `. ${ path } ` , pathname
170- . replace ( `/_site/elements/ ${ redirect . old } /` , `/ assets/packages/@rhds/elements/elements/${ redirect . new } /` )
171- . replace ( '/demo/' , '/' ) ) ;
182+ const filename = pathname . split ( '/' ) . pop ( ) ;
183+ const replacement = `/ assets/packages/@rhds/elements/elements/${ prefixedTagName } / ${ filename } ` ;
184+ content = content . replace ( `. ${ path } ` , replacement ) ;
172185 }
173186 }
174187 }
@@ -189,7 +202,7 @@ module.exports = function(eleventyConfig, { tagsToAlphabetize }) {
189202 * NB: since the data for this shortcode is no a POJO,
190203 * but a DocsPage instance, 11ty assigns it to this.ctx._
191204 * @see https://github.com/11ty/eleventy/blob/bf7c0c0cce1b2cb01561f57fdd33db001df4cb7e/src/Plugins/RenderPlugin.js#L89-L93
192- * @type {import('@patternfly/pfe-tools/11ty/DocsPage').DocsPage }
205+ * @type {import('@patternfly/pfe-tools/11ty/DocsPage.js ').DocsPage }
193206 */
194207 const docsPage = this . ctx . _ ;
195208 return docsPage . description ;
0 commit comments