{"id":32520764,"url":"https://github.com/getkey/svg-patcher","last_synced_at":"2025-10-28T05:50:20.608Z","repository":{"id":57375528,"uuid":"81344448","full_name":"getkey/svg-patcher","owner":"getkey","description":"Save bandwidth by patching similar SVG files on the client side","archived":false,"fork":false,"pushed_at":"2017-03-08T15:48:57.000Z","size":13,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-08-09T16:53:52.889Z","etag":null,"topics":["bandwidth","optimization","patch","patcher","svg"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getkey.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"license.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-02-08T15:31:20.000Z","updated_at":"2017-03-07T09:43:43.000Z","dependencies_parsed_at":"2022-09-07T13:40:18.301Z","dependency_job_id":null,"html_url":"https://github.com/getkey/svg-patcher","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/getkey/svg-patcher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getkey%2Fsvg-patcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getkey%2Fsvg-patcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getkey%2Fsvg-patcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getkey%2Fsvg-patcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getkey","download_url":"https://codeload.github.com/getkey/svg-patcher/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getkey%2Fsvg-patcher/sbom","scorecard":{"id":424281,"data":{"date":"2025-08-11","repo":{"name":"github.com/getkey/svg-patcher","commit":"4c32dd2c5ae349a83c9cfb1a56d005b7048ff095"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/8 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: license.txt:0","Info: FSF or OSI recognized license: Apache License 2.0: license.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}}]},"last_synced_at":"2025-08-19T01:55:44.671Z","repository_id":57375528,"created_at":"2025-08-19T01:55:44.671Z","updated_at":"2025-08-19T01:55:44.671Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":281391766,"owners_count":26492903,"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","status":"online","status_checked_at":"2025-10-28T02:00:06.022Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["bandwidth","optimization","patch","patcher","svg"],"created_at":"2025-10-28T05:50:17.611Z","updated_at":"2025-10-28T05:50:20.599Z","avatar_url":"https://github.com/getkey.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# svg-patcher\n\nWhen you are using several similar SVG files in the same project, you should edit them using JavaScript instead of downloading many slightly different versions of the same image.\nThis library attempts to make this easy.\n\n## Try the example\n\nJust start `example/example.html` in your browser.\n\nIf you use Chrome you need to start it with the flag `--allow-file-access-from-files`. Don't worry, [your users won't have to do that](http://www.chrome-allow-file-access-from-file.com/). This is only needed when loading files from the file system.\n\n## How to use\n\nSimply include `svg-patcher.js` in your project.\nIt will export `svgPatcher` in the global scope.\n\n### svgPatcher.fetch(url)\n\n* `url`: String\n\nThis function returns a `Promise` that resolves with a SVG [`Document`](https://developer.mozilla.org/en-US/docs/Web/API/Document).\n\n```javascript\nsvgPatcher.fetch('https://getkey.eu/magnifying_glass_icon.svg').then(svgDocument =\u003e {\n\tconsole.log(svgDocument);\n});\n```\n\n### svgPatcher.patch(svgDocument, patcher[, clonable])\n\n* `svgDocument`: Document\n* `patcher`: Function\n* `clonable`: Boolean\n\nThe `patcher` callback takes the SVG `Document` you pass to `svgPatcher.patch()` as an argument.\n\n`svgPatcher.patch()` returns a `Promise` that resolves with a patched SVG [`Image`](https://developer.mozilla.org/en-US/docs/Web/API/HTMLImageElement).\n\n```javascript\nfunction patcher(svgDocument) {\n\t// navigate and modify the SVG's DOM however you want\n\tsvgDocument.children[0].setAttribute('fill', 'yellow');\n}\n\nsvgPatcher.patch(svgDocument, patcher).then(img =\u003e {\n\tdocument.body.appendChild(img);\n});\n```\n\nIf `clonable` is unset or set to `false`, the resolved image will not be clonable, ie:\n\n```javascript\nlet newImg = oldImg.cloneNode(true); // won't work\n\nlet newImg = new Image(); // won't\nnewImg.src = oldImg.src; // work\n```\n\nIf you set `clonable` to `true`, once you are done cloning it, you should release memory by calling [svgPatcher.revoke()](#svgpatcherrevokeimg).\n\n### svgPatcher.revoke(img)\n\n* img: `Image`\n\n[Releases the memory](https://developer.mozilla.org/en-US/docs/Web/API/URL/revokeObjectURL) used to load your `Image`. Use this function only if you no longer need to clone your image.\n\nIt is only useful to use this function on clonable images.\n\nYou can use this function on the original `Image` or any of its clones.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetkey%2Fsvg-patcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgetkey%2Fsvg-patcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgetkey%2Fsvg-patcher/lists"}