Minor changes to adhere to existing README.md

koddsson · keithamus · koddsson · commit 3132ac622071 · 2022-08-12T11:18:56.000+02:00
Co-authored-by: Keith Cirkel &lt;keithamus@users.noreply.github.com&gt;
diff --git a/cem-plugin-readme.js b/cem-plugin-readme.js
@@ -24,7 +24,7 @@ function generateTitle({packageJson: {name}}) {
     .split('/')
     .at(-1)
     .replace(/-element$/, '')
-  return `&lt;${formattedName}&gt; element`
+  return escapeHTML(`<${formattedName}> element`)
 }
 
 function generateImportInstructions({packageJson: {name}}) {
@@ -64,9 +64,8 @@ export function readme(options) {
         generateImportInstructions({packageJson}),
       ]
       for (const module of customElementsManifest.modules) {
-        for (const {name, tagName, description} of module.declarations.filter(x => x.customElement)) {
+        for (const {name, description} of module.declarations.filter(x => x.customElement)) {
           if (exclude.includes(name)) continue
-          content.push(`### ${tagName}`)
           content.push(description.trim())
         }
       }

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@ function generateTitle({packageJson: {name}}) {`
`24`	`24`	`.split('/')`
`25`	`25`	`.at(-1)`
`26`	`26`	`.replace(/-element$/, '')`
`27`		- return `<${formattedName}> element`
	`27`	+ return escapeHTML(`<${formattedName}> element`)
`28`	`28`	`}`
`29`	`29`
`30`	`30`	`function generateImportInstructions({packageJson: {name}}) {`
`@@ -64,9 +64,8 @@ export function readme(options) {`
`64`	`64`	`generateImportInstructions({packageJson}),`
`65`	`65`	`]`
`66`	`66`	`for (const module of customElementsManifest.modules) {`
`67`		`- for (const {name, tagName, description} of module.declarations.filter(x => x.customElement)) {`
	`67`	`+ for (const {name, description} of module.declarations.filter(x => x.customElement)) {`
`68`	`68`	`if (exclude.includes(name)) continue`
`69`		- content.push(`### ${tagName}`)
`70`	`69`	`content.push(description.trim())`
`71`	`70`	`}`
`72`	`71`	`}`