danawoodman / parent-folder

Get the name of the parent folder for a given path.

Home Page:https://www.npmjs.com/package/parent-folder

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

parent-folder

Travis CI build status Dependency Status View on npm View on npm Code Climate

Get the name of the parent folder.

For the given path return the name of the most immediate parent folder. Useful for scripts and generators where you want to use the parent folder name in some way (project naming, etc).

Install

npm install --save parent-folder

Usage

var parentFolder = require('parent-folder');

// Assuming we're currently in:  /foo/bar/index.js

// Defaults to current folder of call:
parentFolder()
//=> 'bar'

// Passing in a path to a folder:
parentFolder('/some/path/here')
//=>  'here'

// If using in a path to a file, make sure to
// pass in `true` flag as the second parameter.
parentFolder('/path/to/project/file.js', true)
//=> 'project'

Should also work on Windows. If it doesn't, please submit an issue.

API

See the API docs for full documentation.

Contributing

Pull requests welcome!

Please use the .editorconfig, .eslintrc configurations in your editor to ensure proper formatting.

Run the test suite with npm test and linting with npm run lint, make sure tests are passing and that you write tests for new features.

License

MIT © Dana Woodman

About

Get the name of the parent folder for a given path.

https://www.npmjs.com/package/parent-folder

License:MIT License


Languages

Language:JavaScript 100.0%