import-all.macro

A macro for babel-plugin-macros that allows you to import all files that match a glob

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
import-all.macro
17703.1.04 years ago7 years agoMinified + gzip package size for import-all.macro in KB

Readme

import-all.macro

A babel-plugin-macro that allows you to import all files that match a glob


!Build Statusbuild-badgebuild !Code Coveragecoverage-badgecoverage !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !MIT Licenselicense-badgelicense
All Contributors !PRs Welcomeprs-badgeprs !Code of Conductcoc-badgecoc !Babel Macromacros-badgebabel-plugin-macros

The problem

You want to import all files that match a glob without having to import them individually.

This solution

This is a babel-plugin-macrobabel-plugin-macros which allows you to import files that match a glob. It supports import statements for synchronous resolution as well as dynamic import() for deferred resolution (for code splitting with react router for example).

Table of Contents


- πŸ› Bugs - πŸ’‘ Feature Requests

Installation

This module is distributed via npmnpm which is bundled with nodenode and should be installed as one of your project's devDependencies:
npm install --save-dev import-all.macro

Usage

Once you've configured babel-plugin-macros you can import/require import-all.macro.
The importAll functions accept a globglob and will transpile your code to import statements/dynamic imports for each file that matches the given glob.
Let's imagine you have a directory called my-files with the files a.js, b.js, c.js, and d.js.
Here are a few before/after examples:

importAll uses dynamic import: README:1 importAll uses dynamic import
import importAll from 'import-all.macro'

document.getElementById('load-stuff').addEventListener('click', () => {
  importAll('./files/*.js').then(all => {
    console.log(all)
  })
})

      ↓ ↓ ↓ ↓ ↓ ↓

document.getElementById('load-stuff').addEventListener('click', () => {
  Promise.all([
    import('./files/a.js'),
    import('./files/b.js'),
    import('./files/c.js'),
    import('./files/d.js'),
  ])
    .then(function importAllHandler(importVals) {
      return {
        './files/a.js': importVals[0],
        './files/b.js': importVals[1],
        './files/c.js': importVals[2],
        './files/d.js': importVals[3],
      }
    })
    .then(all => {
      console.log(all)
    })
})

importAll.sync uses static imports: README:2 importAll.sync uses static imports
import importAll from 'import-all.macro'

const a = importAll.sync('./files/*.js')

      ↓ ↓ ↓ ↓ ↓ ↓

import * as _filesAJs from './files/a.js'
import * as _filesBJs from './files/b.js'
import * as _filesCJs from './files/c.js'
import * as _filesDJs from './files/d.js'
const a = {
  './files/a.js': _filesAJs,
  './files/b.js': _filesBJs,
  './files/c.js': _filesCJs,
  './files/d.js': _filesDJs,
}

importAll.deferred gives an object with dynamic imports: README:3 importAll.deferred gives an object with dynamic imports
import importAll from 'import-all.macro'

const routes = importAll.deferred('./files/*.js')

      ↓ ↓ ↓ ↓ ↓ ↓

const routes = {
  './files/a.js': function () {
    return import('./files/a.js')
  },
  './files/b.js': function () {
    return import('./files/b.js')
  },
  './files/c.js': function () {
    return import('./files/c.js')
  },
  './files/d.js': function () {
    return import('./files/d.js')
  },
}


Configure importAll to transform import path before generating imports
babel-plugin-macros.config.js:
module.exports = {
  importAll: {
    transformModulePath(modulePath, importingPath) {
      const projectRoot = path.join(__dirname, '../../')
      const modulePathWithoutExt = modulePath.replace(/\.js$/, '')
      const absolutePath = path.resolve(
        path.dirname(importingPath),
        modulePathWithoutExt,
      )
      const pathRelativeToRoot = path.relative(projectRoot, absolutePath)
      return pathRelativeToRoot
    },
  },
}

import importAll from 'import-all.macro'
const a = importAll.sync('./files/*.js')
      ↓ ↓ ↓ ↓ ↓ ↓
