{"id":13672807,"url":"https://github.com/gins3000/node-debugprotocol-client","last_synced_at":"2026-01-20T18:24:58.504Z","repository":{"id":52484608,"uuid":"220972342","full_name":"gins3000/node-debugprotocol-client","owner":"gins3000","description":"A standalone node client for the VSCode Debug Adapter Protocol","archived":false,"fork":false,"pushed_at":"2024-06-17T20:24:06.000Z","size":285,"stargazers_count":9,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-30T00:58:30.038Z","etag":null,"topics":[],"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/gins3000.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-11T12:03:28.000Z","updated_at":"2024-06-17T20:24:04.000Z","dependencies_parsed_at":"2024-11-11T11:33:32.602Z","dependency_job_id":"a1bbf6b8-aca9-4819-a67f-3408924264b1","html_url":"https://github.com/gins3000/node-debugprotocol-client","commit_stats":{"total_commits":32,"total_committers":1,"mean_commits":32.0,"dds":0.0,"last_synced_commit":"6e6d442e523d783e5765bfc431d3180e1348da88"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/gins3000/node-debugprotocol-client","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gins3000%2Fnode-debugprotocol-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gins3000%2Fnode-debugprotocol-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gins3000%2Fnode-debugprotocol-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gins3000%2Fnode-debugprotocol-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gins3000","download_url":"https://codeload.github.com/gins3000/node-debugprotocol-client/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gins3000%2Fnode-debugprotocol-client/sbom","scorecard":{"id":427334,"data":{"date":"2025-08-11","repo":{"name":"github.com/gins3000/node-debugprotocol-client","commit":"e5ae2c0086e92a261ba138445d491f0df96919a5"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.5,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/26 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":"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":"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":"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":"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":"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":"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":"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:0","Info: FSF or OSI recognized license: MIT License: 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":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'main'"],"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":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 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":6,"reason":"4 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw"],"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-19T02:30:58.047Z","repository_id":52484608,"created_at":"2025-08-19T02:30:58.047Z","updated_at":"2025-08-19T02:30:58.047Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28609062,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-20T16:10:39.856Z","status":"ssl_error","status_checked_at":"2026-01-20T16:10:39.493Z","response_time":117,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-08-02T09:01:49.340Z","updated_at":"2026-01-20T18:24:57.327Z","avatar_url":"https://github.com/gins3000.png","language":"TypeScript","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"readme":"# node-debugprotocol-client\nA standalone node client for the VSCode Debug Adapter Protocol\n\n\u003e This project is a work in progress and should be used in production only with caution! Breaking changes can and will be made.\n\nThere exist a lot of implementations of the [VSCode Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/), both serverside and clientside, but there don't seem to be a lot of standalone client implementations.\n\nThis repository hosts a standalone NodeJS client library for the Debug Adapter Protocol, maybe enabling smaller node-based IDEs to get a piece of that cake too.\n\n## Targeted [vscode-debugprotocol](https://www.npmjs.com/package/vscode-debugprotocol) version\nv1.50.1\n\n## Features\n- An abstract base client (`BaseDebugClient`)\n  - Use boilerplate methods to conveniently send requests, listen to events or handle reverse requests\n  - Await `Request`s to receive the `Response` or catch `ErrorResponses` as `Error`s\n  - Register convenient async reverse-request handlers\n  - Set log level (`Off`, `On` or `Verbose`)\n- Stream-based implementation (`StreamDebugClient`)\n  - Connect with `stream.Readable` and `stream.Writable`\n- Socket-based implementation (`SocketDebugClient`)\n  - Connect with `net.Socket`\n\n\n## Usage example\n\nInstall to your node project:\n```shell\nnpm install node-debugprotocol-client\n```\n\n\nInstantiate a socket client:\n```ts\nimport { SocketDebugClient, LogLevel } from \"node-debugprotocol-client\";\n\n// create a client instance\nconst client = new SocketDebugClient({\n  port: 12345,\n  host: \"localhost\",\n  logLevel: LogLevel.Verbose,\n  loggerName: \"My Debug Adapter Client\"\n});\n\n// connect\nawait client.connectAdapter();\n```\n\nOr a stream client, if you want to handle the streams yourself:\n```ts\nimport { StreamDebugClient, LogLevel } from \"node-debugprotocol-client\";\n\n// create a client instance\nconst client = new StreamDebugClient({\n  logLevel: LogLevel.Verbose,\n  loggerName: \"My Debug Adapter Client\"\n});\n\nconst { reader, writer } = magicallyGetStreams();\n\n// connect\nclient.connectAdapter(reader, writer);\n```\n\nThen just use the client:\n```ts\n// initialize first\nawait client.initialize({\n  adapterId: \"java\",\n  // ...\n})\n\n// tell the debug adapter to attach to a debuggee which is already running somewhere\n// SpecificAttachArguments has to extend DebugProtocol.AttachRequestArguments\nawait client.attach\u003cSpecificAttachArguments\u003e({\n  // ...\n});\n\n// set some breakpoints\nawait client.setBreakpoints({\n  breakpoints: [\n    { line: 1337 },\n    { line: 42 },\n    // ...\n  ],\n  source: {\n    path: \"/path/to/file.java\"\n  }\n})\n\n// listen to events such as \"stopped\"\nconst unsubscribable = client.onStopped((stoppedEvent) =\u003e {\n  if (stoppedEvent.reason === \"breakpoint\") { \n    // we hit a breakpoint!\n\n    // do some debugging\n\n    // continue all threads\n    await client.continue({ threadId: 0 });\n  }\n});\n\n// send 'configuration done' (in some debuggers this will trigger 'continue' if attach was awaited)\nawait client.configurationDone();\n\n// ...\n\n// Event subscriptions can be unsubscribed\nunsubscribable.unsubscribe();\n\n// disconnect from the adapter when done\nclient.disconnectAdapter();\n```\n\n## Build for development\n\n```bash\ngit clone https://github.com/gins3000/node-debugprotocol-client.git\ncd node-debugprotocol-client\nnpm install\n\n# build:\nnpm run build\n# or watch mode:\nnpm run start\n```\n\nThe `npm run boilerplate:*` commands extract names and generate boilerplate methods from the vscode-debugprotocol package. This helps when accommodating for a new version of the protocol.\n\n## Issues and Feature requests\nPlease create an issue if you find this useful (or useless ;_;) and have ideas, suggestions or issues!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgins3000%2Fnode-debugprotocol-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgins3000%2Fnode-debugprotocol-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgins3000%2Fnode-debugprotocol-client/lists"}