feat(sdk): remove deprecated TS implementation; add napi-rs SDK (@pleaseai/csp-sdk)#56
Merged
Conversation
The Rust port (crates/csp + crates/csp-cli) is the only implementation; the upstream Python (MinishLab/semble) is the parity oracle. The TS src/ was deprecated and is no longer the source of truth, so remove it along with its dedicated build (tsdown.config.ts) and runtime deps. Keep the Node/Bun toolchain as repo JS tooling (lint/typecheck of npm/) and the release-please version anchor, and as scaffolding for the planned napi-rs native-binding SDK. - delete src/ (impl + tests; src/agents duplicated crates/csp-cli/agents) - delete tsdown.config.ts; drop tsdown + TS runtime deps from package.json - package.json: remove dist build scripts/exports/bin; keep lint/typecheck - tsconfig: drop src/** and tsdown.config.ts from include - release-please-config: drop deleted src/version.ts extra-file (node anchor kept) - ci.yml: drop bun test/codecov steps (Rust tests run in rust.yml) - CLAUDE.md: reframe to Rust-only impl + record SDK packaging decision (A)
Add the in-process JS SDK distribution channel (decision A): a napi-rs native addon over crates/csp, shipped as @pleaseai/csp-sdk. Kept separate from the npm/ CLI/MCP launcher (which execs the standalone binary and preserves the no-runtime Homebrew story); both share the one crates/csp core. Public surface mirrors the README library contract — a CspIndex class (fromPath / fromGit / loadFromDisk / search / findRelated / save / stats) over camelCase Chunk / SearchResult / IndexStats. napi-rs maps Rust snake_case to JS camelCase. - crates/csp-node: Cargo.toml (cdylib+lib), build.rs (napi_build), src/lib.rs (#[napi] bindings) - @pleaseai/csp-sdk package.json (@napi-rs/cli v2), committed index.d.ts type surface, README, .gitignore - workspace: add member + napi/napi-derive/napi-build deps - release-please: sync crates/csp-node/package.json $.version - CLAUDE.md: record the crate + scaffolding status Verified: cargo fmt --check, clippy --workspace -D warnings, and test --workspace (csp 257 + csp-cli 8 pass, csp-node links) all green. Follow-ups (async factories, napi CI matrix, README cross-link) tracked in crates/csp-node/README.md.
Complete the three csp-node follow-ups. 1. Async factories — fromPath / fromGit / loadFromDisk now run on the libuv worker pool via napi AsyncTask and resolve Promise<CspIndex>, so indexing / clone / disk read no longer block the Node event loop (no tokio needed). search / findRelated / save / stats stay sync (fast and/or borrow &self). index.d.ts updated to Promise<CspIndex>. 2. Release CI — add release-sdk.yml: a 6-target napi cross-compile matrix (darwin arm64/x64, linux x64/arm64-gnu + x64-musl via zig, win32 x64) plus a publish job using npm Trusted Publishing (OIDC, provenance). Wired into release-please.yml as build-and-publish-sdk on release_created. All actions SHA-pinned. Publish is credential-gated (needs npm trusted-publisher config). 3. README cross-link — document @pleaseai/csp-sdk in the Library usage section of README.md / README.ko.md (bilingual, in sync), and clarify the two npm packages: @pleaseai/csp (CLI/MCP launcher) vs @pleaseai/csp-sdk (in-process SDK). Verified: cargo fmt --check, clippy --workspace -D warnings, test --workspace (csp 257 + csp-cli 8 pass, csp-node links), and both workflow YAMLs parse.
|
Review the following changes in direct dependencies. Learn more about Socket for GitHub.
|
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 22 |
| Duplication | 5 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request completes the transition of the codebase from TypeScript to Rust by removing the deprecated TypeScript implementation and introducing crates/csp-node, which provides napi-rs native Node bindings for the core search engine. Feedback on the changes highlights a potential performance risk where the synchronous execution of CspIndex::search and CspIndex::find_related could block the Node.js event loop during CPU-intensive operations. To address this, it is recommended to wrap the inner CoreIndex in std::sync::Arc across the napi tasks, facilitating a smoother transition to asynchronous execution in the future.
📝 WalkthroughWalkthroughThe PR removes the entire TypeScript runtime implementation under ChangesRust-only SDK migration
Estimated code review effort🎯 4 (Complex) | ⏱️ ~60 minutes Possibly related issues
Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
CI 'test' job (eslint) flagged three auto-fixable issues: - release-sdk.yml: unquote a plain-scalar description (yaml/plain-scalar) - README.md / README.ko.md: sort named imports (ContentType before CspIndex)
|
gemini-code-assist suggestion: hold the core index behind std::sync::Arc so a future async search / find_related can hand a cheap shared handle to a libuv worker thread instead of cloning the whole index. Arc derefs transparently, so the sync method bodies are unchanged.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
crates/csp-node/README.md (1)
55-60: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick winAlign release-process docs with the actual workflow implementation.
Lines 55-60 say CI publishes via
napi prepublish -t npm, but.github/workflows/release-sdk.ymlcurrently performscreate-npm-dirs+artifacts+ directnpm publish. The README should match the real release path.📝 Suggested text update
-Cross-compilation targets mirror the binary release (`release-rust.yml`): darwin arm64/x64, linux x64/arm64-gnu + x64-musl, win32 x64. Publishing follows the standard napi-rs flow (build per-target on CI → `napi artifacts` → `napi prepublish -t npm`), with the version kept in lockstep by release-please (`crates/csp-node/package.json#version` is an `extra-files` entry). +Cross-compilation targets mirror the binary release (`release-rust.yml`): darwin arm64/x64, linux x64/arm64-gnu + x64-musl, win32 x64. Publishing in CI assembles platform dirs with `napi create-npm-dirs` + `napi artifacts`, then publishes per-platform packages and the wrapper via npm Trusted Publishing; versioning stays in lockstep via release-please (`crates/csp-node/package.json#version` in `extra-files`). @@ -Cross-compilation + publish runs in [`release-sdk.yml`](../../.github/workflows/release-sdk.yml): a per-target build matrix produces `csp-sdk.<triple>.node` artifacts, then a publish job runs `napi prepublish -t npm` to push the wrapper + per-platform packages via npm Trusted Publishing (OIDC). It triggers on the `@pleaseai/csp-sdk` release tag (or manual dispatch); the version stays in lockstep via release-please (`extra-files`). +Cross-compilation + publish runs in [`release-sdk.yml`](../../.github/workflows/release-sdk.yml): a per-target build matrix produces `csp-sdk.<triple>.node` artifacts, then a publish job assembles npm package dirs and runs `npm publish` for platform packages + wrapper via npm Trusted Publishing (OIDC). It runs manually or as a reusable workflow called by `release-please.yml`; versioning stays in lockstep via release-please (`extra-files`).🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@crates/csp-node/README.md` around lines 55 - 60, The README documentation in the "CI / release" section incorrectly describes the publishing process. It states that the CI performs `napi prepublish -t npm` to publish packages, but the actual implementation in `.github/workflows/release-sdk.yml` uses a different sequence: `create-npm-dirs`, `artifacts`, and direct `npm publish`. Update the documentation in this section to accurately reflect the real release workflow steps and match what is actually implemented in the GitHub Actions workflow.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.github/workflows/release-sdk.yml:
- Around line 60-62: The checkout action in the release-sdk workflow is using
the default persisted token unnecessarily since this job does not perform any
git pushes. Disable credential persistence by adding the persist-credentials
option set to false in the actions/checkout action. Match the same pattern
already implemented in the publish job which includes this security hardening
practice. This reduces the risk of credential exposure by not persisting the
GitHub token when it is not needed.
In `@CLAUDE.md`:
- Around line 9-12: The documentation in CLAUDE.md lines 9-12 describing the
napi-rs SDK still uses future tense ("planned", "scaffolded", "remaining
follow-ups") even though this PR introduces the shipped crates/csp-node
implementation and SDK release automation. Update the wording in the paragraph
describing the napi-rs SDK and its distribution to reflect present/past tense,
conveying that crates/csp-node is now shipped as `@pleaseai/csp-sdk`, that SDK
bindings and build infrastructure are in place, and that only specific remaining
enhancements (async factories, CI matrix) remain as follow-ups tracked
separately.
---
Outside diff comments:
In `@crates/csp-node/README.md`:
- Around line 55-60: The README documentation in the "CI / release" section
incorrectly describes the publishing process. It states that the CI performs
`napi prepublish -t npm` to publish packages, but the actual implementation in
`.github/workflows/release-sdk.yml` uses a different sequence:
`create-npm-dirs`, `artifacts`, and direct `npm publish`. Update the
documentation in this section to accurately reflect the real release workflow
steps and match what is actually implemented in the GitHub Actions workflow.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 15f36ad4-780e-4ee0-8f5a-9a9ae1385d50
⛔ Files ignored due to path filters (2)
Cargo.lockis excluded by!**/*.lockbun.lockis excluded by!**/*.lock
📒 Files selected for processing (75)
.github/workflows/ci.yml.github/workflows/release-please.yml.github/workflows/release-sdk.ymlCLAUDE.mdCargo.tomlREADME.ko.mdREADME.mdcrates/csp-node/.gitignorecrates/csp-node/Cargo.tomlcrates/csp-node/README.mdcrates/csp-node/build.rscrates/csp-node/index.d.tscrates/csp-node/package.jsoncrates/csp-node/src/lib.rspackage.jsonrelease-please-config.jsonsrc/agents/antigravity.mdsrc/agents/claude.mdsrc/agents/commandcode.mdsrc/agents/copilot.mdsrc/agents/cursor.mdsrc/agents/gemini.mdsrc/agents/kiro.mdsrc/agents/opencode.mdsrc/agents/pi.mdsrc/agents/reasonix.mdsrc/chunking/.gitkeepsrc/chunking/chunk-source.test.tssrc/chunking/chunk-source.tssrc/chunking/core.test.tssrc/chunking/core.tssrc/cli.test.tssrc/cli.tssrc/index.test.tssrc/index.tssrc/indexing/.gitkeepsrc/indexing/cache.test.tssrc/indexing/cache.tssrc/indexing/create.test.tssrc/indexing/create.tssrc/indexing/dense.test.tssrc/indexing/dense.tssrc/indexing/file-walker.test.tssrc/indexing/file-walker.tssrc/indexing/index.test.tssrc/indexing/index.tssrc/indexing/sparse.test.tssrc/indexing/sparse.tssrc/indexing/types.test.tssrc/indexing/types.tssrc/languages.test.tssrc/languages.tssrc/mcp/.gitkeepsrc/mcp/server.test.tssrc/mcp/server.tssrc/ranking/.gitkeepsrc/ranking/boosting.test.tssrc/ranking/boosting.tssrc/ranking/penalties.test.tssrc/ranking/penalties.tssrc/ranking/weighting.test.tssrc/ranking/weighting.tssrc/search.test.tssrc/search.tssrc/stats.test.tssrc/stats.tssrc/tokens.test.tssrc/tokens.tssrc/types.test.tssrc/types.tssrc/utils.test.tssrc/utils.tssrc/version.tstsconfig.jsontsdown.config.ts
💤 Files with no reviewable changes (55)
- src/utils.ts
- src/tokens.test.ts
- tsdown.config.ts
- src/agents/copilot.md
- src/indexing/file-walker.test.ts
- src/chunking/core.ts
- src/agents/antigravity.md
- src/search.test.ts
- src/languages.ts
- src/indexing/types.test.ts
- src/indexing/sparse.test.ts
- src/ranking/weighting.test.ts
- src/indexing/create.ts
- src/stats.test.ts
- src/chunking/chunk-source.test.ts
- src/agents/opencode.md
- src/indexing/file-walker.ts
- src/indexing/dense.test.ts
- src/agents/kiro.md
- src/index.test.ts
- src/ranking/weighting.ts
- src/utils.test.ts
- src/agents/pi.md
- src/indexing/types.ts
- src/mcp/server.test.ts
- src/chunking/core.test.ts
- src/indexing/sparse.ts
- src/indexing/cache.test.ts
- src/agents/reasonix.md
- src/indexing/create.test.ts
- src/types.test.ts
- src/search.ts
- src/version.ts
- src/cli.ts
- src/agents/cursor.md
- src/index.ts
- src/indexing/index.ts
- src/chunking/chunk-source.ts
- src/agents/gemini.md
- src/cli.test.ts
- src/tokens.ts
- src/agents/commandcode.md
- src/ranking/penalties.test.ts
- src/ranking/penalties.ts
- src/stats.ts
- src/types.ts
- src/indexing/dense.ts
- src/ranking/boosting.test.ts
- src/ranking/boosting.ts
- src/languages.test.ts
- src/mcp/server.ts
- src/agents/claude.md
- .github/workflows/ci.yml
- src/indexing/index.test.ts
- src/indexing/cache.ts
…UDE.md - release-sdk.yml: set persist-credentials: false on the build job checkout (build-only, never pushes; matches the publish job) — zizmor artipacked - CLAUDE.md: update SDK wording from planned/scaffolded to shipped state (async factories, Arc-wrapped inner, release-sdk.yml CI all in place; only the npm trusted-publisher config remains)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Two related changes shipped together:
Remove deprecated TypeScript implementation under
src/(57 files) and its dedicated build (tsdown.config.ts) and runtime deps. The Rust port (crates/csp+crates/csp-cli) is the only implementation going forward; upstream Python (MinishLab/semble) is the parity oracle. Node/Bun toolchain is retained for repo JS tooling (lint/typecheck ofnpm/) and the release-please version anchor.Add napi-rs native SDK as a separate distribution channel: new crate
crates/csp-nodewith#[napi]bindings overcrates/csp, shipped as the@pleaseai/csp-sdknpm package. Distinct from thenpm/CLI/MCP launcher (which execs the standalone binary and preserves the no-runtime Homebrew story).Changes
src/TypeScript implementation (57 files),tsdown.config.ts, and associated runtime depscrates/csp-nodecrate with#[napi]bindings exposingCspIndexovercrates/cspCspIndex(fromPath/fromGit/loadFromDiskas asyncPromise<CspIndex>on the libuv worker pool;search/findRelated/save/statssync) over camelCaseChunk/SearchResult/IndexStatsrelease-sdk.yml— 6-target napi cross-compile matrix + npm Trusted Publishing (OIDC), wired intorelease-please.yml; all actions SHA-pinned@pleaseai/csp-sdkTest Plan
cargo fmt --check— passescargo clippy --workspace -D warnings— passescargo test --workspace— 257 (csp) + 8 (csp-cli) pass,csp-nodelinksNote / not locally verifiable: the actual
napi buildcross-compile + npm publish run only in CI; npm publish additionally requires trusted-publisher config for@pleaseai/csp-sdkand its 6 platform packages.Summary by cubic
Removed the deprecated TypeScript code and made the Rust core the only implementation. Added a native Node SDK via napi-rs (
@pleaseai/csp-sdk) with a release pipeline that builds and publishes prebuilt addons (hardened checkout).New Features
crates/csp-nodewith#[napi]bindings exposingCspIndex(asyncfromPath/fromGit/loadFromDisk; syncsearch/findRelated/save/stats).release-sdk.ymland triggered it fromrelease-please.yml(OIDC Trusted Publishing) to cross-compile and publish@pleaseai/csp-sdk.@pleaseai/csp(CLI) vs@pleaseai/csp-sdk(in-process SDK).Refactors
src/TypeScript implementation, tests, andtsdown.config.ts;package.jsonnow only holds repo tooling.CspIndexcore inArcfor cheap sharing; removed Bun coverage/Codecov from CI.crates/csp-node/package.jsoninrelease-please-config.json; hardened SDK CI checkout (persist-credentials: false).Written for commit 2ff840a. Summary will update on new commits.
Summary by CodeRabbit
@pleaseai/csp-sdk) for in-process index building and searching using native Rust bindings (including cross-platform native addon distribution).@pleaseai/csp(CLI/MCP) vs@pleaseai/csp-sdk(in-process SDK), plus a new SDK usage guide.