Skip to content

feat: ensure bordered images are rendered via a magic block #579

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 1 commit into from
Sep 8, 2022
Merged

feat: ensure bordered images are rendered via a magic block #579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 3 additions & 2 deletions __tests__/__snapshots__/flavored-compilers.test.js.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ exports[`ReadMe Magic Blocks Image 1`] = `
"
`;

exports[`ReadMe Magic Blocks Image with sizing 1`] = `
exports[`ReadMe Magic Blocks Image with sizing and border 1`] = `
"[block:image]
{
\\"images\\": [
Expand All @@ -101,7 +101,8 @@ exports[`ReadMe Magic Blocks Image with sizing 1`] = `
\\"rdme-blue.svg\\",
\\"\\"
],
\\"sizing\\": \\"80px\\"
\\"sizing\\": \\"80px\\",
\\"border\\": true
}
]
}
Expand Down
5 changes: 3 additions & 2 deletions __tests__/flavored-compilers.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,15 +181,16 @@ describe('ReadMe Magic Blocks', () => {
expect(out).toMatchSnapshot();
});

it('Image with sizing', () => {
it('Image with sizing and border', () => {
const txt = `[block:image]
{
"images": [{
"image": [
"https://files.readme.io/6f52e22-man-eating-pizza-and-making-an-ok-gesture.jpg",
"rdme-blue.svg"
],
"sizing": "80px"
"sizing": "80px",
"border": true
}]
}
[/block]`;
Expand Down
5 changes: 3 additions & 2 deletions processor/compile/figure.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
const { imgSizeByWidth } = require('../parse/magic-block-parser');

const compileImage = image => {
const { className, width } = image.data.hProperties || {};
const img = {
image: [image.url, image.title, image.alt],
...(image.data.hProperties.width && { sizing: imgSizeByWidth[image.data.hProperties.width] }),
...(image.border && { border: image.border }),
...(width && { sizing: imgSizeByWidth[width] }),
...(className === 'border' && { border: true }),
};

return img;
Expand Down
5 changes: 4 additions & 1 deletion processor/compile/image.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,10 @@ module.exports = function ImageCompiler() {
visitors.image = function compile(node, ...args) {
if (node.data?.hProperties?.className === 'emoji') return node.title;

if (node.data?.hProperties?.width) return visitors.figure.call(this, node, ...args);
// Use magic block instead of markdown when there are certain defined properties we can't store in markdown
const { className, width } = node.data?.hProperties || {};
const useMagicBlock = Boolean(width) || className?.length;
if (useMagicBlock) return visitors.figure.call(this, node, ...args);

return originalImageCompiler.call(this, node, ...args);
};
Expand Down