dynamic-import-js

A library to generate an importation file to require all local JS and JSX files.

Installation

Install the package

npm install dynamic-import-js --save

or

yarn add dynamic-import-js --save

Configure the package

Add a file named .dynamic-import-js.json at the root folder with the following structure:

{
  "root": "./path/to/your/root/js/files",
  "exceptions": [
    "file-1.txt",
    "folder/file-2.js",
    ...
  ],
  "prefixlessFolders": [
    "folder-1",
    "folder-2/folder-3",
    ...
  ]
}

The key root is the path, relative to the project folder, where all JS and JSX files will be scanned.

The key exceptions is a list of files paths, relative to the root folder, that will not be included in the generated file.

The key prefixlessFolders is a list of folders that won't be used to form the assigned global resource. See Naming Pattern.

Configure the make-import command

Merge the following with your packaje.json file:

{
  "scripts": {
    "make-import": "node ./node_modules/dynamic-import-js"
  }
}

Usage

Run the following at the root folder:

npm run make-import

This will create a file named local-modules.js at the root path with all the require statements, globally assigned.

Naming Pattern

Given a file, relative to root, named Users/Form.js, it's respective generated line will be global.UsersForm = require('./Users/Form.js').default.

Therefore, it is recommended to wisely name the folders, as they will be used to name the assigned global resources.

If, using the example above, the folder Users is included in the prefixlessFolders, the generated line would be global.Form = require('./Users/Form.js').default. This is particularly usefull for generic folders, such as Components or Screens.