README

ari

Aurelia Scaffolding Command Line Interface

Getting started

Install ari

npm install -g ari

Make sure you have gulp installed as well.

npm install -g gulp

Lets create a new project!

Create a new directory and cd into it.

mkdir my-project && cd my-project

OR paste this is your ~/.bash_profile

function mkd(){
    mkdir "$@" && cd "$@"
}

Then Run

mkd my-project

It's a little easier!

Now for the good stuff!

to start your project run the following

ari init

This will create a JSON file in your directory ari-config.json

Now, to add a project run the following.

ari add project my-project

This will create a directory named my-project in your projects directory.

By default it will generate the aurelia-skeleton-navigation inside your project.

Now lets add a plugin!

NOTE: Projects are different from plugins. We will discuss them later... lets keep moving.

ari add plugin my-plugin

This will create a directory named my-plugin in your plugins directory.

By default ari will generate the aurelia-skeleton-plugin inside your plugin.

Now we can simply link the two together!

ari my-project link plugin my-plugin

Ari has run jspm link in your plugin, and jspm install -l your-plugin. into your project.

Now we can simply develop!

ari my-project watch --plugins my-plugin

The only down side is that this is not as simple as running

gulp watch

However, There is always a way.

ari my-project set --watch my-plugin

ari use my-project

ari watch

What just happened?

First, every time you make project you can use the name as a command. This is not the same for plugins

We then told my-project to watch my-plugin when being watched.

ari my-project set --watch my-plugin

This is all we had to do to watch the plugin.

We can now run

ari my-project watch

However. If we are only working on one project, then we can tell ari to simply use my-project

ari use my-project

This allows use to simply run

ari watch

Now you can open localhost:9000/ and the open you plugin and change stuff, and watch the browser reload, and the plugin change within you project.

Even Better

Ari does much more than simply create directories and watch files.

Ari is a full on generator for scaffolding not only your projects and plugins, but also each individual project and plugin... I have even gone as far as scaffolding out your code in each file. Ari can do a lot!!!

Here are some examples

NOTE: There are short command for each command I show... However, I will by typing the long commands for readability.

Lets make a plugin

ari add plugin parse-yolo

Now lets begin building out this plugin

Using ari use as will allow us to create an alias from you plugins. Otherwise we would have to type ari plugin my-plugin [action] [arguments]

So lets use use as.

ari use plugin my-plugin as pl

NOTE: For now... there are prompts for any flag not passed.

ari pl add customElement

We did not pass any flags so here are the prompts.

> name?: parse-yolo

> appendName?:(Y/n) Y

Any key:value pair in the flags or prompts are separated by a collan

key:value,key:value

@key    [name]
@value  [from]

@params <key:values>

> imports?: Behavior:aurelia-templating,Router:aurelia-router

@key    [boolean]

> view?:(Y/n) N

@key    [Super]

> extends?: Array

@key    <injected>

> inject?: Element

@key    [name:]
@value  [method:attribute:binding]

@params <key:values> 

#if there are values

> metadata?: size,color

@key    <names>

> getters?: name,age

@key    <names>

> setters?: name,age

@key    <names>

> prototypes?: setName,getName,setAge,getAge

Once complete, ari will generate a file like the following.

import {Behavior} from 'aurelia-templating';
import {Router} from 'aurelia-router';

export class ParseYoloCustomElement extends Array{

    static metadata(){
        return Behavior
            .withProperty('size')
            .withProperty('color')
            .noView();
    }

    static inject(){
        return [Element];
    }

    get name(){}
    
    get age(){}

    set name(value){}
    
    set age(value){}

    constructor(element) {}
    
    attached(){}
    
    bind(){}

    sizeChanged(newSize){}
    
    colorChanged(newColor){}

    setName(){}
    
    getName(){}
    
    setAge(){}
    
    getAge(){}
}

add

ari add [plugin | project] [name]

The add command allows you to add a plugin or project repository.

Once a project is added, the project name becomes a command.

use

ari use [name]

The use command creates a shortcut that allows you to not have to prefix your projects with the word project like so.. ari project my-project [action]

After running ari use project my-project, all the project commands are now accessible by just typing ari [action].

delete

alias = ari del

ari del [project | plugin] [name]

Obviously deletes them. No record is kept... so make sure you have pushed or held your changes.

hold

ari hold [project | plugin] [name]

