imx-atomic-cli
v2.0.1
Published
Command Line Operations for imx AtomicDummy
Downloads
2
Keywords
Readme
imx-atomic-cli
Command line interface to assist development of atomicDummy projects
Installing
Install the cli global to gain access to it accros all dummy projects:
$ npm install imx-atomic-cli -g
How to use
Currently there are two operations available:
addComp - this will add a brand new component to your project
use this command pattern:
imx-atomic-cli addComp <target>
the target parameter consists of the type and the name of the new to create component. Type and name are separated using an //
an example could look like this
imx-atomic-cli addComp a//button
this will create a new atom named button
There is the short alias aC available for this operation
imx-atomic-cli aC <target>
copyComp - create a copy of an existing component while renaming it
use this command pattern:
imx-atomic-cli copyComp <source> <target>
Both, the source and the target parameter consist of a type and a name which have to be separated using an // The source parameter will be the existing component you whish to copy. The target parameter will be the new component that will be created.
an example could look like this
imx-atomic-cli copyComp a//button m//newButton
this will create a new molecule named newButton using a copy of the existing atom named button
There is the short alias cC available for this operation
imx-atomic-cli cC <source> <target>
complex structures - since 2.0.0
it is also possible to copy to and from structures, located in your _structures folder for this you can add the structure name to your target. The name of the structure and your component is separated using an / an example could look like this
imx-atomic-cli copyComp a//button m//myStructure/newButton
This way the new component will be created inside the structure "myStructure". This works both ways, also you can create new components via "addComp" inside structures.
Component types
The atomicDummy framework knows 4 TPL Component Types that you want to address:
- Atoms - use a
- Molecules - use m
- Nucleus - use n
- Organisms - use o
Authors
- Axel Güldner@infomax