https://github.com/christophervoigt/cattleman
a helper library that gathers files and entry points
https://github.com/christophervoigt/cattleman
bundle entry file helper library modular multiple
Last synced: 3 months ago
JSON representation
a helper library that gathers files and entry points
- Host: GitHub
- URL: https://github.com/christophervoigt/cattleman
- Owner: christophervoigt
- License: mit
- Created: 2017-07-09T10:18:13.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-03-12T18:44:36.000Z (about 6 years ago)
- Last Synced: 2025-03-12T09:49:23.072Z (3 months ago)
- Topics: bundle, entry, file, helper, library, modular, multiple
- Language: JavaScript
- Homepage:
- Size: 58.6 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cattleman
[](https://www.npmjs.com/package/cattleman)
[](https://npmcharts.com/compare/cattleman?minimal=true)
[](https://travis-ci.org/chlorophyllkid/cattleman)
[](https://coveralls.io/github/chlorophyllkid/cattleman?branch=master)
[](https://david-dm.org/chlorophyllkid/cattleman)
[](https://www.codefactor.io/repository/github/chlorophyllkid/cattleman)
Cattleman is a small helper library. It parses a given directory and gathers files and entry objects.
These objects can be used in bundler configurations (e.g. [webpack](https://github.com/webpack/webpack) or [rollup](https://github.com/rollup/rollup)) to extend the entry property.
## Installation
Install it with npm:
```shell
$ npm install cattleman --save-dev
```
## Usage
Require it for example in your `webpack.config.js` like:
```javascript
const Cattleman = require('cattleman')
let config = {
entry: {
bundle: [ 'src/bundle.js', 'src/bundle.css' ]
},
output: {
filename: 'modules/[name].js',
path: __dirname + '/dist'
},
module: {
rules: [ ... ]
},
plugins: [ ... ]
}
const cattleman = new Cattleman('src/modules')
const entries = cattleman.gatherEntries()
config.entry = Object.assign({}, config.entry, entries)
module.exports = config
```
## Options
You can init a cattleman instance without options. These are the defaults:
```javascript
defaults = {
directory: 'src', // search directory
excludes: [ 'test' ] // filepaths, which include a string listed here, are ignored
}
```
If you just pass a string to the constructor, cattleman interprets it as the directory.
## Methods
* **gatherFiles( extentionFilter )** - returns the list of files in the search directory
[optional] *extentionFilter* - (string | array) - valid file type(s) (e.g. `'.js'` or `['.js', '.css']`)
**Warning**: If extentionFilter equals an empty array, no extention is valid.
## Example
Let's say you got a `src/` folder in your projects directory containing the code of your site:
```bash
src/
└─ modules/
├─ footer/
│ ├─ footer.css
│ ├─ footer.html
│ └─ footer.js
├─ header/
│ ├─ header.css
│ ├─ header.html
│ └─ header.js
└─ ...
```
Imagine there are 20 - 30 modules more.
```javascript
const cattleman = new Cattleman('src/modules')
const files = cattleman.gatherFiles()
// now files whould look like this
[
'src/modules/footer/footer.css',
'src/modules/footer/footer.html',
'src/modules/footer/footer.js',
'src/modules/header/header.css',
'src/modules/header/header.html',
'src/modules/header/header.js',
...
]
const jsFiles = cattleman.gatherFiles('.js')
// now jsFiles whould look like this
[
'src/modules/footer/footer.js',
'src/modules/header/header.js',
...
]
config.entry = {
bundle: jsFiles
}
module.exports = config
```
## License
This library was written by [Christopher Voigt](https://twitter.com/chlorophyllkid) and is licensed under [MIT](https://github.com/chlorophyllkid/cattleman/blob/master/LICENSE).