{"id":20405608,"url":"https://github.com/nitrictech/snippy","last_synced_at":"2026-05-11T15:04:38.544Z","repository":{"id":46197456,"uuid":"390612251","full_name":"nitrictech/snippy","owner":"nitrictech","description":"Multi-lang snippet parser for stable documentation snippets","archived":true,"fork":false,"pushed_at":"2021-11-08T02:45:07.000Z","size":276,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2026-02-04T21:06:47.381Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/nitrictech.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2021-07-29T05:35:59.000Z","updated_at":"2026-01-28T23:22:38.000Z","dependencies_parsed_at":"2022-09-26T18:31:35.356Z","dependency_job_id":null,"html_url":"https://github.com/nitrictech/snippy","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/nitrictech/snippy","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitrictech%2Fsnippy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitrictech%2Fsnippy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitrictech%2Fsnippy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitrictech%2Fsnippy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nitrictech","download_url":"https://codeload.github.com/nitrictech/snippy/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nitrictech%2Fsnippy/sbom","scorecard":{"id":689355,"data":{"date":"2025-08-11","repo":{"name":"github.com/nitrictech/snippy","commit":"0af3db602a6cf5d6d03b8254d4f77a6e76209a86"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.3,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","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":"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":"Code-Review","score":5,"reason":"Found 7/14 approved changesets -- score normalized to 5","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":"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":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/publish-on-release.yaml:1","Warn: no topLevel permission defined: .github/workflows/test.yaml:1","Warn: no topLevel permission defined: .github/workflows/version-bump.yaml:1","Info: no jobLevel write permissions found"],"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":"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":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-on-release.yaml:13: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/publish-on-release.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-on-release.yaml:17: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/publish-on-release.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish-on-release.yaml:22: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/publish-on-release.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:14: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/test.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/test.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-bump.yaml:16: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/version-bump.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-bump.yaml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/version-bump.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-bump.yaml:25: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/version-bump.yaml/main?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/version-bump.yaml:46: update your workflow using https://app.stepsecurity.io/secureworkflow/nitrictech/snippy/version-bump.yaml/main?enable=pin","Info:   0 out of   9 GitHub-owned GitHubAction dependencies pinned"],"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":"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":"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":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE: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":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"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"}},{"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 23 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"25 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-h5c3-5r3r-rr8q","Warn: Project is vulnerable to: GHSA-rmvr-2pp2-xj38","Warn: Project is vulnerable to: GHSA-xx4v-prfh-6cgc","Warn: Project is vulnerable to: GHSA-pwfr-8pq7-x9qv","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-8cf7-32gw-wr33","Warn: Project is vulnerable to: GHSA-hjrf-2m68-5959","Warn: Project is vulnerable to: GHSA-qwph-4952-7xr6","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-r683-j2x4-v87g","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-38fc-wpqx-33j7","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-22T01:55:09.434Z","repository_id":46197456,"created_at":"2025-08-22T01:55:09.435Z","updated_at":"2025-08-22T01:55:09.435Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32900080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-10T13:40:02.631Z","status":"online","status_checked_at":"2026-05-11T02:00:05.975Z","response_time":120,"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":[],"created_at":"2024-11-15T05:12:08.299Z","updated_at":"2026-05-11T15:04:38.516Z","avatar_url":"https://github.com/nitrictech.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @nitric/snippy\n\n![Tests](https://github.com/nitrictech/snippy/actions/workflows/test.yaml/badge.svg?branch=main)\n[![codecov](https://codecov.io/gh/nitrictech/snippy/branch/main/graph/badge.svg?token=FFKZJQJQ3L)](https://codecov.io/gh/nitrictech/snippy)\n[![Version](https://img.shields.io/npm/v/@nitric/snippy.svg)](https://npmjs.org/package/@nitric/snippy)\n[![Downloads/week](https://img.shields.io/npm/dw/@nitric/snippy.svg)](https://npmjs.org/package/@nitric/snippy)\n\n\u003e The Code snippet parser.\n\nThe `@nitric/snippy` package was created to find and parse snippets into readable data that can be consumed by any application.\n\nThis package was used to create all code snippets used in the [nitric documentation.](https://nitric.io/docs)\n\n## Features\n\n- **Any langauge**. Parses snippets in any programming language.\n- **Universal**. Works in all modern browsers and [Node.js](https://nodejs.org/).\n- **Typed**. Has entensive TypeScript declarations.\n\n## Usage\n\n### Node 12+\n\nInstall with `npm install @nitric/snippy`, or `yarn add @nitric/snippy`\n\n#### Get a snippet\n\n```typescript\nconst { snippy } = require('@nitric/snippy');\n\nconst result = await snippy().get(\n  'nitrictech/node-sdk/examples/documents/get.ts'\n);\n```\n\n#### Get a snippet with Auth\n\n```typescript\nconst { snippy } = require('@nitric/snippy');\n\nconst result = await snippy({\n  auth: process.env.GITHUB_AUTH_TOKEN,\n}).get('nitrictech/node-sdk/examples/documents/get.ts');\n```\n\n#### Search\n\n```typescript\nconst { snippy } = require('@nitric/snippy');\n\nconst result = await snippy({\n  repos: [\n    {\n      url: 'nitrictech/node-sdk',\n      exts: ['ts', 'js'],\n    },\n    {\n      url: 'nitrictech/go-sdk',\n      exts: ['go'],\n    },\n    {\n      url: 'nitrictech/python-sdk',\n      exts: ['py'],\n    },\n  ],\n}).search();\n```\n\n#### Search with auth\n\nInstall with `npm install @nitric/snippy`, or `yarn add @nitric/snippy`\n\n```typescript\nimport { snippy } from '@nitric/snippy';\n\nconst result = await snippy({\n  auth: process.env.GITHUB_AUTH_TOKEN,\n  repos: [\n    {\n      url: 'nitrictech/node-sdk',\n      exts: ['ts', 'js'],\n    },\n    {\n      url: 'nitrictech/go-sdk',\n      exts: ['go'],\n    },\n    {\n      url: 'nitrictech/python-sdk',\n      exts: ['py'],\n    },\n  ],\n}).search();\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitrictech%2Fsnippy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnitrictech%2Fsnippy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnitrictech%2Fsnippy/lists"}