esrol-autoloader/README.md

An Autoloader Class for automatically including files.

[![NPM version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Test coverage][coveralls-image]][coveralls-url]

# esrol-autoloader
An Autoloader Class for automatically including files.

*Part of [Esrol](https://github.com/esrol/esrol)*

## Installation

```sh
$ npm install --save esrol-autoloader
```
## Node Version Compatibility

| Node Version |
| ---- |
| >= 4.x |

## Usage

```js
'use strict';
const Autoloader = require('esrol-autoloader');
let settings = {
  getNamespaces: true,
  getAsObject: true,
  path: __dirname + '/app',
  filesToSkip: ['controllers.skipMe', 'routes.skipMe']
};
let folders = new Autoloader(settings);
console.log(folders);
// { app:
//    { controllers: { foo: [Function: Foo] },
//      routes: { baz: [Object], foo: [Function: Foo] } },
//   namespaces: [ 'controllers.foo', 'routes.baz.bar', 'routes.foo' ] }
```

<a name="Autoloader"></a>
## Autoloader
<a name="new_Autoloader_new"></a>
### new Autoloader()
An Autoloader Class for automatically including files.

## Contriubtion

Any contribution will be highly appreciated. Just make sure that:

1.Your code works.  
2. You have 100% successful tests coverage.  
3. You have comments in your code.  
4. Follows eslint config. Exceptions are possible where that make sense.  

## Tests

  To run the test suite, first install the dependencies, then run `npm test`:

```bash
$ npm install
$ npm test
```

## License

[MIT](https://github.com/esrol/esrol-autoloader/blob/master/LICENSE)



[npm-image]: https://badge.fury.io/js/esrol-autoloader.svg
[npm-url]: https://npmjs.org/package/esrol-autoloader
[travis-image]: https://travis-ci.org/esrol/esrol-autoloader.svg?branch=master
[travis-url]: https://travis-ci.org/esrol/esrol-autoloader
[coveralls-image]: https://coveralls.io/repos/esrol/esrol-autoloader/badge.svg
[coveralls-url]: https://coveralls.io/r/esrol/esrol-autoloader