组件化脚手架

组件化脚手架程序

INSTALL

npm install compscaf

OPTION

-o, --comp [name]:  init a compoment : required
-t, --tpl  [name]:  init a tpl   file, default [name] is main 
-s, --scss [name]:  init a scss  file, default [name] is base 
-j, --js   [name]:  init a entry file, default [name] is index
-a, --all        :  init all file[tpl/scss/js]
-f, --force      :  init a compoment, remove the old one if extis
-c, --clear      :  clear a component, remove all file in the component dir

USAGE

    ./node_modules/.bin/compscaf -r './' -o test 
    ./node_modules/.bin/compscaf -r './' -o test -c 
    ./node_modules/.bin/compscaf -r './' -o test -fjts 
    ./node_modules/.bin/compscaf -r './' -o test -s common -j entry

Common Config

自定义配置文件：${process.cwd}/compscaf.yml

cwd

String

组件目录，相对于process.cwd()

contentTpl

Object{:type-> String}

类型文件对应的初始化内容，目前支持变量

comp：组件名
deps：组件依赖
depsVar：组件变量名
EOL： 换行符

baseDeps

Array[String]

基础依赖，入口文件的通用依赖模块

varRegx

Object{:type-> Array[RegExp, replacement]}

变量匹配正则

extension

Object{:type-> String}

文件扩展名

defaultName

Object{:type-> String}

默认文件名（不含文件后缀）

Default Config

cwd: './'

contentTpl:
    tpl: '<div class="o-{{comp}}">{{EOL}}</div>'
    scss: '.o-{{comp}} {{{EOL}}}'
    js: "define('comp/{{comp}}/index', [{{deps}}], function ({{depsVars}}) {{{EOL}}})"

baseDeps: []

varRegx :
    baseDep: [ ".+\/([^\/]+)'quot; , '$$1']
    tpl: [ "([^\.]+).+quot; , "$$1Tpl"]

extension:
    tpl: 'html'

defaultName:
    js: 'index'
    scss: 'base'
    tpl: 'main'

TEST

./node_modules/.bin/compscaf -o test -af

生成指定名称test组件的目录，以及scss，entry js，tpl资源文件，并预先填充内容;

默认配置下，组件目录下生成

├── base.scss
├── index.js
└── main.html

base.scss

.o-test {
}

index.js

define('comp/test/index', ['./main.html', './base.scss'], function ($mainTpl) {
})

main.html

<div class="o-test">
</div>