Skip to content

Fix bug in label parsing #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 3, 2024
Merged

Fix bug in label parsing #232

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77a0d59
fix label parse, ignore discrete headers
recrwplay Jun 3, 2024
52f3123
Review comment
recrwplay Jun 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions preview-src/docs-roles.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
= Docs roles with a long title
:page-role: not-on-aura new-5.17
:page-role: alpha aura-db-enterprise beta deprecated-5.17 invented-label new-5.17 not-on-aura
:page-theme: docs
:page-banner: warning
:page-banner-text: Lorem ipsum dolor sit est.
Expand All @@ -22,7 +22,7 @@ Blocks with the appropriate roles have labels added.
[role="label--new-5.17 label--enterprise-edition"]
=== (Discrete) H3 AuraDB Enterprise AND Not on Aura

Lorem ipsum dolor sit
Labels are not displayed for discrete headers.


[role=label--aura-db-enterprise label--not-on-aura]
Expand Down
24 changes: 14 additions & 10 deletions src/js/60-docs-roles.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ document.addEventListener('DOMContentLoaded', function () {
var label = role.replace('label--', '')
var labelParts = label.split('-')

// label could be eg label--new-5.19 but in rolesData it's just new
label = rolesData[labelParts[0]] ? labelParts[0] : label
// label could be eg aura-db-enterprise - we use the full label
// label could be eg new-5.20 - we use 'new' for the label and add the version as text
label = (rolesData[label] && rolesData[label].category !== 'version') ? label : labelParts[0]

// ignore labels that are not defined in rolesData
if (!rolesData[label]) {
return
}
Expand Down Expand Up @@ -63,12 +65,13 @@ document.addEventListener('DOMContentLoaded', function () {
const roleDivs = document.querySelectorAll('body.docs:not(.docshome) *[class*="label--"]')

roleDivs.forEach(function (roleDiv) {
// ignore spans because they're inline
// we only care about labels on block elements
// DIV or TABLE
if (roleDiv.nodeName === 'SPAN') return

var roles = roleDiv.classList

// ignore:
// - spans because they're inline and we only care about labels on block elements DIV or TABLE
// - discrete headers
if (roleDiv.nodeName === 'SPAN' || [...roles].includes('discrete')) return

roles = [...roles].sort().filter(function (c) {
return (c.startsWith('label--'))
})
Expand All @@ -79,6 +82,10 @@ document.addEventListener('DOMContentLoaded', function () {

roles.forEach(function (role) {
const labelDetails = getLabelDetails(role)

// remove the role from the parent div
roleDiv.classList.remove(role)

if (typeof labelDetails === 'undefined') {
return
}
Expand All @@ -93,9 +100,6 @@ document.addEventListener('DOMContentLoaded', function () {

labelSpan.appendChild(document.createTextNode(labelDetails.text))

// remove the role from the parent div
roleDiv.classList.remove(role)

labels.push(labelSpan)
})

Expand Down