https://github.com/immoweltgroup/find-config-up

Resolve your packages configuration from a .*rc or package.json file with a given property up the file-tree.
https://github.com/immoweltgroup/find-config-up

configuration raw-config rc rc-files resolve

Last synced: 3 months ago
JSON representation

Resolve your packages configuration from a .*rc or package.json file with a given property up the file-tree.

• Host: GitHub
• URL: https://github.com/immoweltgroup/find-config-up
• Owner: ImmoweltGroup
• License: mit
• Created: 2017-11-03T15:22:29.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-07-08T04:20:15.000Z (over 1 year ago)
• Last Synced: 2024-11-14T06:35:31.625Z (3 months ago)
• Topics: configuration, raw-config, rc, rc-files, resolve
• Language: JavaScript
• Homepage:
• Size: 357 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# find-config-up

[![Powered by Immowelt](https://img.shields.io/badge/powered%20by-immowelt-yellow.svg?colorB=ffb200)](https://stackshare.io/immowelt-group/)

[![Build Status](https://travis-ci.org/ImmoweltGroup/find-config-up.svg?branch=master)](https://travis-ci.org/ImmoweltGroup/find-config-up)

[![Dependency Status](https://david-dm.org/ImmoweltGroup/find-config-up.svg)](https://david-dm.org/ImmoweltGroup/find-config-up)

[![devDependency Status](https://david-dm.org/ImmoweltGroup/find-config-up/dev-status.svg)](https://david-dm.org/ImmoweltGroup/find-config-up#info=devDependencies&view=table)

[![Renovate enabled](https://img.shields.io/badge/renovate-enabled-brightgreen.svg)](https://renovateapp.com/)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

Resolve your packages configuration from a `.*rc` or `package.json` file with a given property up the file-tree.

## Install

```sh

$ yarn add find-config-up

```

## API

#### Getting started

```js

const findConfigUp = require('find-config-up');

(async function() {

  //

  // Tries to find a `.myfancyrc` up the tree and merges it with the defaults,

  // if no file was found it falls back to resolving a `package.json` up the tree

  // with a `my-fancy-package` property defined.

  //

  // If none of the above was successful, the defaults will be returned.

  //

  const config = await findConfigUp({

    rawConfigFileName: '.myfancyrc',

    packageJsonProperty: 'my-fancy-package',

    defaults: {}

  });

  console.log(config);

})()

```

#### Options

##### `rawConfigFileName: string` (Optional)

The file name of your preffered `.rc` file, e.g. `.babelrc`, which should be resolved up the file-system tree.

##### `packageJsonProperty: string`

The property name which should be resolved in the `package.json` files up the file-system tree.

##### `defaults: Object`

The defaults which will be recursively merged with the results from the file-system.

##### `cwd: string` (Optional)

A custom current working directory, falls back to `process.cwd()`.

## Contributing

See the `CONTRIBUTING.md` file at the root of the repository.

## Licensing

See the `LICENSE` file at the root of the repository.