Skip to content

README.md

Latest commit

 

History

History
168 lines (124 loc) · 3.27 KB

README.md

File metadata and controls

168 lines (124 loc) · 3.27 KB

code-slicer

npm version Code Quality Code Coverage Socket

Extract minimal, dependency-aware code context from an entry file for use in AI prompts.

code-slicer is a CLI that traverses local imports from an entry file and outputs relevant code in traversal order. It is designed for AI workflows where precise context matters more than full repository dumps.

Quickstart

Installation

npm install --save-dev code-slicer

Usage

code-slicer <entry-file>
code-slicer <entry-file> --format <plain|markdown|html|xml>

Example

code-slicer src/bin.ts

What it does

  • Starts from a single entry file
  • Follows local imports and dependencies
  • Supports JavaScript, TypeScript, JSX, TSX, React, and Vue
  • Outputs files in traversal order
  • Includes full source code for each file
  • Excludes external packages and unresolved modules

Output formats

Supported formats:

  • plain (default)
  • markdown
  • html
  • xml

Plain (default)

code-slicer src/bin.ts
relative/path/to/file.ts
<source code>

relative/path/to/another-file.ts
<source code>

Markdown

code-slicer src/bin.ts --format markdown
### relative/path/to/file.ts

```
<source code>
```

### relative/path/to/another-file.ts

```
<source code>
```

HTML

code-slicer src/bin.ts --format html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>code-slicer output</title>
</head>
<body>
  <main class="code-slicer-output">
    <section class="code-slicer-file">
      <h3>relative/path/to/file.ts</h3>
      <pre><code>&lt;source code&gt;</code></pre>
    </section>
  </main>
</body>
</html>

XML

code-slicer src/bin.ts --format xml
<?xml version="1.0" encoding="UTF-8"?>
<files>
  <file path="relative/path/to/file.ts">
    <source>&lt;source code&gt;</source>
  </file>
</files>

Constraints

  • Only local file dependencies are included
  • node_modules is ignored
  • No bundling or code transformation
  • No runtime evaluation
  • Output is deterministic and file-based

Requirements

  • Node.js >= 22

How it works

  1. Detect file type (JavaScript, TypeScript, Vue)
  2. Parse source
    • TypeScript AST for JS/TS/JSX/TSX
    • Vue SFC parser for .vue files
  3. Extract imports (import, export ... from, import())
  4. Resolve modules using TypeScript resolution with fallback logic
  5. Recursively traverse dependencies
  6. Track visited files to avoid cycles
  7. Skip external and unresolved modules

Use cases

  • AI prompt generation with relevant code context
  • Dependency inspection
  • Minimal reproduction cases
  • Code review context extraction

Contributing

See CONTRIBUTING.md for process, standards, and testing expectations.

License

MIT