sindresorhus / import-modules

Import all modules in a directory

import-modules

Import all modules in a directory

This package is intentionally simple. Not interested in more features.

Install

$ npm install import-modules

Usage

.
└── directory
    ├── foo-bar.js
    └── baz-faz.js

const importModules = require('import-modules');

const modules = importModules('directory');

console.log(modules);
//=> {fooBar: [Function], bazFaz: [Function]}

API

importModules(directory?, options?)

directory

Type: string
Default: __dirname

Directory to import modules from. Unless you've set the fileExtensions option, that means any .js, .json, .node files, in that order. Does not recurse. Ignores the caller file and files starting with . or _.

options

Type: object

camelize

Type: boolean
Default: true

Convert dash-style names (foo-bar) and snake-style names (foo_bar) to camel-case (fooBar).

fileExtensions

Type: string[]
Default: ['.js', '.json', '.node']

File extensions to look for. Order matters.

Related

• import-from - Import a module from a given path
• import-cwd - Import a module from the current working directory
• import-lazy - Import a module lazily

import-modules's Issues

typescript version

In the future, I will attempt to fork and convert this to TS.

Breaks in repl

> const importModules = require('import-modules');
Thrown:
TypeError [ERR_INVALID_ARG_TYPE]: The "path" argument must be of type string. Received type object
    at validateString (internal/validators.js:125:11)
    at Object.dirname (path.js:1121:5)
    at Object.<anonymous> (/Users/xo/code/unraid/cli/node_modules/import-modules/index.js:8:24)
    at Module._compile (internal/modules/cjs/loader.js:816:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:827:10)
    at Module.load (internal/modules/cjs/loader.js:685:32)
    at Function.Module._load (internal/modules/cjs/loader.js:620:12)
    at Module.require (internal/modules/cjs/loader.js:723:19)
    at require (internal/modules/cjs/helpers.js:14:16)

TypeScript support

This is an awesome project, and it would be great to get TypeScript support! 😊

Cannot read property 'filename' of undefined

I have the following index.js file:

import importModules from 'import-modules'

const modules = importModules('./test')

console.log(modules);

export default modules

In the same folder as the index.js file, there is a sub-folder test with multiple .js files.

But, the above code produces the following exception: "Cannot read property 'filename' of undefined"

Jest modifies require.extensions

I'm writing a shareable ESLint config that uses eslint-plugin-unicorn which uses this module.

Inspired by Test Your ESLint config I'm testing my config with Jest.

I was seeing failures around being able to load the eslint-plugin-unicorn rules and after looking at the code here and looking across tools I was using the problem I'm experiencing seems to be caused by jestjs/jest#281.

While the problem is "caused by" Jest it seems like a difficult issue for Jest to resolve and I wondered if a solution might be possible in import-modules, e.g.

var extensions = Object.assign({}, {
    // Jest will redefine require.extensions to be {}
    // so add back default implementation(s) if not available
    '.js': require('default-require-extensions/js')
  }, require.extensions);

for (const ext of Object.keys(extensions)) {
  ...

A change like the above would mean that I get the default js implementation back and rules for eslint-plugin-unicorn load.

This is pretty similar to #1, but continues to use require.extensions.

some problems, please help me, thk

import-modules/index.js

Line 24 in fc622bb

const done = new Set();

Why should define: const done = new Set();

i think

 for(const i in returnValue){
    typeof i === 'string'
  }

if (done.has(filenameStem) || can be replaced with if (!!returnValue[filenameStem]) ||