Error Stack Parser

Common errors

• ReferenceError: require is not defined

  cause Attempting to use `require('stack-parser')` in an ES Module (ESM) context without proper transpilation or dynamic import.
  fix Ensure your file is a CommonJS module (e.g., by using `.cjs` extension or setting `"type": "commonjs"` in package.json) or use dynamic import `import('stack-parser').then(module => { const stackParser = module.default || module; /* ... */ });`.

• Error: Cannot find module 'stack-parser'

  cause The `stack-parser` package has not been installed or is not resolvable in the current Node.js environment.
  fix Run `npm install stack-parser` or `yarn add stack-parser` in your project directory.

• Property 'parse' does not exist on type 'typeof import("/path/to/node_modules/stack-parser/index")'.

  cause TypeScript compilation error due to lack of type definitions for the `stack-parser` package.
  fix Create a `declarations.d.ts` file with `declare module 'stack-parser';` or explicitly cast the import: `const stackParser: any = require('stack-parser');`.

Warnings

• deprecated This package is effectively abandoned, with its last release (v0.0.1) dating back to 2012. It is not maintained and may not be compatible with modern Node.js features or JavaScript syntax.
  Fix: Consider using actively maintained alternatives such as `error-stack-parser` or `stack-trace` for robust error stack parsing.
• gotcha The package is a CommonJS module and does not provide an ES Module (ESM) export. Attempting to `import` it directly in an ESM context will result in a runtime error.
  Fix: If used in an ESM environment, you must use a dynamic `import()` or wrap the `require()` call if your bundler supports it. E.g., `const stackParser = await import('stack-parser');` or ensure your project explicitly uses CommonJS.
• gotcha There are no TypeScript type definitions available for this package. Using it in a TypeScript project will result in type errors unless explicit `any` types are used or custom declaration files are created.
  Fix: For TypeScript projects, you'll need to create a `declarations.d.ts` file or explicitly cast the import: `const stackParser: any = require('stack-parser');`.
• gotcha The parser's robustness against different JavaScript engine stack trace formats (e.g., V8, SpiderMonkey, Chakra) or varying Node.js versions is unknown and likely limited given its age and lack of updates. Modern environments might produce stack formats it cannot fully parse.
  Fix: Thoroughly test its parsing capabilities with your target environment's stack traces. For maximum compatibility and robustness, use a modern, actively maintained stack parser library.

Install

• npm install stack-parser npm
• yarn add stack-parser yarn
• pnpm add stack-parser pnpm

Imports

• stackParser
  wrong:

  import stackParser from 'stack-parser';

  correct:

  const stackParser = require('stack-parser');

  This package is a CommonJS module from 2012. It does not export an ES module API, and direct `import` statements will fail. Use `require()` for compatibility.
• parse
  wrong:

  import { parse } from 'stack-parser';

  correct:

  const stackParser = require('stack-parser');
  const items = stackParser.parse((new Error).stack);

  The `parse` function is a method on the default export object. There are no named exports from this CommonJS module.
• here

  const stackParser = require('stack-parser');
  const items = stackParser.here();

  The `here` function is a convenience method on the default export, equivalent to `stackParser.parse((new Error).stack)`.

Quickstart

Demonstrates parsing the current execution stack using `stack-parser` and applying various formatting options for the stack frame objects, including the `here()` convenience method.

const stackParser = require('stack-parser');

// Parse the current error stack
const items = stackParser.parse((new Error).stack);

console.log('--- Default Formatting ---');
items.forEach(function(item) {
	console.log(item.format());
});

console.log('\n--- Custom Formatting (long) ---');
items.forEach(function(item) {
	console.log(item.format('%what (%file, line: %line, column: %column)'));
});

console.log('\n--- Custom Formatting (short) ---');
items.forEach(function(item) {
	console.log(item.format('%w (%f, line: %l, column: %c)'));
});

console.log('\n--- Using .here() for current stack ---');
const currentStackItems = stackParser.here();
currentStackItems.forEach(function(item) {
	console.log(item.format());
});