https://github.com/asvetliakov/typescript-snapshots-plugin

Snapshots language service support for Typescript
https://github.com/asvetliakov/typescript-snapshots-plugin

jest jest-snapshots navigation snapshot snapshot-testing testing typescript typescript-plugin

Last synced: 13 days ago
JSON representation

Snapshots language service support for Typescript

• Host: GitHub
• URL: https://github.com/asvetliakov/typescript-snapshots-plugin
• Owner: asvetliakov
• License: mit
• Created: 2017-10-26T02:39:05.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-05-30T02:28:49.000Z (7 months ago)
• Last Synced: 2024-11-06T16:42:16.913Z (about 1 month ago)
• Topics: jest, jest-snapshots, navigation, snapshot, snapshot-testing, testing, typescript, typescript-plugin
• Language: TypeScript
• Size: 6.63 MB
• Stars: 128
• Watchers: 5
• Forks: 7
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-jest - typescript-snapshots-plugin

README

        
# Typescript snapshots plugin

Language service support for viewing/navigating to your test snapshots

## Features

### Snapshot content on quick info (hover):

![quickinfo](/images/quickinfo.gif)

### Navigation to snapshot (Go to definition):

![navigation](/images/navigating.gif)

### Dynamically constructed test names (Constants only)

![dynamic](/images/dynamic.png)

### Installation

```npm install typescript-snapshots-plugin --save-dev```

```yarn add typescript-snapshots-plugin --dev```

Add to your tsconfig.json:

```json

    "plugins": [{

        "name": "typescript-snapshots-plugin",

    }]

```

**If you are using VScode, tell it to use your local project TS version instead the VSCode bundled one**

### Configuration

In most cases you must be OK with default configuration. If it doesn't work for you, the plugin exposes few options:

**snapshotCallIdentifiers**

List of snapshot matching call identifiers, such as ```toMatchSnapshot()```, default:

```json

[

    "toMatchSnapshot",

    "toThrowErrorMatchingSnapshot"

]

```

**testBlockIdentifiers**

List of test call identifiers, such as ```it()```, or ```describe()```, default:

```json

    "it",

    "it.only",

    "it.skip",

    "it.concurrent",

    "describe",

    "describe.only",

    "describe.skip",

    "context",

    "suite"

```

**snapshotFileExtensions**

List of snapshot names extensions. These will be used to search the snapshot file for test path. First existing path wins, default:

```json

[ ".snap" ]

```

**snapshotDir**

Snapshot directory relative to the test file, default:

```json

"__snapshots__"

```

**useJSTagsForSnapshotHover**

Setting to true will render snapshot within fake jsdoc definition block. Since VSCode hover jsdoc supports markdown \`\`\`syntax\`\`\` the snapshot in hover widget will have slightly better syntax coloring. If you're using VSCode you may want to enable this, otherwise leave as false. Default:

```false```

To pass your values, add them in tsconfig.json:

```json

    "plugins": [{

        "name": "typescript-snapshots-plugin",

        "snapshotCallIdentifiers": [

            "toMatchSnapshot",

            "myMatchSnapshot"

        ],

        "testBlockIdentifiers": [

            ...

        ]

    }]

```