@gpichot/spectacle-deck 1.0.8 → 1.1.0

package/dist/layouts/QuoteLayout.d.ts

@@ -0,0 +1,6 @@
+import React from "react";
+export declare function QuoteLayout({ children, author, url, }: {
+    children: React.ReactNode;
+    author: string;
+    url?: string;
+}): React.JSX.Element;

package/{layouts → dist/layouts}/index.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="react" />
 /// <reference types="react" />
+import { QuoteLayout } from "./QuoteLayout";
 import { SidedCodeLayout } from "./SideCodeLayout";
 import { SideLayout } from "./SideLayout";
 declare const _default: {
@@ -11,6 +12,7 @@ declare const _default: {
         children: import("react").ReactNode;
         position?: "left" | "right";
     }) => import("react").JSX.Element;
+    quote: typeof QuoteLayout;
     sidedCode: typeof SidedCodeLayout;
     sidedImage: ({ children, image, position, height, }: {
         children: import("react").ReactNode;

package/dist/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@gpichot/spectacle-deck",
+  "version": "1.1.0",
+  "license": "MIT",
+  "type": "module",
+  "main": "index.cjs",
+  "types": "index.d.ts",
+  "module": "index.mjs",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "require": "./index.cjs",
+      "import": "./index.mjs"
+    }
+  },
+  "keywords": [
+    "spectacle"
+  ],
+  "dependencies": {
+    "@fontsource/bitter": "^5.0.15",
+    "@mdx-js/react": "^3.0.0",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "react-is": "^18.2.0",
+    "react-spring": "^9.7.3",
+    "react-syntax-highlighter": "^15.5.0",
+    "spectacle": "^10.1.6",
+    "styled-components": "^6.1.0"
+  }
+}

package/package.json

@@ -1,21 +1,12 @@
 {
   "name": "@gpichot/spectacle-deck",
-  "version": "1.0.8",
-  "license": "MIT",
-  "type": "module",
-  "main": "index.cjs",
-  "types": "index.d.ts",
-  "module": "index.mjs",
-  "exports": {
-    ".": {
-      "types": "./index.d.ts",
-      "require": "./index.cjs",
-      "import": "./index.mjs"
-    }
-  },
-  "keywords": [
-    "spectacle"
-  ],
+  "version": "1.1.0",
+  "description": "",
+  "module": "src/index.tsx",
+  "types": "src/index.d.ts",
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
   "dependencies": {
     "@fontsource/bitter": "^5.0.15",
     "@mdx-js/react": "^3.0.0",
@@ -26,5 +17,18 @@
     "react-syntax-highlighter": "^15.5.0",
     "spectacle": "^10.1.6",
     "styled-components": "^6.1.0"
+  },
+  "devDependencies": {
+    "@arnaud-barre/tnode": "^0.19.2",
+    "@types/react": "^18.2.34",
+    "@types/react-dom": "^18.2.14",
+    "@types/react-is": "^18.2.3",
+    "@types/react-syntax-highlighter": "^15.5.9",
+    "esbuild": "^0.19.5",
+    "typescript": "^5.2.2"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "build": "tnode scripts/bundle.ts"
   }
 }

package/scripts/bundle.ts

