概述

前端工程化工具。编译过程采用hook形式，在处理文件的不同阶段调用不同的hook.

用户手册

安装

【芒果TV内部版本】

所有带-g参数的，linux或者mac请加 sudo

# 1. 确保npm 最新版本  npm --version  显示在3.x的可以忽略此步骤
npm update -g npm
# 2. 安装或者更新mgtv
#如果mac安装失败  请 
#sudo rm -rf /usr/local/lib/node_modules/.mgtv_npminstal
#sudo rm -rf /usr/local/bin/mgtv
#sudo rm -rf /usr/local/lib/node_modules/mgtv
npm uninstall -g mgtv
npm install -g mgtv  
# 3. 安装新版silky
mgtv -g install silky-reborn
# 4. 检查是否安装成功, 显示2.x.x版本及以上即安装完成
sr --version

npm 公开版本

# 1. 确保npm 最新版本  npm --version  显示在3.x的可以忽略此步骤
npm update -g npm
# 3. 安装新版silky
npm -g install silky-reborn
# 4. 检查是否安装成功, 显示2.x.x版本及以上即安装完成
sr --version

启动命令及参数说明

init

在一个空的文件夹中，需要建立一个silky项目，那么可以使用该命令进行初始化

启动静态服务器. e.g.

 sr init

或者根据示例项目初始化项目

sr init -p MGUI
#然后安装该项目的依赖
sr install

可选选项参数：

-p --projectName #指定根据某个项目初始化本项目
-l --log #见 通用选项说明
-w --workspace #指定工作目录 可选，默认为当前目录

查看选项帮助说明

sr init --help

start

启动静态服务器. e.g.

sr start -p 3002

可选选项参数：

-p --port #指定运行端口
-c --check #检测运行版本，和插件版本
-e --enviroment #指定运行环境，使插件读取相应环境等配置 optional:【develop, production】
-l --log #见 command-common-params.md
-A --additional #见command-common-params.md
-n --noConfig  #无配置文件运行
-w --workspace #指定工作目录

查看选项帮助说明

sr start --help

你也可以通过修改过对应的配置文件项目目录下 package.json的部分内容来替换每次都需要进行的设置(有些选项无法在package.json进行设置)：

{
  "xxx": "xxx",
  "silky":{
    "port": 14422, //对应 port
    "index": "index.html", //首页
    "autoindex": "true" //是否展示目录
  }
}

https

启用静态https服务器.e.g.

sr https -p 3002

其他参数和命令sr start 一致

build

编译项目. e.g.:

 sr build -o ./build-test -f

可选项参数：

#强制编译项目，当silky 版本，插件版本和 项目的package.json中所依赖的版本不同时，sr build会失败，这时需要使用-f参数
-f --force 
-o --outdir #输出路径 该参数不指定时，默认build到 ./build目录
-i --singleFile #编译单个文件夹
-l --log  #见 command-common-params.md #

-w --workspace #指定工作目录 #默认为当前目录
-s --httpServer #以server形式运行 #本地开发不重要，一般服务器启动

-A --additional #见command-common-params.md #不重要，除非使用了特定插件，插件会进行说名

查看选项帮助说明

sr build --help

你也可以通过修改过对应的配置文件项目目录下 package.json的部分内容来替换每次都需要进行的设置(有些选项无法在package.json进行设置)：

已存在值为默认值。

{
  "xxx": "xxx",
  "silky-build": {
    "outdir": "./build", //默认输出目录 可以不用配置
  �   "ignore": ["node_modules", "(\\/\\.[^/]+)$"] // ==> new RegExp(ArrayItem) 默认忽略以 . 开始的文件名
  }
}

install

安装项目插件 e.g. 安装指定插件:

 sr install sp-proxy sp-merge

或者安装项目所有依赖的silky插件， ⚠️ sr install 仅安装silky-plugin里面配置的插件，package.json里面的devDependencies和dependencies不会安装的，这些配置还是需要用npm或者mgtv安装

sr install

注意⚠️ 非mgtv内网安装插件记得使用 -r taobao 或者 -r npm参数 ,即 sr install -r taobao, sr install xxx -r taobao, 因为默认为mgtv内网仓库

可选选项参数：

-l --log 详细见common-command-common-params.md -p --pluginListName 根据插件列表名称获取插件列表 -w --workspace 指定工作目录 -s, --save, 以正式依赖安装插件，用于开发js css lib 库, 安装的插件会保存到dependencies里面如果设置了-p,那么忽略其他安装选项。如果指定了安装插件的具体名称，那么只安装指定插件，如果既没有指定插件也没有制定插件列表名称，那么默认安装silky-plugin下配置的插件。

remove or uninstall

移除一个插件或多个插件

sr uninstall xxxx
或者
sr remove xxxx xxxx ...

查看选项帮助说明

sr init --help

sync

同步项目配置文件 e.g.

 #下载本项目配置（读取package.json的name和version）
 sr sync
 #下载本项目某个版本配置
 sr sync -v 1.0.0
 #下载某个项目最后一个版本配置
 sr sync -n test
 #下载某个项目的某个配置的某个版本
 sr sync -n test -v 1.0.0

可选选项参数：

-u --url 配置服务器地址 #可选
-w --workspace #可选 指定工作目录
-n, --projectName #可选 项目名字
-v, --version  #可选 项目版本

