Skip to content
This repository has been archived by the owner on Sep 21, 2023. It is now read-only.

Latest commit

 

History

History
200 lines (159 loc) · 5.39 KB

documentation.md

File metadata and controls

200 lines (159 loc) · 5.39 KB

Functions

welcome(pkg)

Welcome message

checkVersion()

Check Generator Version and notifier

warning(message)

Warning Message - Yellow

info(message)

Info Message - Green

error(message)

Error Message - Red

moveFiles(base, files)

Move files to target path

moveTemplates(base, files)

Move files to target path

resolveNamedTemplatePath()

Resolve template path

moveNamedTemplate(base, template, name, target)

Move Named template

moveNamedTemplates(base, templates, name, target)

Fill and Move named templates to target path

addPackage(packages, file, node)

Add package to dependency manager (package.json, bower.json)

addScriptsToPackage(scripts)

Add scripts to package.json

addRegistryToPackage(url)

Add publish configuration to package.json publishConfig":{"registry":"http://my-internal-registry.local"}

addScriptsToIndex(scripts)

Add Scripts tag to index.html

addCSSToIndex(lynks)

Add lynk tags to index.html

## welcome(pkg) Welcome message

Kind: global function

Param Type Description
pkg Object - Package information

checkVersion()

Check Generator Version and notifier

Kind: global function

warning(message)

Warning Message - Yellow

Kind: global function

Param Type Description
message string Message

info(message)

Info Message - Green

Kind: global function

Param Type Description
message string Message

error(message)

Error Message - Red

Kind: global function

Param Type Description
message string Message

moveFiles(base, files)

Move files to target path

Kind: global function

Param Type Description
base string Base path
files Array.<string> File list

moveTemplates(base, files)

Move files to target path

Kind: global function

Param Type Description
base string Base path
files Array.<string> File list

resolveNamedTemplatePath()

Resolve template path

Kind: global function

moveNamedTemplate(base, template, name, target)

Move Named template

Kind: global function

Param Type Description
base string Base path
template string Template
name string Name
target string Target

moveNamedTemplates(base, templates, name, target)

Fill and Move named templates to target path

Kind: global function

Param Type Description
base string Base path
templates Array.<string> Template list
name string Name
target string Target

addPackage(packages, file, node)

Add package to dependency manager (package.json, bower.json)

Kind: global function

Param Type Description
packages Array.<Object> Package list
file string File (bower.json or package.json)
node string Node (devDependencies or dependencies)

addScriptsToPackage(scripts)

Add scripts to package.json

Kind: global function

Param Type Description
scripts Array.<Object> Scripts to add

addRegistryToPackage(url)

Add publish configuration to package.json publishConfig":{"registry":"http://my-internal-registry.local"}

Kind: global function

Param Type Description
url string Registry url

addScriptsToIndex(scripts)

Add Scripts tag to index.html

Kind: global function

Param Type Description
scripts Array.<string> Scripts path array

addCSSToIndex(lynks)

Add lynk tags to index.html

Kind: global function

Param Type Description
lynks Array.<string> Scripts path array