Nocturnally Psychologizing Millipede
Miss any of our Open RFC calls?Watch the recordings here! »

coffeelint-callback-handle-error

1.0.3 • Public • Published

coffeelint-callback-handle-error

CoffeeLint rule that finds instances of error objects passed through a callback function without being handled.

Ex: Any of these code blocks do not handle their error variable:

fs.stat '/invalid/path/to/file'(err, stats)->
  console.log stats
  return
fs.stat '/invalid/path/to/file'(err, stats)->
  # this err is not handled and is instead overwritten by the next stat 
 
  fs.stat '/some/other/invalid/file'(err, stats2)->
    if err
      console.log err
    return
  return

These examples will pass, since their error variables are handled:

fs.stat '/invalid/path/to/file'(err, stats)->
  if err
    console.log err
  return
doStuff 123(callback)->
  fs.stat '/invalid/path/to/file'(err, stats)->
    callback err
    return
  return

Installation

npm install coffeelint-callback-handle-error

Usage

To get started, insert this configuration somewhere in your coffeelint.json file:

"callback_handle_error"{
  "module": "coffeelint-callback-handle-error"
}

Configuration

This plugin has one custom configurable option.

patterns: ["^err(or)?", "[Ee]rr(or)?$"]

A list of regular expressions used to match parameter names for detecting error objects in function parameters.

The default setting looks for any variable which starts with "err"/"error" or ends with "err"/"Err" or "error"/"Error".

Install

npm i coffeelint-callback-handle-error

DownloadsWeekly Downloads

2

Version

1.0.3

License

MIT

Last publish

Collaborators

  • avatar