[{"data":1,"prerenderedAt":292},["ShallowReactive",2],{"doc:zh:getting-started\u002Fusage":3,"doc-nav:zh":264},{"id":4,"title":5,"body":6,"description":256,"extension":257,"meta":258,"navigation":67,"order":64,"path":259,"reviewed":260,"seo":261,"stem":262,"__hash__":263,"fallback":260},"docs\u002Fdocs\u002Fzh\u002Fgetting-started\u002Fusage.md","使用",{"type":7,"value":8,"toc":250},"minimark",[9,12,21,25,85,88,97,185,188,191,216,219,230,233,246],[10,11,5],"h1",{"id":5},[13,14,15,16,20],"p",{},"该插件只添加一条命令：",[17,18,19],"code",{},"matchImage","。测试这一侧的全部 API 就是它。",[22,23,24],"h2",{"id":24},"比对某个元素或整个页面",[26,27,32],"pre",{"className":28,"code":29,"language":30,"meta":31,"style":31},"language-ts shiki shiki-themes github-light-high-contrast github-dark-high-contrast","cy.get('.an-element-of-your-choice').matchImage();\n\n\u002F\u002F 或者对整个页面截图\ncy.matchImage();\n","ts","",[17,33,34,62,69,76],{"__ignoreMap":31},[35,36,39,43,47,50,54,57,59],"span",{"class":37,"line":38},"line",1,[35,40,42],{"class":41},"suds8","cy.",[35,44,46],{"class":45},"sKwhi","get",[35,48,49],{"class":41},"(",[35,51,53],{"class":52},"sT6z2","'.an-element-of-your-choice'",[35,55,56],{"class":41},").",[35,58,19],{"class":45},[35,60,61],{"class":41},"();\n",[35,63,65],{"class":37,"line":64},2,[35,66,68],{"emptyLinePlaceholder":67},true,"\n",[35,70,72],{"class":37,"line":71},3,[35,73,75],{"class":74},"sLBg1","\u002F\u002F 或者对整个页面截图\n",[35,77,79,81,83],{"class":37,"line":78},4,[35,80,42],{"class":41},[35,82,19],{"class":45},[35,84,61],{"class":41},[22,86,87],{"id":87},"配置一次比对",[13,89,90,91,96],{},"选项按每次调用传入。完整列表及默认值在",[92,93,95],"a",{"href":94},"\u002Fdocs\u002Freference\u002Fconfiguration","配置","页面。下面是大家最常先用到的几个：",[26,98,100],{"className":28,"code":99,"language":30,"meta":31,"style":31},"cy.matchImage({\n  \u002F\u002F 透传给 Cypress 的截图 API\n  screenshotConfig: { blackout: ['.element-to-be-blackouted'] },\n  \u002F\u002F pixelmatch 选项\n  diffConfig: { threshold: 0.01 },\n  \u002F\u002F 自动创建尚不存在的基线（默认：true）\n  createMissingImages: false,\n  \u002F\u002F 覆盖基线：true | 'failures-only' | false（默认：false）\n  updateImages: false,\n});\n",[17,101,102,111,116,127,132,145,151,163,169,179],{"__ignoreMap":31},[35,103,104,106,108],{"class":37,"line":38},[35,105,42],{"class":41},[35,107,19],{"class":45},[35,109,110],{"class":41},"({\n",[35,112,113],{"class":37,"line":64},[35,114,115],{"class":74},"  \u002F\u002F 透传给 Cypress 的截图 API\n",[35,117,118,121,124],{"class":37,"line":71},[35,119,120],{"class":41},"  screenshotConfig: { blackout: [",[35,122,123],{"class":52},"'.element-to-be-blackouted'",[35,125,126],{"class":41},"] },\n",[35,128,129],{"class":37,"line":78},[35,130,131],{"class":74},"  \u002F\u002F pixelmatch 选项\n",[35,133,135,138,142],{"class":37,"line":134},5,[35,136,137],{"class":41},"  diffConfig: { threshold: ",[35,139,141],{"class":140},"s-5SL","0.01",[35,143,144],{"class":41}," },\n",[35,146,148],{"class":37,"line":147},6,[35,149,150],{"class":74},"  \u002F\u002F 自动创建尚不存在的基线（默认：true）\n",[35,152,154,157,160],{"class":37,"line":153},7,[35,155,156],{"class":41},"  createMissingImages: ",[35,158,159],{"class":140},"false",[35,161,162],{"class":41},",\n",[35,164,166],{"class":37,"line":165},8,[35,167,168],{"class":74},"  \u002F\u002F 覆盖基线：true | 'failures-only' | false（默认：false）\n",[35,170,172,175,177],{"class":37,"line":171},9,[35,173,174],{"class":41},"  updateImages: ",[35,176,159],{"class":140},[35,178,162],{"class":41},[35,180,182],{"class":37,"line":181},10,[35,183,184],{"class":41},"});\n",[22,186,187],{"id":187},"清理未使用的图片",[13,189,190],{},"测试被重命名或删除后，基线会越积越多。这样运行一次，会删掉所有没被任何测试碰过的插件图片：",[26,192,196],{"className":193,"code":194,"language":195,"meta":31,"style":31},"language-bash shiki shiki-themes github-light-high-contrast github-dark-high-contrast","npx cypress run --expose \"pluginVisualRegressionCleanupUnusedImages=true\"\n","bash",[17,197,198],{"__ignoreMap":31},[35,199,200,204,207,210,213],{"class":37,"line":38},[35,201,203],{"class":202},"soyes","npx",[35,205,206],{"class":52}," cypress",[35,208,209],{"class":52}," run",[35,211,212],{"class":140}," --expose",[35,214,215],{"class":52}," \"pluginVisualRegressionCleanupUnusedImages=true\"\n",[13,217,218],{},"这么做时请跑完整个测试套件。如果只筛选了几个 spec，被跳过的 spec 的基线也会被算作未使用。",[13,220,221,222,225,226,229],{},"在低于 15.10 的 Cypress 版本中还没有 ",[17,223,224],{},"--expose","。请改用 ",[17,227,228],{},"--env"," 传入同一个键。",[22,231,232],{"id":232},"更多",[13,234,235,236,238,239,245],{},"其余内容都在",[92,237,95],{"href":94},"页面。有什么不清楚的，或者有想法，",[92,240,244],{"href":241,"rel":242},"https:\u002F\u002Fgithub.com\u002Fpixsame\u002Fpixsame\u002Fdiscussions",[243],"nofollow","GitHub discussions"," 就是我们聊这些的地方。",[247,248,249],"style",{},"html pre.shiki code .suds8, html code.shiki .suds8{--shiki-default:#0E1116;--shiki-dark:#F0F3F6}html pre.shiki code .sKwhi, html code.shiki .sKwhi{--shiki-default:#622CBC;--shiki-dark:#DBB7FF}html pre.shiki code .sT6z2, html code.shiki .sT6z2{--shiki-default:#032563;--shiki-dark:#ADDCFF}html pre.shiki code .sLBg1, html code.shiki .sLBg1{--shiki-default:#66707B;--shiki-dark:#BDC4CC}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .s-5SL, html code.shiki .s-5SL{--shiki-default:#023B95;--shiki-dark:#91CBFF}html pre.shiki code .soyes, html code.shiki .soyes{--shiki-default:#702C00;--shiki-dark:#FFB757}",{"title":31,"searchDepth":64,"depth":64,"links":251},[252,253,254,255],{"id":24,"depth":64,"text":24},{"id":87,"depth":64,"text":87},{"id":187,"depth":64,"text":187},{"id":232,"depth":64,"text":232},"配置 matchImage，并让您的基线保持整洁。","md",{},"\u002Fdocs\u002Fzh\u002Fgetting-started\u002Fusage",false,{"title":5,"description":256},"docs\u002Fzh\u002Fgetting-started\u002Fusage","YC1-khvM2H9k1d9gTijQAs58sUIOh2VsoDEy4jixGo8",[265,269,273,275,277,280,283,286,289],{"path":266,"title":267,"group":268},"\u002Fdocs\u002Fgetting-started\u002Finstall","安装","getting-started",{"path":270,"title":271,"group":272},"\u002Fdocs\u002Fintegrations\u002Fcypress-plugin","Cypress 插件","integrations",{"path":94,"title":95,"group":274},"reference",{"path":276,"title":5,"group":268},"\u002Fdocs\u002Fgetting-started\u002Fusage",{"path":278,"title":279,"group":272},"\u002Fdocs\u002Fintegrations\u002Fgithub-app","GitHub App",{"path":281,"title":282,"group":274},"\u002Fdocs\u002Freference\u002Fmanifest","清单 schema",{"path":284,"title":285,"group":268},"\u002Fdocs\u002Fgetting-started\u002Fmigrate-from-frsource","从 @frsource 迁移",{"path":287,"title":288,"group":272},"\u002Fdocs\u002Fintegrations\u002Fplaywright-reporter","Playwright 插件",{"path":290,"title":291,"group":272},"\u002Fdocs\u002Fintegrations\u002Fvitest","Vitest 插件",1794530808111]