1.0.0 • Published 9 years ago

utils-dirname v1.0.0

Weekly downloads
12
License
MIT
Repository
github
Last release
9 years ago

dirname

NPM version Build Status Coverage Status Dependencies

Returns a directory name.

Installation

$ npm install utils-dirname

Usage

var dirname = require( 'utils-dirname' );

dirname( path )

Returns a directory name.

var dir = dirname( './foo/bar/index.js' );
// returns './foo/bar'

Examples

var fs = require( 'fs' ),
	path = require( 'path' ),
	dirname = require( 'utils-dirname' );

var files,
	fpath,
	base,
	stat,
	dir,
	i;

base = path.resolve( __dirname, '..' );
files = fs.readdirSync( base );

for ( i = 0; i < files.length; i++ ) {
	fpath = path.join( base, files[ i ] );
	stat = fs.statSync( fpath );
	if ( !stat.isDirectory() ) {
		dir = dirname( fpath );
		console.log( '%s --> %s', fpath, dir );
	}
}

To run the example code from the top-level application directory,

$ node ./examples/index.js

Tests

Unit

Unit tests use the Mocha test framework with Chai assertions. To run the tests, execute the following command in the top-level application directory:

$ make test

All new feature development should have corresponding unit tests to validate correct functionality.

Test Coverage

This repository uses Istanbul as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:

$ make test-cov

Istanbul creates a ./reports/coverage directory. To access an HTML version of the report,

$ make view-cov

License

MIT license.

Copyright

Copyright © 2015. Athan Reines.