require-package-name

2.0.1 • Public • Published

require-package-name

stable

Gets the base package name for a module path in a require statement. Assumes the path is not relative.

var name = require('require-package-name')

//get the module name for a require path
name('events')                  => 'events'
name('events/')                 => 'events'
name('events/index.js')         => 'events'
name('@username/button/a.js')   => '@username/button'
name('@username//foo/a.js')     => '@username/foo'

//or, get the base name excluding any scope
name.base('@username/button/a.js')   => 'button'
name.base('@username//foo/a.js')     => 'foo'

Usage

NPM

name = packageName(str)

Gets the name of a module for a require string like 'xtend' from 'xtend/mutable.js'.

base = packageName.base(str)

Gets the base name of a module. This is the same as above, except it excludes scoped usernames.

License

MIT, see LICENSE.md for details.

Package Sidebar

Install

npm i require-package-name

Weekly Downloads

1,858,855

Version

2.0.1

License

MIT

Last publish

Collaborators

  • mattdesl