@@ -0,0 +1,84 @@
+import { rmSync, writeFileSync, copyFileSync } from "node:fs";
+import { execSync } from "node:child_process";
+import { build, BuildOptions, context } from "esbuild";
+
+import packageJSON from "../package.json";
+
+const dev = process.argv.includes("--dev");
+
+rmSync("dist", { force: true, recursive: true });
+
+const serverOptions: BuildOptions = {
+  bundle: true,
+  platform: "node",
+  target: "node14",
+  legalComments: "inline",
+  loader: {
+    ".png": "dataurl",
+  },
+  external: Object.keys(packageJSON.peerDependencies || {}).concat(
+    Object.keys(packageJSON.dependencies || {})
+  ),
+};
+
+const buildOrWatch = async (options: BuildOptions) => {
+  if (!dev) return build(options);
+  const ctx = await context(options);
+  await ctx.watch();
+  await ctx.rebuild();
+};
+
+Promise.all([
+  buildOrWatch({
+    ...serverOptions,
+    stdin: {
+      contents: `import * as mod from "./src";
+module.exports = mod;
+`,
+      resolveDir: ".",
+    },
+    outfile: "dist/index.cjs",
+    logOverride: { "empty-import-meta": "silent" },
+  }),
+  buildOrWatch({
+    ...serverOptions,
+    entryPoints: ["src/index.tsx"],
+    format: "esm",
+    outfile: "dist/index.mjs",
+  }),
+]).then(() => {
+  // copyFileSync("LICENSE", "dist/LICENSE");
+  // copyFileSync("README.md", "dist/README.md");
+
+  execSync(
+    "tsc src/index.tsx --declaration --jsx react --emitDeclarationOnly --outDir dist --module es2020 --target es2020 --allowSyntheticDefaultImports --skipLibCheck --moduleResolution node --types ./src/node.d.ts,./src/style.d.ts",
+    { stdio: "inherit" }
+  );
+
+  writeFileSync(
+    "dist/package.json",
+    JSON.stringify(
+      {
+        name: "@gpichot/spectacle-deck",
+        version: packageJSON.version,
+        license: "MIT",
+        type: "module",
+        main: "index.cjs",
+        types: "index.d.ts",
+        module: "index.mjs",
+        exports: {
+          ".": {
+            types: "./index.d.ts",
+            require: "./index.cjs",
+            import: "./index.mjs",
+          },
+        },
+        keywords: ["spectacle"],
+        peerDependencies: packageJSON.peerDependencies,
+        dependencies: packageJSON.dependencies,
+      },
+      null,
+      2
+    )
+  );
+});

package/src/components/CodeStepper/CodeStepper.tsx

