Skip to content

ganeshkbhat/get-root

Repository files navigation

get-root

Get root folders of git, svn, mercurial, nodejs node_modules / package.json / package-lock.json, and nodejs .jscache folder

Find the demos in the demos folder

Demo usage:

 var getroot = require("get-root"); let result = getroot.getRoot("./", { baseType: "git" }); 

.getRoot

Usage: getRoot(startdirectory, options = { baseType: "git", getRootCallback: callbackFunction })

Get the root folder of specified options.

/** * * @param {*} startdirectory * @param {string} [options={ baseType: "git", getRootCallback: callbackFunction }] * @return {*} */ 

.getNodeModulesRoot

Usage: getNodeModulesRoot(startdirectory, options)

Get the root folder of node in the project.

/** * * @param {*} startdirectory * @param {*} options * @return {*} */ 

.getGitRoot

Usage: getGitRoot(startdirectory, options)

Get the root folder of git in the project.

/** * * @param {*} startdirectory * @param {*} options * @return {*} */ 

.getSvnRoot

Usage: getSvnRoot(startdirectory, options)

Get the root folder of svn in the project.

/** * * @param {*} startdirectory * @param {*} options * @return {*} */ 

.getMercurialRoot

Usage: getMercurialRoot(startdirectory, options)

Get the root folder of mercurial in the project.

/** * * @param {*} startdirectory * @param {*} options * @return {*} * */ 

.getPackageJsonRoot

Usage: getPackageJsonRoot(startdirectory, options)

Get the root folder of package.json in the project.

/** * * @param {*} startdirectory * @param {*} options * @return {*} */ 

.getPackageLockJsonRoot

Usage: getPackageLockJsonRoot(startdirectory, options)

Get the root folder of package.json in the project.

/** * * @param {*} startdirectory * @param {*} options * @return {*} */ 

.getJscachePath

Usage: getJscachePath(startdirectory, options)

Get the root folder of jscache in the project.

/** * * * @param {*} startdirectory * @param {*} options * @return {*} */ 

Contributions

Contributions, Feature Improvements, Bugs, and Issues are invited. raising an issue

License

MIT License

About

Get root folders of git, svn, mercurial, ftp, nodejs node_modules, nodejs package.json

Resources

License

Stars

Watchers

Forks

Packages

No packages published