{"id":21654618,"url":"https://github.com/localvoid/chai-karma-snapshot","last_synced_at":"2025-04-11T21:13:46.084Z","repository":{"id":57196574,"uuid":"97566110","full_name":"localvoid/chai-karma-snapshot","owner":"localvoid","description":"Chai Plugin for Snapshot Testing with Karma","archived":false,"fork":false,"pushed_at":"2020-03-24T22:43:24.000Z","size":23,"stargazers_count":4,"open_issues_count":3,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T21:13:40.940Z","etag":null,"topics":["chai","karma","mocha","snapshot"],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/localvoid.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}},"created_at":"2017-07-18T07:12:17.000Z","updated_at":"2020-10-08T20:51:08.000Z","dependencies_parsed_at":"2022-09-15T15:41:08.496Z","dependency_job_id":null,"html_url":"https://github.com/localvoid/chai-karma-snapshot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localvoid%2Fchai-karma-snapshot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localvoid%2Fchai-karma-snapshot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localvoid%2Fchai-karma-snapshot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/localvoid%2Fchai-karma-snapshot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/localvoid","download_url":"https://codeload.github.com/localvoid/chai-karma-snapshot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248480427,"owners_count":21110937,"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":["chai","karma","mocha","snapshot"],"created_at":"2024-11-25T08:28:27.176Z","updated_at":"2025-04-11T21:13:46.062Z","avatar_url":"https://github.com/localvoid.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Chai Plugin for Snapshot Testing with Karma\n\n## Snapshot Serialization\n\nThis plugin is using the same [serialization module](https://www.npmjs.com/package/pretty-format) that is used in [Jest](http://facebook.github.io/jest/) library.\n\n## Snapshot Format\n\nSnapshot can be stored in different formats. Right now there are two formats supported: `md` and `indented-md`.\n\n### Markdown Format\n\nThis format is preferred when you specify language for code blocks in an assertion plugin. With this format, code\neditors will automatically highlight syntax of code blocks.\n\n````md\n# `src/html.js`\n\n## `Sub Suite`\n\n####   `HTML Snapshot`\n\n```html\n\u003cdiv\u003e\n  \u003cspan /\u003e\n\u003c/div\u003e\n```\n````\n\n### Indented Markdown Format\n\n```md\n# `src/html.js`\n\n## `Sub Suite`\n\n####   `HTML Snapshot`\n\n    \u003cdiv\u003e\n      \u003cspan /\u003e\n    \u003c/div\u003e\n```\n\n## Snapshot File Path\n\nSnapshot file path is extracted from the name of the root suit cases and stored alongside with a tested files in a\n`__snapshots__` directory.\n\nSnapshot file path can be changed by providing a custom `pathResolver` in snapshot config.\n\n## Usage Example\n\n```sh\n$ npm install karma karma-webpack karma-sourcemap-loader karma-snapshot karma-mocha \\\n              karma-mocha-snapshot karma-mocha-reporter karma-chrome-launcher mocha \\\n              chai chai-karma-snapshot webpack --save-dev\n```\n\nKarma configuration: \n\n```js\n// karma.conf.js\nconst webpack = require(\"webpack\");\n\nmodule.exports = function (config) {\n  config.set({\n    browsers: [\"ChromeHeadless\"],\n    frameworks: [\"mocha\", \"snapshot\", \"mocha-snapshot\"],\n    reporters: [\"mocha\"],\n    preprocessors: {\n      \"**/__snapshots__/**/*.md\": [\"snapshot\"],\n      \"__tests__/index.js\": [\"webpack\", \"sourcemap\"]\n    },\n    files: [\n      \"**/__snapshots__/**/*.md\",\n      \"__tests__/index.js\"\n    ],\n\n    colors: true,\n    autoWatch: true,\n\n    webpack: {\n      devtool: \"inline-source-map\",\n      performance: {\n        hints: false\n      },\n    },\n\n    webpackMiddleware: {\n      stats: \"errors-only\",\n      noInfo: true\n    },\n\n    snapshot: {\n      update: !!process.env.UPDATE,\n      prune: !!process.env.PRUNE,\n    },\n\n    mochaReporter: {\n      showDiff: true,\n    },\n\n    client: {\n      mocha: {\n        reporter: \"html\",\n        ui: \"bdd\",\n      }\n    },\n  });\n};\n```\n\nSource file:\n\n```js\n// src/index.js\n\nexport function test() {\n  return \"Snapshot Test\";\n}\n```\n\nTest file:\n\n```js\n// __tests__/index.js\nimport { use, expect, assert } from \"chai\";\nimport { matchSnapshot } from \"chai-karma-snapshot\";\nimport { test } from \"../src/index.js\";\nuse(matchSnapshot);\n\ndescribe(\"src/index.js\", () =\u003e {\n  it(\"check snapshot\", () =\u003e {\n    // 'expect' syntax:\n    expect(test()).to.matchSnapshot();\n    // 'assert' syntax:\n    assert.matchSnapshot(test());\n  });\n});\n```\n\nRun tests:\n\n```sh\n$ karma start\n```\n\nUpdate snapshots:\n\n```sh\n$ UPDATE=1 karma start --single-run\n```\n\nPrune snapshots:\n\n```sh\n$ PRUNE=1 karma start --single-run\n```\n\n## Config\n\n```js\nfunction resolve(basePath, suiteName) {\n  return path.join(basePath, \"__snapshots__\", suiteName);\n}\n\nconfig.set({\n  ...\n  snapshot: {\n    update: true,           // Run snapshot tests in UPDATE mode (default: false)\n    prune: false,            // Prune snapshots for removed tests (default: true)\n    format: \"indented-md\",  // Snapshot format (default: md)\n    checkSourceFile: true,  // Checks existince of the source file associated with tests (default: false)\n    pathResolver: resolve,  // Custom path resolver\n  }\n});\n```\n\n## Custom Snapshot Format\n\nSnapshot config option `format` also works with custom serialization formats. Custom snapshot serializer should have\ninterface:\n\n```ts\ninterface SnapshotSerializer {\n  serialize: (name: string, suite: SnapshotSuite) =\u003e string,\n  deserialize: (content: string) =\u003e { name: string, suite: SnapshotSuite },\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalvoid%2Fchai-karma-snapshot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flocalvoid%2Fchai-karma-snapshot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flocalvoid%2Fchai-karma-snapshot/lists"}