@@ -0,0 +1,223 @@
+import React from "react";
+import ReactIs from "react-is";
+import { Prism as SyntaxHighlighter } from "react-syntax-highlighter";
+import { gruvboxDark } from "react-syntax-highlighter/dist/esm/styles/prism";
+import { Stepper } from "spectacle";
+import styled from "styled-components";
+
+import { parseStepDirectives, Step } from "./code-directives";
+
+const Highlighter = SyntaxHighlighter as unknown as React.ElementType;
+
+const CodeContainer = styled.div`
+  pre {
+    padding: 1rem 0rem !important;
+    background-color: transparent !important;
+  }
+  .linenumber {
+    min-width: 2rem !important;
+  }
+  [data-highlight-line="true"] {
+    &:before {
+      content: " ";
+      position: absolute;
+      background-color: #f4967688;
+    }
+
+    &[data-step-active="true"]:before {
+      background-color: #f49676;
+    }
+  }
+`;
+
+function useCodeSteps(code: string) {
+  return React.useMemo(() => {
+    const prefixes = code.match(/(?:\/\/|<!--) @.*\n/g) || ([] as string[]);
+    const prefixesLength = prefixes.reduce(
+      (acc, prefix) => acc + prefix.length,
+      0
+    );
+
+    const codeWithoutPrefixes = code.slice(prefixesLength);
+
+    const hasDirectives = prefixes.length > 0;
+    const allDirectives = hasDirectives ? [...prefixes] : [];
+    const steps = parseStepDirectives(allDirectives);
+
+    return {
+      steps,
+      code: codeWithoutPrefixes,
+      prefixes,
+      hasSteps: Boolean(steps.length),
+      hasName: steps.some((step) => step.name),
+    };
+  }, [code]);
+}
+
+function getCodeDetails(children: React.ReactNode) {
+  const child = React.Children.toArray(children)[0];
+
+  if (!React.isValidElement(child)) {
+    return {
+      language: "",
+      code: ReactIs.isFragment(child) ? "" : String(child || ""),
+    };
+  }
+
+  const result = {
+    language: (String(child.props.className) || "").replace("language-", ""),
+    code: (child.props.children as string).trim(),
+  };
+
+  return result;
+}
+
+function CodeWrapper({
+  name,
+  stepName,
+  hasName,
+  children,
+}: {
+  name?: string;
+  stepName?: string;
+  hasName?: boolean;
+  children: React.ReactNode;
+}) {
+  return (
+    <div
+      style={{
+        boxSizing: "border-box",
+        margin: "0.5rem 1rem",
+        backgroundColor: "rgb(38,39,40)",
+        borderRadius: "4px",
+      }}
+    >
+      {name && (
+        <span
+          style={{
+            fontFamily: 'Consolas, Monaco, "Andale Mono", monospace',
+            fontSize: "1rem",
+            color: "#ffffffbb",
+            backgroundColor: "#33333388",
+            display: "inline-block",
+            padding: "8px 8px",
+            width: "100%",
+            boxSizing: "border-box",
+          }}
+        >
+          {name}
+        </span>
+      )}
+      {children}
+      {hasName && (
+        <span
+          style={{
+            fontFamily: 'Consolas, Monaco, "Andale Mono", monospace',
+            fontSize: "0.8rem",
+            color: "#ffffffaa",
+            backgroundColor: "#33333388",
+            display: "inline-block",
+            padding: "4px 8px",
+            width: "100%",
+            boxSizing: "border-box",
+            fontStyle: "italic",
+          }}
+        >
+          {stepName || <span style={{ visibility: "hidden" }}>Step</span>}
+        </span>
+      )}
+    </div>
+  );
+}
+
+export default function CodeStepper({
+  priority,
+  name,
+  ...props
+}: React.ComponentProps<"pre"> & {
+  priority?: number;
+  name?: string;
+}) {
+  const { language, code } = React.useMemo(() => {
+    return getCodeDetails(props.children);
+  }, [props.children]);
+
+  const {
+    steps,
+    code: codeNormalized,
+    prefixes,
+    hasSteps,
+    hasName,
+  } = useCodeSteps(code);
+  return (
+    <CodeContainer>
+      {import.meta.env.DEV && Boolean(prefixes?.length) && (
+        <div style={{ position: "absolute", top: 0, opacity: 0.5, left: 0 }}>
+          <Highlighter language={language} style={gruvboxDark}>
+            {prefixes.join("")}
+          </Highlighter>
+        </div>
+      )}
+      <Stepper
+        values={steps}
+        alwaysVisible={!hasSteps}
+        priority={priority ? priority + 1 : undefined}
+      >
+        {(step, _, isActive) => (
+          <CodeWrapper
+            name={name}
+            stepName={(step as Step | null)?.name}
+            hasName={hasName}
+          >
+            <Highlighter
+              language={language}
+              wrapLines
+              showLineNumbers
+              style={gruvboxDark}
+              lineNumberStyle={(lineNumber: number) => {
+                const { highlight = [] } = (step as Step) || {};
+                const isHighlighted = highlight.includes(lineNumber);
+
+                return {
+                  fontWeight: isHighlighted ? "bold" : "normal",
+                };
+              }}
+              lineProps={(lineNumber: number) => {
+                const { hiddenLines = [], highlight = [] } =
+                  (step as Step) || {};
+                const isVisible =
+                  hasSteps && isActive
+                    ? !hiddenLines.includes(lineNumber)
+                    : isActive || !hasSteps;
+                const isHighlighted = highlight.includes(lineNumber);
+                const getOpacity = () => {
+                  if (!isVisible) return 0;
+                  if (isHighlighted || !highlight.length) return 1;
+                  return 0.8;
+                };
+
+                return {
+                  ...(isHighlighted && {
+                    "data-highlight-line": isHighlighted,
+                    "data-step-active": isActive,
+                  }),
+                  style: {
+                    opacity: getOpacity(),
+                    transition: "all 0.3s ease",
+                    display: "block",
+                    width: "100%",
+                    backgroundColor: isHighlighted ? "#f4967622" : "",
+                  },
+                };
+              }}
+            >
+              {codeNormalized}
+            </Highlighter>
+          </CodeWrapper>
+        )}
+      </Stepper>
+    </CodeContainer>
+  );
+}
+
+CodeStepper.mdxType = "CodeStepper";

package/src/components/CodeStepper/code-directives.test.ts

