`typescript
import { processCode } from '@didnhdj/fnmap';

const code =
export function hello(name) {
console.log('Hello, ' + name);
}
;

const result = processCode(code, { filePath: 'example.js' });

if (result.success) {
console.log('Functions:', result.info.functions);
console.log('Imports:', result.info.imports);
console.log('Call Graph:', result.info.callGraph);
} else {
console.error('Parse error:', result.error);
}
`

$3

`typescript
import { processFile } from '@didnhdj/fnmap';

const result = processFile('./src/utils.js');

if (result.success) {
console.log('Analysis result:', result.info);
}
`

$3

`typescript
// Process result type
type ProcessResult = ProcessSuccess | ProcessFailure;

interface ProcessSuccess {
success: true;
info: FileInfo;
}

interface ProcessFailure {
success: false;
error: string;
errorType: ErrorType;
loc?: { line: number; column: number };
}

// File info structure
interface FileInfo {
imports: ImportInfo[];
functions: FunctionInfo[];
classes: ClassInfo[];
constants: ConstantInfo[];
callGraph: CallGraph;
isPureTypeFile: boolean; // Whether file only contains type definitions
}
`

Use Cases

$3

fnmap is designed to help AI coding assistants understand your codebase better:

`bash


Initialize and setup AI documentation

The .fnmap files help AI assistants:
- Navigate large codebases efficiently
- Find specific functions/classes by name and line number
- Understand module dependencies and call graphs
- Provide context-aware code suggestions

Recommended workflow with Claude Code or similar AI tools:
1. Run fnmap --init to add format documentation to CLAUDE.md
2. Generate index files with fnmap --dir src
3. AI assistants will automatically read .fnmap files for context
4. Update index when code changes with fnmap --changed

$3

Add to .husky/pre-commit or .git/hooks/pre-commit:

`bash
#!/bin/sh
fnmap --staged
git add .fnmap
`

This automatically updates the .fnmap index when committing code.

$3

`yaml


.github/workflows/ci.yml

`bash


Generate index for changed files

- .js - JavaScript
- .ts - TypeScript
- .jsx - React JSX
- .tsx - React TypeScript
- .mjs - ES Modules

Auto-filtered files:
- .d.ts, .d.tsx, .d.mts - Type definition files
- Files containing only type or interface declarations (pure type files)

Limitations

To ensure performance and safety, fnmap has the following default limits:
- File Size: Maximum 10MB per file
- Directory Depth: Maximum recursion depth of 50 levels

How It Works

1. AST Parsing: Uses @babel/parser to parse code into Abstract Syntax Tree
2. Structure Analysis: Traverses AST to extract imports, functions, classes, constants
3. Call Graph: Tracks function call relationships and dependencies
4. Index Generation: Generates compact .fnmap files with structured information

Examples

$3

`bash
fnmap --files src/utils.js
`

Output:
`
==================================================
fnmap - AI Code Indexing Tool
==================================================

Analyzing: src/utils.js
✓ Imports: 3, Functions: 5, Classes: 0, Constants: 2

Generating .fnmap index...
✓ src/utils.fnmap

==================================================
Complete! Analyzed: 1, Failed: 0
==================================================
`

$3

`bash
fnmap --dir src
`

Generates:
- src/.fnmap - Code index for all files in src directory

$3

`bash


Make changes to code

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT

Related Projects

- @babel/parser - JavaScript parser
- @babel/traverse - AST traversal
- Mermaid - Diagram generation

Support

- 🐛 Report Issues
- 💡 Feature Requests
- 📖 Documentation