up

上传项目配置文件 e.g.

 #上传项目配置文件(未指定版本时，读取package.json的version版本)
 sr up
 #上传项目配置文件到某个版本(未指定版本时，读取package.json的version版本)
 sr up -v 1.0.0
 #上传项目配置文件到某个名称下面(未指定版本时，读取package.json的version版本)
 sr up -n test
 #上传项目配置文件到某个名称下面的摸个版本
 sr up -n test -v 1.0.0
 #可选配置项 -a, --all #可选上传所有文件【自动忽略.开始的文件，但是不会忽略.silky文件夹】
 sr up -n test -a

可选选项参数：

-u --url 配置服务器地址
-w --workspace #指定工作目录

list

列出插件版本

sr list

check

检查工具版本和插件版本 e.g.

 sr check

可选选项参数：

-l --log #见 command-common-params.md
-f --fix #修复silky 缺失的配置项，增加必备的文件夹, 安装缺失插件或者重新安装配置指定版本的插件
-w --workspace #指定工作目录

查看选项帮助说明

silky check --help

通用选项说明 start, build 等通用

-l, --log

log日志,打印silky运行时相关日志，如果觉得信息过多可以使用该参数,

( 0[默认]: show all; 1: show error, fail; 2: show error, fail, warn)

-l 0 显示所有类型的log

-l 1 显示 error和fail

-l 2 显示 error ，fail， warn

-A, --additional 不重要

插件开发者灵活使用该参数。用户根据插件文档说明使用该参数

-A key=value[,key2=value2]
#增加的编译参数为
{
  key: value,
  key2: value2
}

额外的环境变量导入.

也可以使用

-A value

#得到的编译参数为 {extra: value}

配置文件

配置文件： package.json

for silky start

...
silky:{
  index: 'index.html', //start server 默认首页  url / === silky.index
  port: '14422' // 默认端口， 和 silky start -p 作用相同， -p 优先于这个配置
}
...

for silky build

...
silky-build:{
  outdir: './build', //配置编译文件输出目录，⚠️ 注意 ⚠️ build之前会先清空该文件夹。
  ignore: ["node_modules", "(\\/\\.[^/]+)$"] //编译跳过这些文件。 适用正则表达式的字符串。 所有平台下（包含windows）,路径分割符在写正则时都使用 '/' 不使用 '\'
  include: []//应该包含哪些文件， 如果符合ignore 也符合 include，最后结果取include
}
...

for silky install

...
silky-plugin:{
  pluginName: pluginSetting(Object) // or false[禁用] 具体配置见插件README.md
}
...

FAQ

我想使用coffee，应该怎么办？

安装sp-coffee ，然后文件后缀使用 .coffee即可
我想使用es6 应该怎么办？

安装sp-es6, 然后文件后缀使用.es6即可
我想给静态资源加上hash或者版本号怎么办？

安装sp-version, 然后使用配置

{
  "version": "{hash}", //读取git最近一次hash。 {date} 日期 注意，开发模式下（即 silky start模式下）固定为时间戳
  "html": {  //可选 boolean 或 object 如：  html: true, 则以下三个选项皆为true，如果为false则下面三个选项全为false   默认true，
    "css": true, //可选 是否给html内的css链接加版本号 默认 true
    "js": true,  //可选 是否给html内的js链接加版本号  默认： true
    "image": true //可选 是否给html内的imgae加版本号 默认： true
  },
  "css": true //可选 是否给css文件中的url加版本号 默认 true,
  "formatURL": 'urlFomat.js' //可选
}

怎么批量引入 js或者css?

安装sp-hbs, sp-hbs-scan-ext.然后用helper {{scan "xx/*.js,xxx/*.css"}}即可
如何引入已存在的知名的lib，比如jquery？

安装sp-hbs 然后运行 sr install jquery , 在hbs中使用 {{publib "jquery"}}即可

常用插件

插件仓库

常用插件说明

sp-hbs hbs处理
sp-less less处理
sp-proxy http代理，避免跨域开发
sp-coffee coffee支持
sp-mini 文件压缩
sp-merge-in-html 文件合并

LICENSE

MIT

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

概述

用户手册

安装

【芒果TV内部版本】

npm 公开版本

启动命令及参数说明

init

可选选项参数：

查看选项帮助说明

start

可选选项参数：

查看选项帮助说明

https

build

可选项参数：

查看选项帮助说明

install

可选选项参数：

remove or uninstall

查看选项帮助说明

sync

可选选项参数：

up

可选选项参数：

list

check

可选选项参数：

查看选项帮助说明

通用选项说明 start, build 等通用

-l, --log

-A, --additional 不重要

配置文件

FAQ

常用插件

LICENSE

Files

README.md

Latest commit

History

README.md

File metadata and controls

概述

用户手册

安装

【芒果TV内部版本】

npm 公开版本

启动命令及参数说明

init

可选选项参数：

查看选项帮助说明

start

可选选项参数：

查看选项帮助说明

https

build

可选项参数：

查看选项帮助说明

install

可选选项参数：

remove or uninstall

查看选项帮助说明

sync

可选选项参数：

up

可选选项参数：

list

check

可选选项参数：

查看选项帮助说明

通用选项说明 start, build 等通用

-l, --log

-A, --additional 不重要

配置文件

FAQ

常用插件

LICENSE