模块化你的前端代码，像node.js一样编写模块, 发布npm变成共享模块。
Cube管理着前端三种类型的资源:
- script js/coffee/jsx/...
- style css/stylus/less/...
- template html/ejs/jade/...
npm install -g node-cube
推荐全局安装，有cli命令支持
初始化cube，通过cube命令，生成工程结构，包含一个示例代码
> cd your_project_dir
> cube init查看index.html, cube 客户端的部署大致如下
<!-- 引入的cube文件，在window里注入全局的Cube对象, 其API参考下文 -->
<script src='/cube.js'></script>
<script>
Cube.init({
/**
* script charset
*/
charset: 'utf-8',
/**
* http virtual path, base should be a http path
* like: http://domain.com/project/static
*/
base: '/',
/**
* debug flag, online module ,you should turn off this switch
*/
debug: true,
/**
* file version in querystring, used for flushing client side
* @type {Number}
*/
version: 12345,
/**
* setup loading script timeout setup
*/
timeout: 15000,
/**
* 远程模块，支持多个站点共享模块
* 高级用法，请参考文档
*/
remoteBase: {
a: 'http://abc.js/modules/'
}
});
Cube.use('/main.js', function (App) {
console.log(App.run(appConfig));
});
</script>
Cube.use 还可以支持多模块加载:
Cube.use(['/a.js', '/b.js'], function (a, b) {
// a -> a.js
// b -> b.js
});
Cube.use 传入的参数寻址，基于当前 init的时候指定的base， 即跟目录下。
Cube.use('/app.js', cb);
Cube.use('./app.js', cb);
Cube.use('app.js', cb);
以上是等效的，都引用了主类目下的 app.js 模块
/**
* 开启debug模式, 会打印模块加载调试信息
* @static
*/
Cube.debug();
/**
* 初始化
* @static
* @param options {Object}
* charset {String} script标签
* base {String} 服务器端模块的http前缀地址
* debug {Boolean}
* version {Number}
* timeout {Number}
* resBase {Object} 远程base
*/
Cube.init(options);
/**
* 异步加载模块，带回调，页面的主入口一般就这个写法
* @static
* 注意module传入的寻址规则， 以下规则等效，都是基于 base 根目录下
* /app.js
* ./app.js
* app.js
*/
Cube.use(module, cb);
Cube.use([mod1, mod2], function(mod1, mod2) {
// TODO: your code here
});
/**
* 注册页面已通过script标签加载过的模块，避免重复加载
* @static
* 如下，注册 jquery， lodash
* 注意后端assets目录下，请不要安装这些模块
*/
Cube.register('jquery', $);
Cube.register('lodash', _);
服务器端cube提供两种模式： 1. middleware模式, 2. 独立初始化 3. 命令行工具
- middlware 模式
const Cube = require('node-cube');
let cube = Cube.middleware({
/**
* 静态资源的绝对路径
* @type {String}
*/
root: ''
/**
* 端口
* @type {Number}
*/
port: 8080,
/**
* 是否middleware模式
* @type {Boolean}
*/
middleware: true,
/**
* 所有资源文件（如css中图片）的http前缀路径,
* 一般是一个站点的绝对路径`/`，或者`http://`完整路径
* @type {String}
*/
base: '/',
/**
* 编辑模式下，缓存目录，默认在 $root/.cubecache
*/
cacheDir： '',
/**
* 浏览器端文件缓存时间，最终会应用到http头：Cache-Control: public, maxAge=xxx
* @type {Number}
*/
maxAge: 600
/**
* 配置文件的处理器 processors
* 这个配置更推荐在 package.json的 cube 属性中配置，这样build和debug的时候同时生效
* @type {Object}
*/
processors: {
'.jsx': [
['cube-react', {}], // processor with config
'minify'
], // multi-processor
'.jsw': 'jsw' // single processor
},
/**
* 开发模式下是否开启缓存， 默认开启
* @type {Boolean}
*/
devCache: true,
optimize: true // optimize file load, default is true
});
- 独立初始化
const Cube = require('node-cube');
let cube = new Cube(options);
- cli模式
# 本地开发的时候启动服务，指定静态文件目录，即可服务起来
> cube start your_project_dir
# 初始化工程, 初始化一个简单的case
> cube init dir
# 打包发布工程
> cube build dir好了，cube可以工作了， 编辑主入口文件 main.js，开始编码。
前面已经启动了服务，
// main.js
var cookie = require('cookie');
var tpl = require('./tset.html');
function init() {
// init layout
$('body .main').html(tpl());
// get nick
var nick = cookie.get('nick');
if (!nick) {
nick = 'guest';
}
$('.node-nick').text(nick);
}
init();
// 异步加载css
load('../css/module.css', nameSpace); // namespace: prefix for css selectorok，一个很简单的一个模块，index.html加载了main.js，便开始执行：设置头部用户登录昵称
Cube的模块加载是支持像node一样寻址node_modules目录的，在wwwroot目录下安装模块，可以被直接require使用， 所以可以把稳定的代码模块，发布到npm公用吧！
引用现有的包， 你只需要
- 编写好package依赖
npm install注意这里的npm install是安装在静态资源目录，不是工程根目录。- 像node一样引用这些模块
注意node_modules，虽然和node.js的模块一模一样使用，但是它们安装在不同的地方。 前端工程里使用到的模块，需要安装在静态资源目录下，例如：
/project
/assets
/node_modules # client side node_modules
/common
/css
- package.json # 前端所依赖的模块声明
/lib
/controller
/node_modules # server side node_modules
- package.json # 后端所依赖的模块申明完成开发之后，模块都会被预编译、压缩成一个个小文件，合并，然后发布到线上(cdn服务器、云存储 或 其他)
cube提供build命名来方便的完成这一任务
# build static folder
cube build $resource_path -o $resource_path.release --smart --mangle-file-namecube build的参数:
-h, --help output usage information
-o, --output [value] set the output dir
--output-file [value] set the output file
-b, --base [value] setup project base dir, the root
-r, --resbase [value] the http base for resouce
--remote [value] set the namespace for remote call
--export [value] files will be exported, do not merge, example: /a.js,/b.js
--mangle-file-name mangle the file name into random name
--without-compress do not compress code
--without-wrap do not wraper code
--smart smart build, only build necessary files
在静态资源目录下，编写 .cubeignore来排除不需要被处理的文件，格式和.gitignore类似：
[skip]
/node_modules/jquery/jquery.min.js
[ignore]
/node_modules/.bin
- 匹配
skip段的文件，将跳过编译，直接copy到目标目录 - 匹配
ignore段的文件，将直接忽略，build之后不会出现在目标目录中
不添加标记的时候，默认都为skip, 例如：
/test/
cube 在build的时候将直接copy文件，而不会build代码
.cubeignore 文件的寻址 会从build目录开始逐级往上寻找，直到找到为止
静态资源目录下的package.json， 增加cube熟悉可以为cube的运行配置参数。
在开发模式和cube build时都会来读取这份配置，所以在这里配置cube是最好的选择
{
"cube": {
"moduleMap": {
/**
* 有些编译好的模块，可以通过映射来加速
*/
"react": "dist/react.js",
"modulemap": "lib/index.js"
},
"processors": {
/**
* 单个process的情况，
*/
".less": "cube-less",
/**
* 支持本地自定义processor, 其路径可以是相对路径（相对package.json的路径）
* 也可以是绝对路径
*/
".tpl": "../custom_processor",
/**
* 支持串行，多个处理器
*/
".jsx": ["cube-react", "babel-2017"],
/**
* 支持给处理器传递参数
*/
".coffee": [
["cube-coffee", {/* processor_config */}]
],
".ejs": "cube-ejs",
".jade": "cube-jade",
".styl": "cube-stylus"
},
"ignoreRules": {
"skip":[
"/test/*.test.js"
"node_modules/"
],
"ignore": []
},
"export": []
}
}
其中：
moduleMap为一些已经build成single-file的模块提供filemap，以加速加载processors对象定义各种文件的处理器ignoreRules中定义build时的忽略规则，和.cubeignore功能类似export定义需要被导出的文件，补充自动识别导出文件的不足
构造函数传入 > package.json > cube内置配置
-
processors 优先级
构造函数传入 > package.json中配置 > cube默认配置
-
ignoreRule 优先级
ignoreRule的配置同等优先级，merge之后都会生效
构造函数 = .cubeignore = package.json
一个典型的插件代码
var path = require('path');
function Processor(cube) {
/*
cube: {
config,
fixupResPath
wrapTemplate,
processJsCode
}
*/
this.cube = cube;
}
Processor.type = 'style';
Processor.ext = ['.sass'];
Processor.prototype.process = function (relpath, options, callback) {
// get the source file abs path, so you can read the source
var fpath = path.join(options.root, relpath);
// do your processing
return {
}
};