joycon

     

Differences with cosmiconfig?

JoyCon is zero-dependency but feature-complete.

Install

``bash
yarn add joycon
`

Usage

`js
const JoyCon = require('joycon')

const joycon = new JoyCon()

joycon.load(['package-lock.json', 'yarn.lock'])
.then(result => {
// result is {} when files do not exist
// otherwise { path, data }
})
`

By default non-js files are parsed as JSON, if you want something different you can add a loader:

`js
const joycon = new JoyCon()

joycon.addLoader({
test: /\.toml$/,
load(filepath) {
return require('toml').parse(filepath)
}
})

joycon.load(['cargo.toml'])
`

API

$3

#### options

##### files

- Type: string[]

The files to search.

##### cwd

The directory to search files.

##### stopDir

The directory to stop searching.

##### packageKey

You can load config from certain property in a package.json file. For example, when you set packageKey: 'babel', it will load the babel property in package.json instead of the entire data.

##### parseJSON

- Type: (str: string) => any
- Default: JSON.parse

The function used to parse JSON string.

$3

files defaults to options.files.

cwd defaults to options.cwd.

stopDir defaults to options.stopDir then path.parse(cwd).root.

If using a single object options, it will be the same as constructor options.

Search files and resolve the path of the file we found.

There's also .resolveSync method.

$3

The signature is the same as resolve.

Search files and resolve { path, data } of the file we found.

There's also .loadSync method.

$3

`typescript
interface Loader {
name?: string
test: RegExp
load(filepath: string)?: Promise
loadSync(filepath: string)?: any
}
`

At least one of load and loadSync is required, depending on whether you're calling the synchonous methods or not.

$3

Remove loaders by loader name.

$3

Each JoyCon instance uses its own cache.

Contributing

1. Fork it!
2. Create your feature branch: git checkout -b my-new-feature
3. Commit your changes: git commit -am 'Add some feature'
4. Push to the branch: git push origin my-new-feature`
5. Submit a pull request :D

Author

joycon © egoist, Released under the MIT License.

Authored and maintained by egoist with help from contributors (list).

> github.com/egoist · GitHub @egoist · Twitter @_egoistlily