JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q21336F
  • License MIT

A module that checks for unused and missing dependencies

Package Exports

  • really-require

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (really-require) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

really-require

A module that checks for unused and missing dependencies

API

reallyRequire(modulePath, options):

  • modulePath:
    • String: Full or relative path to module
  • options.packageJSON:
    • String: Path to package.json. Object, values of package.json.
    • Default: path.join(modulePath, 'package.json')
  • options.sourceGlob:
    • String[]: Globs to use for searching the source files.
    • Default: ['*.js', 'src/**/*.js', 'lib/**/*.js']
  • options.nodeModules:
    • String[]: paths to search in for modules.
    • Default: [path.join(modulePath, 'node_modules')]
  • options.mute.unused:
    • String[]: Mute warnings about these dependencies being unused
  • options.mute.indirect:
    • String[]: Mute warnings about these dependencies being only indirectly installed. Note that this does not mute the errors if a dependency is also missing from node_modules

The values of options.mute can also be added directly to the package.json under the field reallyRequireMute

Returns:

  • result.missing: Object[] Messages about missing dependencies
  • result.missing[].error: Flag if the warning is fatal
  • result.missing[].message: Message to display
  • result.missing[].dependency: Dependency name
  • result.missing[].location: Location of the error
  • result.missing[].location.file: Filename
  • result.missing[].location.from.line: Line at which the statement begins
  • result.missing[].location.from.column: Column at which the statement begins
  • result.missing[].location.to.line: Line at which the statement ends
  • result.missing[].location.to.column: Column at which the statement ends
  • result.unused: Object[] Messages about unused dependencies
  • result.unused[].error: Flag if the warning is fatal
  • result.unused[].message: Message to display
  • result.unused[].dependency: Dependency name
  • result.errors: Object[] Parsing errors that occured
  • result.errors[].file: File which caused the error
  • result.errors[].error: Error Object