1.1.0 • Published 8 years ago

find-root v1.1.0

Weekly downloads
4,913,775
License
MIT
Repository
github
Last release
8 years ago

find-root

recursively find the closest package.json

Build Status

usage

Say you want to check if the directory name of a project matches its module name in package.json:

const path = require('path')
const findRoot = require('find-root')

// from a starting directory, recursively search for the nearest
// directory containing package.json
const root = findRoot('/Users/jsdnxx/Code/find-root/tests')
// => '/Users/jsdnxx/Code/find-root'

const dirname = path.basename(root)
console.log('is it the same?')
console.log(dirname === require(path.join(root, 'package.json')).name)

You can also pass in a custom check function (by default, it checks for the existence of package.json in a directory). In this example, we traverse up to find the root of a git repo:

const fs = require('fs')

const gitRoot = findRoot('/Users/jsdnxx/Code/find-root/tests', function (dir) {
  return fs.existsSync(path.resolve(dir, '.git'))
})

api

findRoot: (startingPath : string, check?: (dir: string) => boolean) => string

Returns the path for the nearest directory to startingPath containing a package.json file, eg /foo/module.

If check is provided, returns the path for the closest parent directory where check returns true.

Throws an error if no package.json is found at any level in the startingPath.

installation

> npm install find-root

running the tests

From package root:

> npm install
> npm test

contributors

  • jsdnxx

license

MIT. (c) 2017 jsdnxx

babel-plugin-emotionarchetype-library@kevindurb/react-toolboxkilli8n-react-native-fast-imagern-device-informationpackage-assetsburra-cling-x-climetrovue-cli@steven-torres/jsxrgui-jvale-dawn-cliwebflow-reactgui-jvale-cligui-jvale-dawn-toolsseed-cli-tools@c11/engine.cli-service-web@broken-css/webpack-loadere2rayngtscogoportutilszikkurat@nansen/stylemark@infinitebrahmanuniverse/nolb-findreact-native-alias@everything-registry/sub-chunk-1669t-kelly-slatet-kelly-slate-toolsswoop-boilerplatetable-react-qvc-muiweb-ext-buildwdswebapp-webpack-pluginwremoterequirexj-commitizenwxa-cli2-appleww-musicsuperset-plugin-chart-hello-world2splittablestrapi-boing-adminstrapi-maxiphy-adminsvelte-component-libvstar-formatvstar-standardvite-plugin-faviconvite-plugin-favicon2vault-envvault-env-extendedvarufakervideo-multi-uploadervideojs-spellbookvideojs-standardvideojs-standard-formatviber-botkitvue-dev-clonevudash@dotdev/next-cli@dotdev/next-config@dotdev/next-webpack@crazytoucan/tsunami@cristianps1988/ds-template@csssr/e2e-tools@concepto/interface@cute-apocalypse/react-tree@dionlarson/commitizen@deku-scrubs/standard@c11/engine.service-web@c11/engine.cli@blkmarketco/components-library@candlecorp/codegen@postinumero/babel-preset-i18next@peak-stone/commitizen-promise@poscredit/plugin-chart-boris@pravdomil/blocksjarbjinghuan-cachejinghuanjsjibo-sdkjibo-toolsjibo-devjibo-flow-corejibo-gulpjibo-kbjibo-cai-utilsjeb.jsjest-enforcejswjspm-resolvejinghuan-clijinghuan-configjinghuan-sessionjs-dev-utilsjs-import-sort@meeehdi/strapi-admindotnet-settingsxbuild-mgrappversion-mgranci-reactmtva-teleport-toolstyle-guide-mainstart-starwars-lib
1.1.0

8 years ago

1.0.0

9 years ago

0.1.2

9 years ago

0.1.1

12 years ago

0.1.0

12 years ago