Skip to content

Commit 91c6ccc

Browse files
committed
rm dashes
1 parent 3fecc7b commit 91c6ccc

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ Uses tree-sitter to split source code at semantic boundaries (functions, classes
1515

1616
## Features
1717

18-
- **AST-aware** Splits at semantic boundaries, never mid-function
19-
- **Rich context** Scope chain, imports, siblings, entity signatures
20-
- **Contextualized text** Pre-formatted for embedding models
21-
- **Multi-language** TypeScript, JavaScript, Python, Rust, Go, Java
22-
- **Streaming** Process large files incrementally
23-
- **Effect support** First-class Effect integration
18+
- **AST-aware**: Splits at semantic boundaries, never mid-function
19+
- **Rich context**: Scope chain, imports, siblings, entity signatures
20+
- **Contextualized text**: Pre-formatted for embedding models
21+
- **Multi-language**: TypeScript, JavaScript, Python, Rust, Go, Java
22+
- **Streaming**: Process large files incrementally
23+
- **Effect support**: First-class Effect integration
2424

2525
## How It Works
2626

@@ -53,10 +53,10 @@ Code is split at semantic boundaries while respecting the `maxChunkSize` limit.
5353
### 5. Enrich with Context
5454

5555
Each chunk is enriched with contextual metadata:
56-
- **Scope chain** Where this code lives (e.g., inside which class/function)
57-
- **Entities** What's defined in this chunk
58-
- **Siblings** What comes before/after (for continuity)
59-
- **Imports** What dependencies are used
56+
- **Scope chain**: Where this code lives (e.g., inside which class/function)
57+
- **Entities**: What's defined in this chunk
58+
- **Siblings**: What comes before/after (for continuity)
59+
- **Imports**: What dependencies are used
6060

6161
This context is formatted into `contextualizedText`, optimized for embedding models to understand semantic relationships.
6262

@@ -166,9 +166,9 @@ await Effect.runPromise(program)
166166
Chunk source code into semantic pieces with context.
167167

168168
**Parameters:**
169-
- `filepath` File path (used for language detection)
170-
- `code` Source code string
171-
- `options` Optional configuration
169+
- `filepath`: File path (used for language detection)
170+
- `code`: Source code string
171+
- `options`: Optional configuration
172172

173173
**Returns:** `Promise<Chunk[]>`
174174

@@ -246,9 +246,9 @@ Detect programming language from file extension.
246246

247247
### Errors
248248

249-
**`ChunkingError`** Thrown when chunking fails (parsing error, extraction error, etc.)
249+
**`ChunkingError`**: Thrown when chunking fails (parsing error, extraction error, etc.)
250250

251-
**`UnsupportedLanguageError`** Thrown when the file extension is not supported
251+
**`UnsupportedLanguageError`**: Thrown when the file extension is not supported
252252

253253
Both errors have a `_tag` property for Effect-style error handling.
254254

0 commit comments

Comments
 (0)