Have ideas to improve npm?Join in the discussion! »

    find-callsite

    1.1.3 • Public • Published

    find-callsite NPM version mit license NPM monthly downloads npm total downloads

    Finds the correct place where the stack trace was started, not the place where error was thrown

    code climate code style linux build windows build code coverage dependency status paypal donate

    You might also be interested in stacktrace-metadata.

    Table of Contents

    Install

    Install with npm

    $ npm install find-callsite --save
    

    or install using yarn

    $ yarn add find-callsite
    

    Usage

    For more use-cases see the tests

    const findCallsite = require('find-callsite')

    API

    findCallsite

    Find correct callsite where error is started. All that stuff is because you not always need the first line of the stack to understand where and what happened.

    In below example we use rimraf.sync to throw some error. That's the case when we need to be informed where is the rimraf.sync call not where it throws. In that case it is on line 6, column 12.

    Params

    • error {Error|Object|String}: plain or Error object with stack property, or string stack
    • opts {Object}: optional options object
    • opts.cwd {String}: give current working directory, default to process.cwd()
    • opts.relativePaths {Boolean}: make path relative to opts.cwd, default false
    • returns {String}: single callsite from whole stack trace, e.g. at foo (/home/bar/baz.js:33:4)

    Example

    var findCallsite = require('find-callsite')
    var rimraf = require('rimraf')
     
    function fixture () {
      try {
        rimraf.sync(5555)
      } catch (err) {
        var callsiteLine = findCallsite(err)
        console.log(callsiteLine)
        // => 'at fixture (/home/charlike/apps/find-callsite/example.js:6:12)'
     
        var relativeCallsiteLine = findCallsite(err, {
          relativePaths: true
        })
        console.log(relativeCallsiteLine)
        // => 'at fixture (example.js:6:12)'
      }
    }
     
    fixture()

    Related

    Contributing

    Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
    Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
    If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

    In short: If you want to contribute to that project, please follow these things

    1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
    2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
    3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
    4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

    Thanks a lot! :)

    Building docs

    Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

    $ npm install verbose/verb#dev verb-generate-readme --global && verb
    

    Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

    Running tests

    Clone repository and run the following in that cloned directory

    $ npm install && npm test
    

    Author

    Charlike Mike Reagent

    License

    Copyright © 2017, Charlike Mike Reagent. Released under the MIT License.


    This file was generated by verb-generate-readme, v0.4.3, on March 15, 2017.
    Project scaffolded using charlike cli.

    Install

    npm i find-callsite

    DownloadsWeekly Downloads

    48

    Version

    1.1.3

    License

    MIT

    Last publish

    Collaborators

    • avatar
    • avatar