@@ -0,0 +1,58 @@
+import { parseStepDirectives } from './code-directives';
+
+function splitDirectives(str: string): string[] {
+  return str.trim().split('\n');
+}
+
+describe('parseStepDirectives', () => {
+  it('should reduce properly with showLines', () => {
+    const directives = splitDirectives(`
+      // @step showLines(1-3) highlight(1-3)
+      // @step showLines(4-6) highlight(4-6)
+    `);
+
+    const result = parseStepDirectives(directives);
+    expect(result[0]).toEqual({ hiddenLines: [4, 5, 6], highlight: [1, 2, 3] });
+    expect(result[1]).toEqual({ hiddenLines: [], highlight: [4, 5, 6] });
+  });
+
+  it('should reduce properly with highlight', () => {
+    const directives = splitDirectives(`
+      // @step highlight(3)
+      // @step showLines(4) highlight(4)
+    `);
+
+    const result = parseStepDirectives(directives);
+    expect(result).toHaveLength(2);
+    expect(result[0]).toEqual({ hiddenLines: [4], highlight: [3] });
+    expect(result[1]).toEqual({ hiddenLines: [], highlight: [4] });
+  });
+
+  it('parse only highlights', () => {
+    const directives = splitDirectives(`
+      // @step highlight(6)
+      // @step highlight(7-9)
+      // @step highlight(10)
+    `);
+
+    const result = parseStepDirectives(directives);
+    expect(result).toHaveLength(3);
+    expect(result[0]).toEqual({ hiddenLines: [], highlight: [6] });
+    expect(result[1]).toEqual({ hiddenLines: [], highlight: [7, 8, 9] });
+    expect(result[2]).toEqual({ hiddenLines: [], highlight: [10] });
+  });
+
+  it('parses typescript lines', () => {
+    const directives = splitDirectives(`
+      // @step highlight(3) name("(string|number)[]")
+    `);
+
+    const result = parseStepDirectives(directives);
+    expect(result).toHaveLength(1);
+    expect(result[0]).toEqual({
+      hiddenLines: [],
+      highlight: [3],
+      name: '(string|number)[]',
+    });
+  });
+});

package/src/components/CodeStepper/code-directives.ts

@@ -0,0 +1,129 @@
+/**
+ * The Code Stepper component is a component that allows you to step through
+ * the code using familiar directives.
+ *
+ * @example "@step showLines(1-3)" will show lines 1-3
+ * @example "@step highlight(1-3)" will highlight lines 1-3
+ *
+ */
+
+function range(start: number, end: number) {
+  return Array.from({ length: end - start + 1 }, (_, i) => i + start);
+}
+
+/**
+ * Function parse ranges list
+ */
+function parseRangeList(str: string): number[] {
+  return str.split(',').reduce((acc, line) => {
+    if (!line.includes('-')) return [...acc, parseInt(line, 10)];
+
+    const [start, end] = line.split('-').map(Number);
+    return [...acc, ...range(start, end)];
+  }, [] as number[]);
+}
+
+/**
+ * Parse showLines fn
+ *
+ * "showLines(1-3)" => [1, 2, 3]
+ * "showLines(1,3)" => [1,3]
+ * "showLines(1-2,4-5)" => [1,2,4,5]
+ */
+function parseShowLines(directive: string): { showLines: number[] } | null {
+  const match = directive.match(/showLines\((.*)\)/);
+  if (!match) return null;
+
+  const lines = parseRangeList(match[1]);
+
+  return { showLines: lines };
+}
+
+/**
+ * Parse highlight fn
+ *
+ * "highlight(1-3)" => [1,2,3]
+ * etc.
+ */
+function parseHighlight(directive: string): { highlight: number[] } | null {
+  const match = directive.match(/highlight\((.*)\)/);
+  if (!match) return null;
+
+  const lines = parseRangeList(match[1]);
+
+  return { highlight: lines };
+}
+
+type StepDirective = {
+  showLines?: number[];
+  highlight?: number[];
+  name?: string;
+};
+
+/**
+ * Parse name fn
+ *
+ * "name("my name")" => "my name"
+ */
+function parseName(directive: string): { name: string } | null {
+  const match = directive.match(/name\("(.*)"\)/);
+  if (!match) return null;
+
+  return { name: match[1] };
+}
+
+/**
+ * Parse step directive
+ *
+ * @example "@step showLines(1-3) highlight(1-3)"
+ * @example "@step showLines(1-3)"
+ * @example "@step highlight(1-3)"
+ */
+function parseStepDirective(directive: string): StepDirective {
+  // Should match a showLines(1-3) or highlight(1-3) directive
+  // Should match name("(string)")
+  const regex = /showLines\([^)]+\)|highlight\([^)]+\)|name\("(.*)"\)/g;
+
+  const directives = directive.match(regex) || [];
+
+  const name = directives.map(parseName).find(Boolean);
+  const showLines = directives.map(parseShowLines).find(Boolean);
+  const highlight = directives.map(parseHighlight).find(Boolean);
+
+  return { ...showLines, ...highlight, ...name };
+}
+
+export type Step = {
+  hiddenLines: number[];
+  highlight: number[];
+  name?: string;
+};
+
+/**
+ * Reduce steps directives
+ */
+export function combineStepDirectives(directives: StepDirective[]): Step[] {
+  let hiddenLines = directives.reduce((acc, { showLines }) => {
+    if (!showLines) return acc;
+
+    return [...acc, ...showLines];
+  }, [] as number[]);
+
+  return directives.map(({ highlight, showLines, name }) => {
+    hiddenLines = hiddenLines.filter((line) => !showLines?.includes(line));
+    return {
+      highlight: highlight || [],
+      hiddenLines,
+      name,
+    };
+  });
+}
+
+/**
+ * Parse step directives
+ */
+export function parseStepDirectives(directives: string[]): Step[] {
+  const parsedDirectives = directives.map(parseStepDirective);
+
+  return combineStepDirectives(parsedDirectives);
+}

