Skip to content
This repository was archived by the owner on Nov 21, 2023. It is now read-only.
/ hello-index Public archive

Auto-generated index file to require all files in a directory

Notifications You must be signed in to change notification settings

hello-js/hello-index

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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: [])

About

Auto-generated index file to require all files in a directory

Resources

Stars

Watchers

Forks

Packages

No packages published