write-index
write-index
creates and writes index.js files in specified directories that imports and exports sibling files in ES6 format.
Examples
Directory with sibling files
utils-/ - bar.js - foo.js
idx-compose
(with no arguments)
Run command Finds or creates index.js, then outputs the file exports as such
utils-/ - bar.js - foo.js - index.js /* utils/index.js contents */export
When you need to import from another directory
In this example we want to import all files from our utils into the root index.js
-/ - index.js - utils-/ - bar.js - foo.js
idx-compose fromDir toDir
Run command In this case
idx-compose ./utils/ ./
Updates this index.js file with
/* ./index.js contents */export
Usage
Installation
npm install write-index
Cli options
Usage: idx-compose [options] [importFrom] [pathToIndex] Example: idx-compose -e whatever.js ./utils ./ Creates index.js from sibling files or directory specified Options: -v, --version output the current version -c, --config use config file arguments - ignores cli arguments in favor of an .idxrc file -e, --entryFile <name> specify entry file name - default: "index.js" -h, --help output usage information
Changing the entryFile
By default we create or update index.js, but you can override this behavior with the -e or --entryFile options
using the commandidx-compose -e <name>.js
Config file
This allows you to specifiy multiple directories to update using
idx-compose -c
oridx-compose --config
.idxrc
file in the root of your project
Create an Note: This ignores any other arguments coming from the cli
Arguments
- dirs: An array of specified directories to update on command
- pathToIndex - where to create and/or update the index.js files
- importFrom - the directory location we want to import files from
- entryFile: name to call the entryFile if you want to override index.js
Example .idxrc file