package/src/components/DocumentationItem.tsx

@@ -0,0 +1,85 @@
+import React from "react";
+
+import styled from "styled-components";
+
+const DocWrapper = styled.div`
+  position: absolute;
+  bottom: 0;
+  right: 0;
+  z-index: 10000;
+
+  .docContent {
+    display: none;
+  }
+
+  &:hover .docContent {
+    display: flex;
+  }
+`;
+
+const DocContainer = styled.div`
+  margin: 2rem 1rem;
+  background-color: #333;
+  border: 1px solid #333;
+  padding: 0.5rem 1rem;
+  border-radius: 1.5rem;
+`;
+
+const DocLink = styled.a`
+  text-decoration: none;
+  font-weight: normal;
+  font-family: Bitter, "Helvetica Neue", Helvetica, Arial, sans-serif;
+  color: #f49676;
+`;
+
+const DocLinkItem = styled(DocLink)`
+  width: fit-content;
+  display: inline-block;
+  background-color: #333;
+  border: 1px solid #333;
+  padding: 0.5rem 1rem;
+  border-radius: 1.5rem;
+  margin: 0.25rem 0;
+`;
+
+const DocContent = styled.div`
+  display: flex;
+  flex-flow: column-reverse nowrap;
+  position: absolute;
+  right: 1rem;
+  bottom: 4.5rem;
+  text-align: right;
+  border-radius: 0.5rem;
+  align-items: flex-end;
+`;
+
+export function Doc({
+  label,
+  link,
+  children,
+}: {
+  label: string;
+  link: string;
+  children: React.ReactNode;
+}) {
+  return (
+    <DocWrapper>
+      <DocContainer>
+        {children && <DocContent>{children}</DocContent>}
+        <div>
+          <DocLink target="_blank" rel="noopener noreferrer" href={link}>
+            {label}
+          </DocLink>
+        </div>
+      </DocContainer>
+    </DocWrapper>
+  );
+}
+
+export function DocItem({ label, link }: { label: string; link: string }) {
+  return (
+    <DocLinkItem target="_blank" rel="noopener noreferrer" href={link}>
+      {label}
+    </DocLinkItem>
+  );
+}

package/src/components/FilePane.tsx

@@ -0,0 +1,18 @@
+import React from "react";
+
+export default function FilePane({
+  name,
+  children,
+  priority,
+  ...divProps
+}: React.ComponentProps<"div"> & { name: string; priority?: number }) {
+  return React.isValidElement(children)
+    ? React.cloneElement(children, {
+        // @ts-expect-error cloning
+        priority,
+        name,
+      })
+    : children;
+}
+
+FilePane.mdxType = "FilePane";