joycon/README.md

# joycon

[![NPM version](https://img.shields.io/npm/v/joycon.svg?style=flat)](https://npmjs.com/package/joycon) [![NPM downloads](https://img.shields.io/npm/dm/joycon.svg?style=flat)](https://npmjs.com/package/joycon) [![install size](https://packagephobia.now.sh/badge?p=joycon@2.0.0)](https://packagephobia.now.sh/result?p=joycon@2.0.0) [![CircleCI](https://circleci.com/gh/egoist/joycon/tree/master.svg?style=shield)](https://circleci.com/gh/egoist/joycon/tree/master)  [![donate](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000&style=flat)](https://github.com/egoist/donate) [![chat](https://img.shields.io/badge/chat-on%20discord-7289DA.svg?style=flat)](https://chat.egoist.moe)

## Differences with [cosmiconfig](https://github.com/davidtheclark/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 only `.js` and `.json` file are parsed, otherwise raw data will be returned, so you can add custom loader to parse them:

```js
const joycon = new JoyCon()

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

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

## API

### constructor([options])

#### 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.

### resolve([files], [cwd], [stopDir])
### resolve([options])

`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.

### load(...args)

The signature is the same as [resolve](#resolvefiles-cwd-stopdir).

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

There's also `.loadSync` method.

### addLoader(Loader)

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

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

### removeLoader(name)

Remove loaders by loader name.

### clearCache()

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](https://github.com/egoist), Released under the [MIT](./LICENSE) License.<br>
Authored and maintained by egoist with help from contributors ([list](https://github.com/egoist/joycon/contributors)).

> [github.com/egoist](https://github.com/egoist) · GitHub [@egoist](https://github.com/egoist) · Twitter [@_egoistlily](https://twitter.com/_egoistlily)