hello-index

1.0.1 • Public • Published

hello-index

hello-index is an auto-generated (and customizable) index file to require all files in a directory.

Build Status Coverage Status Dependency Status Standard - JavaScript Style Guide

Installation

yarn add hello-index

Usage

'use strict'
 
const index = require('hello-index')
 
module.exports = index(__dirname)

By default, all files and directories in __dirname will be added to the export list. All dotfiles will be ignored.

API

function (basePath, [options])

Options

  • case: A String explaining how to export filenames, can be one of exact (match case exactly), camel (use camelCase), or class (use ClassName case) (default: camel)
  • ignore: An Array of files or directories to ignore (default: [])

Readme

Keywords

none

Package Sidebar

Install

npm i hello-index

Weekly Downloads

6

Version

1.0.1

License

MIT

Last publish

Collaborators

  • venables