Hold is great! you know how you always want to just grab a clean directory and place you code in it... or completely refresh your project to a new directory... but don't want to loose your current code.

I myself, and I see a lot of people put like two underscores in the dir name.

__some_plugins/
some_plugin/

This gets annoying when there is a lot.

Ari hold duplicates your project or plugin, and places it in the root ./.holding directory.

restore

ari restore [project | plugin] [name]

Restores directories that have been held.

NOTE: it will not overwrite existing code.

If it's restore location already exists.... it will then place an underscore before it.. or more if necessary.

project

The ari project command can be used in one of two ways.

It can be considered as a selector for the projects directory.

[select name to perform action on next-name]

ari project [project-name] <add | use | delete | hold | restore> [name]

[used:name perform action on next-name]

ari [project-name] <add | use | delete | hold | restore> [name]

plugin

The ari plugin command can be used one of two ways

It can be considered as a selector for the plugins directory.

import

ari import [project | plugin] [path] as [name]

Import allows you to import projects or components from your local machine

clone

ari clone [project | plugin] [url] as [name]

Clone allows you to git clone projects or components from a git repository.

config

The ari config is a JSON file that baseic contains information about projects and plugins. However, there is a .ari/ directory that contains configurations for each.

I am keeping this separate form each repository, so that it is not ANOTHER FILE in your code base

ari is simply used locally. If you want to keep your configurations in your repository... simply place it there. Ari will look there for it.

templates

The templates are used to generate code.

I decided to not use Yeoman or slush. Simply because I am personally never satisfied with the generated code.

You are able to use your own templates, by simply placing them in your templates directory.

NOTICE When you look at each template, you will see some weired things happening.

<% _.forEach(prototypes, function(proto){ %>
    <%= proto %>(){}
<% } %>

This is lodash's template syntax. I am using gulp-template to parse the generated code, and inject the proper values with options defined on the command line.

There are some default parameters you can place in your templates.

However, you can place your own, and use the flag --filter to add properties to you templates.

For example

If I made a template, and in my index file I wanted to inject a property called functionName, and I wanted to use it like the following

within ./templates/

myclass/
    myclass.js


    export class <%= className %>{

        constructor(<%= params %>){

        }

    }

Then I can simply run the following

ari plugin my-plugin add class MyClass --template myclass --filter functionName:my-plugin,params:"one,two,three"

It would generate the following


    export class MyClass{

        constructor(one, two, three){

        }

    }

github templates

Git hub templates are the same way, however... It allows you to clone them, instead of keeping the locally.

In order to set this up you can do the following.

ari add template:git http://github.com/<username>/myawesomeclass as myclass

This will place the repository handle in the config. Then you can run

ari plugin my-plugin add class MyClass --template:git myclass --filter functionName:my-plugin, params:"one,two,three"

construction

class

Class allows you to create classes within plugins and projects

--Flags

--import -im `<name:from:>`

List: of modules in import.

--export (Y/n)

Boolean: whether or not to export the class IS NOT A LIST OF THINGS IN EXPORT

--inject -in `<names>`

List: of things to inject

--extends -ext [name]

--setters -set [name]

List: of setters to add to the class

--getters -get [name]

List: of getters to add to the class

--prototypes -pro [name]

List: of prototypes to add to the class

customElement

Same as class, Except it will automatically inject Element.

--metadata -meta `name:method:attr:binding`

List: of metadata behavior properties

If Behavior is not imported, and you use metadata, then ari will imprt it for you

customAttribute

Same as customElement

--Flags

--metadata -meta name:method:attr:binding

List: of metadata behavior properties

If Behavior is not imported, and you use metadata, then ari will imprt it for you

--view (Y/n)

router

Same as class, Except it will automatically inject the Router from aurelia-router.

model

view

file

dir

More coming soon

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Usage no npm install needed!

README

ari

Getting started

Even Better

add

use

delete

hold

restore

project

plugin

import

clone

config

templates

github templates

construction

class

--import -im <name:from:>

--export (Y/n)

--inject -in <names>

--extends -ext [name]

--setters -set [name]

--getters -get [name]

--prototypes -pro [name]

customElement

--metadata -meta name:method:attr:binding

customAttribute

--metadata -meta name:method:attr:binding

--view (Y/n)

router

model

view

file

dir

More coming soon

Contributing

Support

License

--import -im `<name:from:>`

--inject -in `<names>`

--metadata -meta `name:method:attr:binding`