Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 1.03 KB

readme.md

File metadata and controls

53 lines (37 loc) · 1.03 KB
Raw

Config Exists

If you want to load configurations, pls go to cosmiconfig

Check if config file is existed in specific folder:

  • a [name].config.js (anywhere up the directory tree)
  • a JSON or YAML "rc file" (anywhere up the directory tree)

For Example:

  • exists.config.js
  • .existsrc.js
  • .existsrc.json
  • .existsrc.yml
  • .existsrc.yaml

Installation

$ npm i --save config-exists
# or
$ yarn add config-exists

Usage

Sync

const config = require('config-exists')
const { exists } = config({name: 'exists'})
const stats = exists('__tests__/fixtures')
// stats: false if not exists, or instance of fs.Stats

Async

const config = require('config-exists')
const { existsAsync } = await config({name: 'exists'})
const stats = exists('__tests__/fixtures')
// stats: false if not exists, or instance of fs.Stats

Options

name

Type: string Name of config file

rcExtensions

Type: bool Default: true Flag to search rc files