mirror of https://github.com/JamesIves/github-pages-deploy-action.git synced 2023-12-15 20:03:39 +08:00

History

JamesIves b0873d092b 3.4.3 Dependencies		2020-03-31 08:57:48 -04:00
..
index.js	Dependencies	2020-03-06 22:45:40 -05:00
license	Dependencies	2020-03-06 22:45:40 -05:00
package.json	3.4.3 Dependencies	2020-03-31 08:57:48 -04:00
readme.md	Dependencies	2020-03-06 22:45:40 -05:00

readme.md

parent-module

Get the path of the parent module

Node.js exposes module.parent, but it only gives you the first cached parent, which is not necessarily the actual parent.

Install

$ npm install parent-module

Usage

// bar.js
const parentModule = require('parent-module');

module.exports = () => {
	console.log(parentModule());
	//=> '/Users/sindresorhus/dev/unicorn/foo.js'
};

// foo.js
const bar = require('./bar');

bar();

API

parentModule([filepath])

By default, it will return the path of the immediate parent.

filepath

Type: string
Default: __filename

Filepath of the module of which to get the parent path.

Useful if you want it to work multiple module levels down.

Tip

Combine it with read-pkg-up to read the package.json of the parent module.

const path = require('path');
const readPkgUp = require('read-pkg-up');
const parentModule = require('parent-module');

console.log(readPkgUp.sync({cwd: path.dirname(parentModule())}).pkg);
//=> {name: 'chalk', version: '1.0.0', …}