# @youbox/config

> Utility for interacting with youbox-config.js files

Latest version **1.0.0-alpha.33** (published 2020-01-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @youbox/config
pnpm add @youbox/config
yarn add @youbox/config
bun add @youbox/config
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score; popular repo.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-alpha.33 |
| Published | 2020-01-13 |
| First published | 2019-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 10 |
| Unpacked size | 47.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13909 |
| Author | Tim Coulter |
| Maintainers | youchain |
| Keywords | youchain, youbox, config |

## Links

- npm: https://www.npmjs.com/package/@youbox/config
- Repository: https://github.com/trufflesuite/truffle/tree/master/packages/config
- Homepage: https://github.com/trufflesuite/truffle/tree/master/packages/config#readme
- Issues: https://github.com/trufflesuite/truffle/issues
- npm.io page: https://npm.io/package/@youbox/config

## Dependencies (10)

- [lodash](https://npm.io/package/lodash.md) ^4.17.13
- [module](https://npm.io/package/module.md) ^1.2.5
- [find-up](https://npm.io/package/find-up.md) ^2.1.0
- [@types/node](https://npm.io/package/@types/node.md) ^12.12.9
- [configstore](https://npm.io/package/configstore.md) ^4.0.0
- [@types/lodash](https://npm.io/package/@types/lodash.md) ^4.14.149
- [@youbox/error](https://npm.io/package/@youbox/error.md) ^1.0.0-alpha.33
- [@youbox/events](https://npm.io/package/@youbox/events.md) ^1.0.0-alpha.33
- [@youbox/provider](https://npm.io/package/@youbox/provider.md) ^1.0.0-alpha.33
- [original-require](https://npm.io/package/original-require.md) 1.0.1

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 1.0.0-alpha.33 (latest) — 2020-01-13
- 1.0.0-alpha.12 — 2019-12-25
- 1.0.0-alpha.11 — 2019-12-25
- 1.0.0-alpha.10 — 2019-12-25
- 1.0.0-alpha.9 — 2019-12-25
- 1.0.0-alpha.8 — 2019-12-25
- 1.0.0-alpha.7 — 2019-12-25
- 1.0.0-alpha.6 — 2019-12-25

## README

# @youbox/config
Utility for interacting with truffle-config.js files

### Usage
 ```javascript
const TruffleConfig = require("@youbox/config");
```

#### Instantiate default TruffleConfig object
 ```javascript
const newConfig = TruffleConfig.default();
```

#### Instantiate custom TruffleConfig object
 ```javascript
const customConfig = new TruffleConfig("/truffleDirPath", "/currentWorkingDirPath", networkObj);
```

#### Config.detect()
 ```javascript
// find config file & return new TruffleConfig object with config file settings (cwd)
const truffleConfig = TruffleConfig.detect();

// find config file & return new TruffleConfig object from custom working dir
const truffleConfig = TruffleConfig.detect({ workingDirectory: "./some/Path" });

// find & return new TruffleConfig object from custom named config
const customTruffleConfig = TruffleConfig.detect({}, "./customConfig.js");
 ```

---
_Source: https://npm.io/package/@youbox/config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._