feat(pr-comment): moved diff into separate section (#2421)

* feat(pr-comment): moved diff into separate section

* Update docs/.vitepress/lib/SvgPreview/Diff.tsx

docs/.vitepress/api/gh-icon/[...data].get.ts

@@ -28,7 +28,7 @@ export default eventHandler((event) => {
     .map((_, idx, arr) => arr.slice(0, idx + 1).join('-'))
     .reverse()
     .find((groupName) => groupName in iconNodes);
-  if (backdropName) {
+  if (!(name in iconNodes) && backdropName) {
     const iconNode = iconNodes[backdropName];
 
     const LucideIcon = createLucideIcon(backdropName, iconNode);
@@ -39,18 +39,9 @@ export default eventHandler((event) => {
       createElement(Backdrop, {
         backdropString,
         src,
-        color: name in iconNodes ? 'red' : '#777',
+        color: '#777',
       }),
     );
-    if (name in iconNodes) {
-      children.push(
-        createElement(Backdrop, {
-          backdropString: src,
-          src: backdropString,
-          color: 'lime',
-        }),
-      );
-    }
   }
 
   const svg = Buffer.from(

docs/.vitepress/api/gh-icon/diff/[...data].get.ts

@@ -0,0 +1,37 @@
+import { eventHandler, setResponseHeader, defaultContentType } from 'h3';
+import { renderToString, renderToStaticMarkup } from 'react-dom/server';
+import { createElement } from 'react';
+import Diff from '../../../lib/SvgPreview/Diff.tsx';
+import iconNodes from '../../../data/iconNodes';
+import createLucideIcon from 'lucide-react/src/createLucideIcon';
+
+export default eventHandler((event) => {
+  const { params } = event.context;
+
+  const pathData = params.data.split('/');
+  const data = pathData.at(-1).slice(0, -4);
+  const [name] = pathData;
+
+  const newSrc = Buffer.from(data, 'base64')
+    .toString('utf8')
+    .replaceAll('\n', '')
+    .replace(/<svg[^>]*>|<\/svg>/g, '');
+
+  const children = [];
+
+  const oldSrc = iconNodes[name]
+    ? renderToStaticMarkup(createElement(createLucideIcon(name, iconNodes[name])))
+        .replaceAll('\n', '')
+        .replace(/<svg[^>]*>|<\/svg>/g, '')
+    : '';
+
+  const svg = Buffer.from(
+    // We can't use jsx here, is not supported here by nitro.
+    renderToString(createElement(Diff, { oldSrc, newSrc, showGrid: true }, children)),
+  ).toString('utf8');
+
+  defaultContentType(event, 'image/svg+xml');
+  setResponseHeader(event, 'Cache-Control', 'public,max-age=31536000');
+
+  return svg;
+});

docs/.vitepress/lib/SvgPreview/Backdrop.tsx

@@ -3,10 +3,16 @@ import React from 'react';
 interface BackdropProps {
   src: string;
   color?: string;
+  outline?: boolean;
   backdropString: string;
 }
 
-const Backdrop = ({ src, color = 'red', backdropString }: BackdropProps): JSX.Element => {
+const Backdrop = ({
+  src,
+  color = 'red',
+  outline = true,
+  backdropString,
+}: BackdropProps): JSX.Element => {
   const id = React.useId();
   return (
     <>
@@ -73,13 +79,15 @@ const Backdrop = ({ src, color = 'red', backdropString }: BackdropProps): JSX.El
           opacity={0.75}
           dangerouslySetInnerHTML={{ __html: src }}
         />
-        <g
-          stroke={color}
-          strokeWidth={2.25}
-          opacity={0.75}
-          mask={`url(#svg-preview-backdrop-mask-outline-${id})`}
-          dangerouslySetInnerHTML={{ __html: backdropString }}
-        />
+        {outline && (
+          <g
+            stroke={color}
+            strokeWidth={2.25}
+            opacity={0.75}
+            mask={`url(#svg-preview-backdrop-mask-outline-${id})`}
+            dangerouslySetInnerHTML={{ __html: backdropString }}
+          />
+        )}
       </g>
     </>
   );

docs/.vitepress/lib/SvgPreview/Diff.tsx

@@ -0,0 +1,71 @@
+import React from 'react';
+import Backdrop from './Backdrop.tsx';
+import { darkModeCss, Grid } from './index.tsx';
+
+const SvgPreview = React.forwardRef<
+  SVGSVGElement,
+  {
+    oldSrc: string;
+    newSrc: string;
+  } & React.SVGProps<SVGSVGElement>
+>(({ oldSrc, newSrc, children, ...props }, ref) => {
+  return (
+    <svg
+      ref={ref}
+      xmlns="http://www.w3.org/2000/svg"
+      width={24}
+      height={24}
+      viewBox="0 0 24 24"
+      fill="none"
+      stroke="currentColor"
+      strokeWidth={2}
+      strokeLinecap="round"
+      strokeLinejoin="round"
+      {...props}
+    >
+      <style>{darkModeCss}</style>
+      <Grid
+        strokeWidth={0.1}
+        stroke="#777"
+        strokeOpacity={0.3}
+        radius={1}
+      />
+      <mask
+        id="gray"
+        maskUnits="userSpaceOnUse"
+      >
+        <rect
+          x="0"
+          y="0"
+          width="24"
+          height="24"
+          fill="#000"
+          stroke="none"
+        />
+        <g
+          stroke="#fff"
+          dangerouslySetInnerHTML={{ __html: oldSrc }}
+        />
+      </mask>
+      <Backdrop
+        src=""
+        outline={false}
+        backdropString={`<g mask="url('#gray')">${newSrc}</g>`}
+        color="#777"
+      />
+      <Backdrop
+        src={oldSrc}
+        backdropString={newSrc}
+        color="lime"
+      />
+      <Backdrop
+        src={newSrc}
+        backdropString={oldSrc}
+        color="red"
+      />
+      {children}
+    </svg>
+  );
+});
+
+export default SvgPreview;

docs/.vitepress/lib/SvgPreview/index.tsx

@@ -2,7 +2,23 @@ import React from 'react';
 import { PathProps, Path } from './types';
 import { getPaths, assert } from './utils';
 
-const Grid = ({
+export const darkModeCss = `
+  @media screen and (prefers-color-scheme: light) {
+    .svg-preview-grid-rect { fill: none }
+  }
+  @media screen and (prefers-color-scheme: dark) {
+    .svg-preview-grid-rect { fill: none }
+    .svg
+    .svg-preview-grid-group,
+    .svg-preview-radii-group,
+    .svg-preview-shadow-mask-group,
+    .svg-preview-shadow-group {
+      stroke: #fff;
+    }
+  }
+`;
+
+export const Grid = ({
   radius,
   fill = '#fff',
   ...props
@@ -339,19 +355,6 @@ const SvgPreview = React.forwardRef<
 >(({ src, children, showGrid = false, ...props }, ref) => {
   const paths = typeof src === 'string' ? getPaths(src) : src;
 
-  const darkModeCss = `@media screen and (prefers-color-scheme: light) {
-  .svg-preview-grid-rect { fill: none }
-}
-@media screen and (prefers-color-scheme: dark) {
-  .svg-preview-grid-rect { fill: none }
-  .svg
-  .svg-preview-grid-group,
-  .svg-preview-radii-group,
-  .svg-preview-shadow-mask-group,
-  .svg-preview-shadow-group {
-    stroke: #fff;
-  }
-}`;
   return (
     <svg
       ref={ref}

scripts/generateChangedIconsCommentMarkup.mjs

@@ -77,6 +77,16 @@ const changeFilesXRayImageTags = getImageTagsByFiles(
   400,
 ).join(' ');
 
+const changeFilesDiffImageTags = getImageTagsByFiles(
+  changedFiles,
+  (file) => {
+    const iconName = path.basename(file, '.svg');
+
+    return `${BASE_URL}/${iconName}`;
+  },
+  400,
+).join(' ');
+
 const readyToUseCode = changedFiles
   .map((changedFile) => {
     const svgContent = fs.readFileSync(path.join(process.cwd(), changedFile), 'utf-8');
@@ -112,6 +122,9 @@ ${changeFilesLowDPIImageTags}<br/>
 <summary>Icon X-rays</summary>
 ${changeFilesXRayImageTags}
 </details>
+<summary>Icon Diffs</summary>
+${changeFilesDiffImageTags}
+</details>
 <details>
 <summary>Icons as code</summary>