feat: component for prompt patterns formatting

Author: mcavaliere

components/PromptPatterns.tsx

@@ -0,0 +1,88 @@
+import {
+  Accordion,
+  AccordionContent,
+  AccordionItem,
+  AccordionTrigger,
+} from "@/components/ui/accordion";
+import { PromptPattern, promptPatterns } from "@/data/prompt-patterns";
+import { Heading3, Heading4 } from "./Headings";
+
+const patterns = promptPatterns.sort((a, b) => a.name.localeCompare(b.name));
+
+export function PromptPatternsList({ children, ...props }: { children: React.ReactNode }) {
+  return (
+    <ul className="mb-2 list-disc pl-4" {...props}>
+      {children}
+    </ul>
+  );
+}
+export function PromptPatterns() {
+  return (
+    <Accordion type="multiple">
+      {patterns.map(
+        ({
+          name,
+          category,
+          intent,
+          motivation,
+          structure,
+          examples,
+          consequences,
+        }: PromptPattern) => (
+          <AccordionItem value={name} key={name}>
+            <AccordionTrigger>{name}</AccordionTrigger>
+            <AccordionContent>
+              <div className="p-4 rounded-md bg-purple-100">
+                <Heading3 className="mb-4">{name}</Heading3>
+
+                <Heading4 className="mb-2">Example</Heading4>
+
+                <PromptPatternsList>
+                  {examples.map((example, index) => (
+                    <li key={index}>
+                      <pre className="text-wrap">
+                        <blockquote>{example}</blockquote>
+                      </pre>
+                    </li>
+                  ))}
+                </PromptPatternsList>
+
+                <Heading4 className="mb-2">Intent</Heading4>
+
+                <PromptPatternsList>
+                  {intent.map((item, index) => (
+                    <li key={index}>{item}</li>
+                  ))}
+                </PromptPatternsList>
+
+                <Heading4 className="mb-2">Motivation</Heading4>
+
+                <PromptPatternsList>
+                  {motivation.map((item, index) => (
+                    <li key={index}>{item}</li>
+                  ))}
+                </PromptPatternsList>
+
+                <Heading4 className="mb-2">Structure</Heading4>
+
+                <PromptPatternsList>
+                  {structure.map((item, index) => (
+                    <li key={index}>{item}</li>
+                  ))}
+                </PromptPatternsList>
+
+                <Heading4 className="mb-2">Consequences</Heading4>
+
+                <PromptPatternsList>
+                  {consequences.map((item, index) => (
+                    <li key={index}>{item}</li>
+                  ))}
+                </PromptPatternsList>
+              </div>
+            </AccordionContent>
+          </AccordionItem>
+        )
+      )}
+    </Accordion>
+  );
+}

components/ui/accordion.tsx

@@ -0,0 +1,58 @@
+"use client"
+
+import * as React from "react"
+import * as AccordionPrimitive from "@radix-ui/react-accordion"
+import { ChevronDown } from "lucide-react"
+
+import { cn } from "@/lib/utils"
+
+const Accordion = AccordionPrimitive.Root
+
+const AccordionItem = React.forwardRef<
+  React.ElementRef<typeof AccordionPrimitive.Item>,
+  React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Item>
+>(({ className, ...props }, ref) => (
+  <AccordionPrimitive.Item
+    ref={ref}
+    className={cn("border-b", className)}
+    {...props}
+  />
+))
+AccordionItem.displayName = "AccordionItem"
+
+const AccordionTrigger = React.forwardRef<
+  React.ElementRef<typeof AccordionPrimitive.Trigger>,
+  React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Trigger>
+>(({ className, children, ...props }, ref) => (
+  <AccordionPrimitive.Header className="flex">
+    <AccordionPrimitive.Trigger
+      ref={ref}
+      className={cn(
+        "flex flex-1 items-center justify-between py-4 font-medium transition-all hover:underline [&[data-state=open]>svg]:rotate-180",
+        className
+      )}
+      {...props}
+    >
+      {children}
+      <ChevronDown className="h-4 w-4 shrink-0 transition-transform duration-200" />
+    </AccordionPrimitive.Trigger>
+  </AccordionPrimitive.Header>
+))
+AccordionTrigger.displayName = AccordionPrimitive.Trigger.displayName
+
+const AccordionContent = React.forwardRef<
+  React.ElementRef<typeof AccordionPrimitive.Content>,
+  React.ComponentPropsWithoutRef<typeof AccordionPrimitive.Content>
+>(({ className, children, ...props }, ref) => (
+  <AccordionPrimitive.Content
+    ref={ref}
+    className="overflow-hidden text-sm transition-all data-[state=closed]:animate-accordion-up data-[state=open]:animate-accordion-down"
+    {...props}
+  >
+    <div className={cn("pb-4 pt-0", className)}>{children}</div>
+  </AccordionPrimitive.Content>
+))
+
+AccordionContent.displayName = AccordionPrimitive.Content.displayName
+
+export { Accordion, AccordionItem, AccordionTrigger, AccordionContent }

data/posts/openai-prompt-patterns.mdx

@@ -6,3 +6,4 @@ date: "2024-07-01"
 
 While going through a course on prompt engineering, I came across a great research paper called "A Prompt Pattern Catalog to Enhance Prompt Engineering with ChatGPT." The paper contains a lot of good prompt engineering techniques, so I wanted to summarize them here as a cheat sheet.
 
+<PromptPatterns />

mdx-components.tsx

@@ -14,6 +14,7 @@ import {
   AINewsletterCard,
 } from "./components/ui/card";
 import { TwitterLink } from "./components/Link";
+import { PromptPatterns } from "./components/PromptPatterns";
 
 export const mdxComponents = {
   ...rendererMapLowercase,
@@ -27,6 +28,7 @@ export const mdxComponents = {
   CardFooter,
   CardTitle,
   CardDescription,
+  PromptPatterns,
   AINewsletterCard,
   TwitterLink,
 };

package.json

@@ -18,6 +18,7 @@
     "@mdx-js/react": "^3.0.1",
     "@next/mdx": "^14.2.3",
     "@next/third-parties": "^14.2.3",
+    "@radix-ui/react-accordion": "^1.2.0",
     "@radix-ui/react-dialog": "^1.0.5",
     "@radix-ui/react-dropdown-menu": "^2.0.6",
     "@radix-ui/react-navigation-menu": "^1.1.4",