{"id":13769581,"url":"https://github.com/asvetliakov/typescript-snapshots-plugin","last_synced_at":"2025-04-04T19:10:13.287Z","repository":{"id":26355313,"uuid":"108352452","full_name":"asvetliakov/typescript-snapshots-plugin","owner":"asvetliakov","description":"Snapshots language service support for Typescript","archived":false,"fork":false,"pushed_at":"2024-05-30T02:28:49.000Z","size":6953,"stargazers_count":129,"open_issues_count":21,"forks_count":7,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-28T18:08:52.917Z","etag":null,"topics":["jest","jest-snapshots","navigation","snapshot","snapshot-testing","testing","typescript","typescript-plugin"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/asvetliakov.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-26T02:39:05.000Z","updated_at":"2024-12-20T17:41:08.000Z","dependencies_parsed_at":"2024-06-18T15:19:47.792Z","dependency_job_id":"2f697367-0f69-4cde-944f-3235754f8ac5","html_url":"https://github.com/asvetliakov/typescript-snapshots-plugin","commit_stats":{"total_commits":44,"total_committers":3,"mean_commits":"14.666666666666666","dds":"0.045454545454545414","last_synced_commit":"fc1ee7e6ffb43a0ad9d777f6d066727938432121"},"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asvetliakov%2Ftypescript-snapshots-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asvetliakov%2Ftypescript-snapshots-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asvetliakov%2Ftypescript-snapshots-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asvetliakov%2Ftypescript-snapshots-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asvetliakov","download_url":"https://codeload.github.com/asvetliakov/typescript-snapshots-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247234921,"owners_count":20905854,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["jest","jest-snapshots","navigation","snapshot","snapshot-testing","testing","typescript","typescript-plugin"],"created_at":"2024-08-03T17:00:28.854Z","updated_at":"2025-04-04T19:10:13.247Z","avatar_url":"https://github.com/asvetliakov.png","language":"TypeScript","funding_links":[],"categories":["Packages"],"sub_categories":["Library extensions"],"readme":"# Typescript snapshots plugin\nLanguage service support for viewing/navigating to your test snapshots\n\n## Features\n\n### Snapshot content on quick info (hover):\n![quickinfo](/images/quickinfo.gif)\n\n### Navigation to snapshot (Go to definition):\n![navigation](/images/navigating.gif)\n\n### Dynamically constructed test names (Constants only)\n![dynamic](/images/dynamic.png)\n\n### Installation\n\n```npm install typescript-snapshots-plugin --save-dev```\n\n```yarn add typescript-snapshots-plugin --dev```\n\nAdd to your tsconfig.json:\n```json\n    \"plugins\": [{\n        \"name\": \"typescript-snapshots-plugin\",\n    }]\n```\n\n**If you are using VScode, tell it to use your local project TS version instead the VSCode bundled one**\n\n### Configuration\nIn most cases you must be OK with default configuration. If it doesn't work for you, the plugin exposes few options:\n\n**snapshotCallIdentifiers**\nList of snapshot matching call identifiers, such as ```toMatchSnapshot()```, default:\n```json\n[\n    \"toMatchSnapshot\",\n    \"toThrowErrorMatchingSnapshot\"\n]\n```\n\n**testBlockIdentifiers**\nList of test call identifiers, such as ```it()```, or ```describe()```, default:\n```json\n    \"it\",\n    \"it.only\",\n    \"it.skip\",\n    \"it.concurrent\",\n    \"describe\",\n    \"describe.only\",\n    \"describe.skip\",\n    \"context\",\n    \"suite\"\n```\n\n**snapshotFileExtensions**\nList of snapshot names extensions. These will be used to search the snapshot file for test path. First existing path wins, default:\n```json\n[ \".snap\" ]\n\n```\n\n**snapshotDir**\nSnapshot directory relative to the test file, default:\n```json\n\"__snapshots__\"\n```\n\n**useJSTagsForSnapshotHover**\nSetting 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:\n```false```\n\nTo pass your values, add them in tsconfig.json:\n```json\n    \"plugins\": [{\n        \"name\": \"typescript-snapshots-plugin\",\n        \"snapshotCallIdentifiers\": [\n            \"toMatchSnapshot\",\n            \"myMatchSnapshot\"\n        ],\n        \"testBlockIdentifiers\": [\n            ...\n        ]\n    }]\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasvetliakov%2Ftypescript-snapshots-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasvetliakov%2Ftypescript-snapshots-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasvetliakov%2Ftypescript-snapshots-plugin/lists"}