jest-snapshots-svg

Take a React Native component tree, and render it into an SVG.

// _tests/render.test.tsx

import * as React from "react"
import { Text } from "react-native"
import * as renderer from "react-test-renderer"
import "jest-snapshots-svg"
describe("Fixtures", () => {
  it("does some simple JSX", () => {
    const component = renderer.create().toJSON()
    expect(component).toMatchSnapshot()
    expect(component).toMatchSVGSnapshot(480, 640)
  })
})

Would make:

src/_tests/
├── __snapshots__
│   ├── render.test.tsx.snap
│   └── render.test.tsx-does-some-simple-jsx.svg
└── render.test.tsx

It does this by emulating the rendering process of React Native by calling yoga-layout directly in your tests, then converting the output of the layout-pass into SVG items that can easy be previewed in GitHub.

👍

What does this look like in principal?

Your code	The final SVG
Write your normal Jest snapshot tests, but use toMatchSVGSnapshot import * as React from "react" import { View } from "react-native" import * as renderer from "react-test-renderer" import "jest-snapshots-svg" const squareStyle = (color) =&gt; ({ width: 50, height: 50, backgroundColor: color }) it("Renders three centered blocks", () =&gt; { const jsx = <view style="{{" flex: flexdirection: justifycontent: alignitems:> <view style='{squareStyle("powderblue")}/'> <view style='{squareStyle("skyblue")}/'> <view style='{squareStyle("steelblue")}/'> </view> const component = renderer.create(jsx).toJSON() expect(component).toMatchSVGSnapshot(320, 480) })
Then you run your tests. yarn jest.
Then you get SVG output in the __snapshots__ folder. Example <?xml version="1.0" encoding="UTF-8" ?> <svg width="320" height="480" ...> <rect type="View" ...></rect> <g transform="translate(0, 0)"> <rect type="View" ...></rect> <rect type="View" ...></rect> <rect type="View" ...></rect> </g> </svg>

Fonts

If you use

loadFont

addFontFallback

setDefaultFont

import { addFontFallback, loadFont, setDefaultFont } from "jest-snapshots-svg"

setDefaultFont("DejaVu Sans")
loadFont(fs.readFileSync("your-font-file.ttf"))
addFontFallback("Your Font", "'Helvetica', 'Arial', sans-serif")

This should be able to determine the

fontFamily

fontWeight

fontStyle

loadFont(fs.readFileSync("your-font-file.ttf"), {
  fontFamily: "Helvetica",
  fontWeight: "normal",
  fontStyle: "normal"
})

If you have a

.ttc

postscriptName

Adding relative font path definitions to the output svg

An alternative way to load a font is to use the

addFontToSvg

loadFont

addFontToSvg("@expo/vector-icons/fonts/FontAwesome.ttf")

Any fonts loaded using

addFontToSvg

Using relative font paths with react-native-vector-icons and @expo/vector-icons

In order for the above to work with the vector icons, you will need to create a test mock file for these packages. The default output from react-test-renderer does not include the actual character codes to display, which means that it cannot be captured from the rendered component to add to the svg. The file should be added to the

__mocks__

For a typical project with the nodemodules directory in the project root directory you should create a file `<projectroot>/mocks/@expo/vector-icons.js

(or ts if you are using typescript) for mocking @expo/vector-icons. For react-native-vector-icons the mock file should be

In the mock file, you need to set the render function to return a Text component, with the font style details set to match the icon font and the text itself set to the unicode reference for the particular character that should be displayed for that icon.

An example mock for @expo/vector-icons could be (written in typescript):

import * as fs from "fs"
import { addFontToSvg } from "jest-snapshots-svg"
import * as React from "react"
import { StyleProp, StyleSheet, Text, TextStyle } from "react-native"
import { IconProps } from "react-native-vector-icons/Icon"

const glyphmapDir = "@expo/vector-icons/vendor/react-native-vector-icons/glyphmaps"
const fontDir = "@expo/vector-icons/fonts"
export const createIconSet = (
  glyphMap: { [name: string]: string | number },
  fontFamily: string,
  fontFile?: string) =>
{
  const filename = require.resolve(${fontDir}/${fontFamily}.ttf)
  addFontToSvg(filename, { fontFamily, fontStyle: "normal", fontWeight: "normal" })
  class Icon extends React.Component {
    static loadFont() {
      console.log("called Icon:loadFont()")
    }
    static getImageSource() {
      console.log("called Icon.getImageSource()")
    }
render() {
  const { name, size, color, style, ...props } = this.props

  let glyph = name ? glyphMap[name] : undefined
  if (typeof glyph === "number") {
    glyph = String.fromCodePoint(glyph);
  }

  const styleDefaults: TextStyle = {
    fontFamily,
    fontSize: size,
    fontWeight: "normal",
    fontStyle: "normal",
    color
  }

  return (
    <text style="{[styleDefaults,">
      {`${glyph
        .codePointAt(0)
        .toString(16)
        .toUpperCase()};`}
    </text>
  );
}
  }
  return Icon
}
export const createIconSetFromFontello = jest.fn()
export const createIconSetFromIcoMoon = jest.fn()
// If you know you're only going to use a few/one of these fonts, you can safely
// remove any you won't use.
export const Entypo = createIconSet(
  require(${glyphmapDir}/Entypo.json),
  "Entypo"
)
export const EvilIcons = createIconSet(
  require(${glyphmapDir}/EvilIcons.json),
  "EvilIcons"
)
export const Feather = createIconSet(
  require(${glyphmapDir}/Feather.json),
  "Feather"
)
export const FontAwesome = createIconSet(
  require(${glyphmapDir}/FontAwesome.json),
  "FontAwesome"
)
export const Foundation = createIconSet(
  require(${glyphmapDir}/Foundation.json),
  "Foundation"
)
export const Ionicons = createIconSet(
  require(${glyphmapDir}/Ionicons.json),
  "Ionicons"
)
export const MaterialCommunityIcons = createIconSet(
  require(${glyphmapDir}/MaterialCommunityIcons.json),
  "MaterialCommunityIcons"
)
export const MaterialIcons = createIconSet(
  require(${glyphmapDir}/MaterialIcons.json),
  "MaterialIcons"
)
export const Octicons = createIconSet(
  require(${glyphmapDir}/Octicons.json),
  "Octicons"
)
export const SimpleLineIcons = createIconSet(
  require(${glyphmapDir}/SimpleLineIcons.json),
  "SimpleLineIcons"
)
export const Zocial = createIconSet(
  require(${glyphmapDir}/Zocial.json),
  "Zocial"
)

For react-native-vector-icons, change the

glyphmapDir

fontDir

const glyphmapDir = "react-native-vector-icons/glyphmaps"
const fontDir = "react-native-vector-icons/Fonts"

Flaws

This is definitely pre-1.0, we only have it working on a few tests in artsy/emission. Expect alpha quality style snapshots for a while, but more people working on it will mean we all get a better chance at it working out well.

• Doesn't render image - see #18
• Not all flexbox attributes are supported - see #19

I want to work on this

OK, you need to clone this repo:

git clone https://github.com/jest-community/jest-snapshots-svg.git

There's the usual stuff,

yarn test

yarn lint

If you want to work against your own projects, then you need to set it up for linking and turn on watch mode.

yarn watch # starts a server, so make a new tab for the next bits
yarn link

cd [my_project]
yarn link jest-snapshot-svg

Now your project is using the dev version of this.

TODO:

• v0-0.5: make it work
• v0.5-1: make it good
• v1: figure out how/if it should end up in jest
• v2: use iTerm to show the images inline
• v3: get vscode-jest to preview them inline