JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 70023
  • Score
    100M100P100Q146593F
  • License

node.js utility for exporting a directory of files as modules.

Package Exports

  • export-files

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (export-files) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

export-files Build Status NPM version

node.js utility for exporting a directory of files as modules.

Install with npm

npm i export-files --save

Usage

Specify the directory with files to export (this is a required argument):

module.exports = require('export-files')(__dirname);
//=> {a: [function], b: [function], c: [function]}

Params

module.exports = require('export-files')(dir, patterns, recurse, options, fn);
  • dir {String}: (required) directory with files to export.
  • patterns {String|Array|RegExp}: (optional) glob patterns or regex for filtering files
  • recurse {Boolean|Object}: (optional) or options. When true reads directories recursivly. Default is false.
  • options {Object}: (optional) options for filtering, reading, and recursion.
    • read {Function}: function for reading or requiring files
    • renameKey {Function}: function for naming keys on the returned object
    • filter {Function}: function for filtering files
  • fn {Function}: (optional) pass a custom reader function.

Examples

glob patterns

Filter and require only .json files:

module.exports = require('export-files')(__dirname, '**/*.json');

Filter and require only .yml files, with a custom

module.exports = require('export-files')(__dirname, '**/*.json');

Regex

Filter and require only .js files:

module.exports = require('export-files')(__dirname, /\.js$/);

Run Tests

Install dev dependencies:

npm i -d && npm test
  • map-files: Return an object for a glob of files. Pass a rename function for the keys, or a parse function for the content, allowing it to be used for readable or require-able files.

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue

Author

Jon Schlinkert

License

Copyright (c) 2014-2015 Jon Schlinkert
Released under the MIT license

This file was generated by verb-cli on March 01, 2015.