Skip to content

Include repeated attributes warning for panel elements #2053

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
jovyntls merged 9 commits into from
Jan 16, 2023
Merged

Include repeated attributes warning for panel elements #2053

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
fd8d7e1
Include repeated attributes warning for panel elements
lhw-1 Dec 11, 2022
5b60bee
Merge branch 'master' into 1764-warning-inconsistency
lhw-1 Jan 9, 2023
c489112
Add functional tests for panel elements
lhw-1 Jan 11, 2023
984b4ef
Add warning for alt attribute of panel elements
lhw-1 Jan 11, 2023
25f4250
Remove repeated attributes warning on alt attribute
lhw-1 Jan 11, 2023
eef8681
Update functional tests
lhw-1 Jan 11, 2023
599553f
Add unit tests for repeated attributes warnings for panel elements
lhw-1 Jan 13, 2023
82e3806
Fix linting errors
lhw-1 Jan 13, 2023
795ba1f
Fix typos
lhw-1 Jan 13, 2023
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
6 changes: 6 additions & 0 deletions packages/cli/test/functional/test_site/expected/siteData.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,12 @@
},
"headingKeywords": {}
},
{
"src": "testPanels.md",
"title": "Test: Panels",
"headings": {},
"headingKeywords": {}
},
{
"src": "testPanelMarkdownParsing.md",
"title": "markdown-it should parse minimized panel as inline element and normal panel as block element",
Expand Down
263 changes: 263 additions & 0 deletions packages/cli/test/functional/test_site/expected/testPanels.html
View file
Open in desktop

Large diffs are not rendered by default.

25 changes: 25 additions & 0 deletions packages/cli/test/functional/test_site/expected/testPanels.page-vue-render.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions packages/cli/test/functional/test_site/site.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,10 @@
"src": "testIncludeBoilerplate.md",
"title": "Content inside <include> should not be processed by markdown"
},
{
"src": "testPanels.md",
"title": "Test: Panels"
},
{
"src": "testPanelMarkdownParsing.md",
"title": "markdown-it should parse minimized panel as inline element and normal panel as block element"
Expand Down
25 changes: 25 additions & 0 deletions packages/cli/test/functional/test_site/testPanels.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
**Panel with attributes**

<panel header="Correct header">
Lorem ipsum...
</panel>

<br>

**Panel with slots**

<panel>
<span slot="header">Correct header</span>
Lorem ipsum...
</panel>

<br>

**Panel with slots overriding attributes**

<panel header="Should not appear: Overwritten header">
<span slot="header">Correct header</span>
Lorem ipsum...
</panel>

<br>
4 changes: 3 additions & 1 deletion packages/core/src/html/MdAttributeRenderer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,9 @@ class MdAttributeRenderer {

processPanelAttributes(node) {
this.processAttributeWithoutOverride(node, 'alt', false, '_alt');
this.processAttributeWithoutOverride(node, 'header', false);
if (!this.hasSlotOverridingAttribute(node, 'header')) {
this.processAttributeWithoutOverride(node, 'header', false);
}
}

/*
Expand Down
18 changes: 18 additions & 0 deletions packages/core/test/unit/html/NodeProcessor.data.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,24 @@ module.exports.PROCESS_PANEL_ATTRIBUTES_EXPECTED = `
</panel>
`;

module.exports.PROCESS_PANEL_HEADER_SLOT_TAKES_PRIORITY = `
<panel header="# Lorem ipsum">
<div slot="header">
This existing header slot should be preserved in favour over header attribute, with a logger warning for repeated attributes.
</div>
Header attribute should be ignored and deleted while header slot is reserved.
</panel>
`;

module.exports.PROCESS_PANEL_HEADER_SLOT_TAKES_PRIORITY_EXPECTED = `
<panel>
<template #header><div>
This existing header slot should be preserved in favour over header attribute, with a logger warning for repeated attributes.
</div></template>
Header attribute should be ignored and deleted while header slot is reserved.
</panel>
`;

module.exports.PROCESS_PANEL_HEADER_NO_OVERRIDE = `
<panel header="# Lorem ipsum" alt="**strong alt**">
<div slot="header">
Expand Down
2 changes: 2 additions & 0 deletions packages/core/test/unit/html/NodeProcessor.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ const processAndVerifyTemplate = (template, expectedTemplate, postProcess = fals
test('processNode processes panel attributes and inserts into dom as slots correctly', () => {
processAndVerifyTemplate(testData.PROCESS_PANEL_ATTRIBUTES,
testData.PROCESS_PANEL_ATTRIBUTES_EXPECTED);
processAndVerifyTemplate(testData.PROCESS_PANEL_HEADER_SLOT_TAKES_PRIORITY,
testData.PROCESS_PANEL_HEADER_SLOT_TAKES_PRIORITY_EXPECTED);
processAndVerifyTemplate(testData.PROCESS_PANEL_HEADER_NO_OVERRIDE,
testData.PROCESS_PANEL_HEADER_NO_OVERRIDE_EXPECTED);
});
Expand Down