@ninjaxtools/slopdex 0.20.0 → 0.22.0

package/README.md

@@ -19,6 +19,8 @@ The main supported functions are
    <br/>find clusters of similar code/docs
 - `slopdex describe <query>`
    <br/>explain code relevant to a task
+- `slopdex map [PATH]...`
+   <br/>show a map/skeleton of the code structure
 
 `search` does a vector searche of code, and markdown, and when enabled generated code descriptions.
 
@@ -26,6 +28,8 @@ The main supported functions are
 
 `describe` does a `search` first, then passes the result through the configured LLM model to create a tailored description.
 
+`map` shows a map/skeleton of the code, excluding implementation details like function bodies. This can be helpful to get a concise map of the code to allow an LLM to explore the codebase incrementally.
+
 ## Installation
 
 Install from npm:
@@ -44,7 +48,8 @@ cargo install --path . --locked
 
 ## Getting started
 
-An embedding-provider API key is required. You can use either OpenAI or Jina.
+Semantic search requires an embedding-provider API key from OpenAI or Jina. `slopdex map` doesn't
+use vector search and works locally without a provider or API key.
 
 ```console
 $ export OPENAI_API_KEY="your-api-key"
@@ -54,6 +59,19 @@ $ slopdex search "validate an authenticated session"
 
 The index tracks the current git commit and is created or updated on every command and stored in `.slopdex/index.sqlite`. Add `.slopdex/` to your repository's `.gitignore` to prevent it from being committed.
 
+### Code map/skeleton
+
+```console
+$ slopdex map src docs
+$ slopdex map src -g '*.rs' -k fns -e 'refresh|search'
+$ slopdex map -g '*.md' -e '^Guide\.Setup' -i --format json
+$ slopdex map --no-reindex
+```
+
+The `map` command can be used to generate a source code skeleton that strips most of the code implementation but retains many of the structurally useful information that can act as an index into the source code. The resulting index output is most useful to conserve tokens and improve the agentic programming experience.
+
+See the [selector reference](docs/reference.md#shared-selectors).
+
 ### Search
 
 By default all available indexes are searched and ranked together.
@@ -179,8 +197,10 @@ $ slopdex cross-search --cross-file-only --cohesion --threshold 0.8
 Just put this in your `AGENTS.md` file, no skill required:
 
 ```
+- use `slopdex map -g <glob> <files or directories...>` to obtain a compact structural code skeleton, and then perform targeted reads for implementation details. Line numbers are indicated in square brackets (e.g [5] means line 5, and [5-10] means lines 5 to 10). To filter for specific symbols, use `-e`. To only include specific kinds of symbols use `-k` with `imports`, `fns`, `consts`, `types`, or `classes`. For example: `slopdex map -g "*.ts" -i -e "manager|main" src`.
 - use semantic code search to find code with: `slopdex search "..." --threshold 0.5`
 - when reviewing uncommitted code avoid introducing duplicates by looking for related matches: `slopdex cross-search --uncommitted --threshold 0.8`
+- don't use `*` as the glob since that circumvents the default ignore rules.
 ```
 
 Any other use, like doing a full `cross-search` is probably better done interactively with the agent, in which case you can just ask the agent to run `slopdex --help` to get usage information.

package/npm-shrinkwrap.json

@@ -19,7 +19,7 @@
       "hasInstallScript": true,
       "license": "MIT",
       "name": "@ninjaxtools/slopdex",
-      "version": "0.20.0"
+      "version": "0.22.0"
     },
     "node_modules/detect-libc": {
       "engines": {
@@ -48,5 +48,5 @@
     }
   },
   "requires": true,
-  "version": "0.20.0"
+  "version": "0.22.0"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "artifactDownloadUrls": [
-    "https://github.com/ninjaxtools/slopdex/releases/download/v0.20.0"
+    "https://github.com/ninjaxtools/slopdex/releases/download/v0.22.0"
   ],
   "bin": {
     "slopdex": "run-slopdex.js"
@@ -80,7 +80,7 @@
       "zipExt": ".tar.xz"
     }
   },
-  "version": "0.20.0",
+  "version": "0.22.0",
   "volta": {
     "node": "18.14.1",
     "npm": "9.5.0"