import * as _filesA from './files/a'
import * as _filesB from './files/b'
import * as _filesC from './files/c'
import * as _filesD from './files/d'
const a = {
  './files/a': _filesA,
  './files/b': _filesB,
  './files/c': _filesC,
  './files/d': _filesD,
}

Caveats

Some static analysis tools (like ESLint, Flow, and Jest) wont like this very much without a little additional work. So Jest's watch mode may not pick up all your tests that are relevant based on changes and some ESLint plugins (like eslint-plugin-import) will probably fail on this.

Inspiration

Sunil Pai's tweetsunil-tweet

Other Solutions

I'm not aware of any, if you are please make a pull requestprs and add it here!

Issues

Looking to contribute? Look for the Good First Issuegood-first-issue label.

πŸ› Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.
See Bugs
bugs

πŸ’‘ Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding a πŸ‘. This helps maintainers prioritize what to work on.
See Feature Requestsrequests

Contributors ✨

Thanks goes to these people (emoji keyemojis):
<td align="center"><a href="https://kentcdodds.com"><img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;" alt=""/><br /><sub><b>Kent C. Dodds</b></sub></a><br /><a href="https://github.com/kentcdodds/import-all.macro/commits?author=kentcdodds" title="Code">πŸ’»</a> <a href="https://github.com/kentcdodds/import-all.macro/commits?author=kentcdodds" title="Documentation">πŸ“–</a> <a href="#infra-kentcdodds" title="Infrastructure (Hosting, Build-Tools, etc)">πŸš‡</a> <a href="https://github.com/kentcdodds/import-all.macro/commits?author=kentcdodds" title="Tests">⚠️</a></td>
<td align="center"><a href="http://jonathantneal.com"><img src="https://avatars0.githubusercontent.com/u/188426?v=4" width="100px;" alt=""/><br /><sub><b>Jonathan Neal</b></sub></a><br /><a href="https://github.com/kentcdodds/import-all.macro/commits?author=jonathantneal" title="Documentation">πŸ“–</a></td>
<td align="center"><a href="https://fatfisz.com"><img src="https://avatars0.githubusercontent.com/u/6004414?v=4" width="100px;" alt=""/><br /><sub><b>RafaΕ‚ RuciΕ„ski</b></sub></a><br /><a href="https://github.com/kentcdodds/import-all.macro/issues?q=author%3Afatfisz" title="Bug reports">πŸ›</a> <a href="https://github.com/kentcdodds/import-all.macro/commits?author=fatfisz" title="Code">πŸ’»</a></td>
<td align="center"><a href="https://stackshare.io/jdorfman/decisions"><img src="https://avatars1.githubusercontent.com/u/398230?v=4" width="100px;" alt=""/><br /><sub><b>Justin Dorfman</b></sub></a><br /><a href="#fundingFinding-jdorfman" title="Funding Finding">πŸ”</a></td>
<td align="center"><a href="https://michaeldeboey.be"><img src="https://avatars3.githubusercontent.com/u/6643991?v=4" width="100px;" alt=""/><br /><sub><b>MichaΓ«l De Boey</b></sub></a><br /><a href="https://github.com/kentcdodds/import-all.macro/commits?author=MichaelDeBoey" title="Code">πŸ’»</a></td>
<td align="center"><a href="https://chengjianhua.github.io"><img src="https://avatars0.githubusercontent.com/u/10795207?v=4" width="100px;" alt=""/><br /><sub><b>Jianhua Cheng</b></sub></a><br /><a href="https://github.com/kentcdodds/import-all.macro/commits?author=chengjianhua" title="Code">πŸ’»</a> <a href="https://github.com/kentcdodds/import-all.macro/commits?author=chengjianhua" title="Tests">⚠️</a> <a href="https://github.com/kentcdodds/import-all.macro/commits?author=chengjianhua" title="Documentation">πŸ“–</a></td>


This project follows the all-contributorsall-contributors specification. Contributions of any kind welcome!

LICENSE

MIT