Skip to content

feat: add html element extractor #229

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

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open

feat: add html element extractor #229

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b109671
feat: add html element extractor
a2937 Aug 16, 2024
21a02cc
Remove console.log
a2937 Aug 19, 2024
db9c859
Add suggestion
a2937 Mar 12, 2025
28bec71
update documentation
a2937 Mar 12, 2025
22ffb17
Merge remote-tracking branch 'upstream/main' into feat/add-html-head-…
a2937 Mar 12, 2025
567e1bd
Merge remote-tracking branch 'upstream/main' into feat/add-html-head-…
a2937 Mar 12, 2025
2567d73
Apply suggestions from code review
a2937 Mar 18, 2025
ca92c4f
Update lib/__tests__/curriculum-helper.test.tsx
a2937 Mar 18, 2025
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
16 changes: 16 additions & 0 deletions lib/__fixtures__/curriculum-helpers-html.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,25 @@ not a comment
not a comment
`;

const htmlExampleHead = `
<link rel="stylesheet" href="styles.css">
<head>
<meta charset="UTF-8" />
<title>Piano</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>`;

const htmlInnerExample = `
<meta charset="UTF-8" />
<title>Piano</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
`;

const testValues = {
htmlFullExample,
htmlCodeWithCommentsRemoved,
htmlExampleHead,
htmlInnerExample,
};

export default testValues;
17 changes: 16 additions & 1 deletion lib/__tests__/curriculum-helper.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,12 @@ const { stringWithWhiteSpaceChars, stringWithWhiteSpaceCharsRemoved } =

const { cssFullExample, cssCodeWithCommentsRemoved } = cssTestValues;

const { htmlFullExample, htmlCodeWithCommentsRemoved } = htmlTestValues;
const {
htmlFullExample,
htmlCodeWithCommentsRemoved,
htmlExampleHead,
htmlInnerExample,
} = htmlTestValues;

const {
jsCodeWithSingleAndMultLineComments,
Expand Down Expand Up @@ -170,6 +175,16 @@ describe("removeHtmlComments", () => {
});
});

describe("extractHTMLElement", () => {
const { extractHTMLElement } = helper;
it("returns an empty string if no head is found", () => {
expect(typeof extractHTMLElement("", "head")).toBe("string");
});
it("returns inner HTML string if a head is present", () => {
expect(extractHTMLElement(htmlExampleHead, "head")).toBe(htmlInnerExample);
});
});

describe("isCalledWithNoArgs", () => {
const { isCalledWithNoArgs } = helper;
it("returns a boolean", () => {
Expand Down
13 changes: 13 additions & 0 deletions lib/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,19 @@ export function removeHtmlComments(str: string): string {
return str.replace(/<!--[\s\S]*?(-->|$)/g, "");
}

/**
* Extracts the inner html of every element inside of an element
* @param {String} code a HTML string of the element to analyze
* @param {String} tag the name of the element to match.
* @returns {string | null} the inner html of every element inside the chosen element or `null` if there is no match.
*/
export function extractHTMLElement(code: string, tag): string | null {
const expression = new RegExp(
"(?<=<" + tag + "[^>]*>)(?:.|\\s*)*?(?=<\\/" + tag + "\\s*>)"
);
return code.match(expression)?.toString() ?? null;
}

/**
* Removes every CSS-comment from the string that is provided
* @param {String} str a CSS-string where the comments need to be removed of
Expand Down
Loading