use-automapper
v0.0.4
Published
Automatically creates config files for `use-import`
Downloads
4
Maintainers
Readme
use-automapper
Automatically maps projects for
use-import
This command-line utility automatically creates a use.json
config file from an existing JavaScript project for the use-import
module.
Installation
npm install -g use-automapper
Usage
To create a map from an existing project, navigate to that project's root directory and enter this into the command line:
use-automapper run
A use.json
file will be automatically created for your project and saved to the root directory.
Name Comments
You can control the reference names given to your files within the map. Just put a comment like this inside each of the files you want to name:
/* use-automapper: YourDesiredNameHere */
Options and Flags
--path
Short form: -p
Specifies path to the project's root directory. Defaults to the current working directory.
Example
use-automapper run --path /Users/someone/projects/project
use-automapper run -p /Users/someone/projects/project
--output
Short form: -o
Sets path and filename of the config JSON file. Defaults to use.json
within the project's root directory.
Example
use-automapper run --output /Users/someone/projects/project/useMap.json
use-automapper run -o /Users/someone/projects/project/useMap.json
--use-path-style-names
Short form: -s
Flag. Adds the formatted relative path to each file's name (so that, for instance, the file ./src/libs/data/MyClass.js
will be named "src/libs/data/MyClass" within the map). Useful to those who prefer to know the exact path to each file without checking use.json
.
Example
use-automapper run --use-path-style-names
use-automapper run -s
--use-java-style-names
Short form: -j
Flag. Adds a Java-style package path to the beginning of each file's name (so that, for instance, the file ./src/libs/data/MyClass.js
will be named "src.libs.data.MyClass" within the map). Potentially useful for those worried about namespacing.
Example
use-automapper run --use-java-style-names
use-automapper run -j
--disable-file-parsing
Short form:* -d
Flag. Tells the utility not to check files for name comments. May speed up the process for those not using this feature.
Example
use-automapper run --disable-file-parsing
use-automapper run -d
--include-node-modules
Short form:* -m
Flag. Tells the utility to include the JavaScript files found within node_modules
folders (which are otherwise ignored by default).
Example
use-automapper run --include-node-modules
use-automapper run -m
--verbose
Short form:* -v
Flag. Logs debug output to console.
Example
use-automapper run --verbose
use-automapper run -v
Related Modules
See also: grunt-use-automapper.
Changelist
- v0.0.4
- Now ignores files within
node_modules
by default. This can be overridden using the--include-node-modules
flag.
- Now ignores files within
- v0.0.3
- Client bug fix
- v0.0.2
- Add
verbose
option / logging functionality - Add unit tests for
AutomapperAsync.mapFiles
- Add
Credits and Licensing
Created by Jon Stout. Licensed under the MIT license.