使用 Browserify 时引入文本文件（style和template）

/* http://prismjs.com/download.html?themes=prism&languages=markup+css+clike+javascript+bash+css-extras+handlebars+jade+java+less+php+php-extras+python+scss+typescript */
/**
* prism.js default theme for JavaScript, CSS and HTML
* Based on dabblet (http://dabblet.com)
* @author Lea Verou
*/

code[class*="language-"],
pre[class*="language-"] {
color: black;
text-shadow: 0 1px white;
font-family: Consolas, Monaco, ‘Andale Mono‘, monospace;
direction: ltr;
text-align: left;
white-space: pre;
word-spacing: normal;
word-break: normal;
line-height: 1.5;

-moz-tab-size: 4;
-o-tab-size: 4;
tab-size: 4;

-webkit-hyphens: none;
-moz-hyphens: none;
-ms-hyphens: none;
hyphens: none;
}

pre[class*="language-"]::-moz-selection, pre[class*="language-"] ::-moz-selection,
code[class*="language-"]::-moz-selection, code[class*="language-"] ::-moz-selection {
text-shadow: none;
background: #b3d4fc;
}

pre[class*="language-"]::selection, pre[class*="language-"] ::selection,
code[class*="language-"]::selection, code[class*="language-"] ::selection {
text-shadow: none;
background: #b3d4fc;
}

@media print {
code[class*="language-"],
pre[class*="language-"] {
text-shadow: none;
}
}

/* Code blocks */
pre[class*="language-"] {
padding: 1em;
margin: .5em 0;
overflow: auto;
}

:not(pre) > code[class*="language-"],
pre[class*="language-"] {
background: #f5f2f0;
}

/* Inline code */
:not(pre) > code[class*="language-"] {
padding: .1em;
border-radius: .3em;
}

.token.comment,
.token.prolog,
.token.doctype,
.token.cdata {
color: slategray;
}

.token.punctuation {
color: #999;
}

.namespace {
opacity: .7;
}

.token.property,
.token.tag,
.token.boolean,
.token.number,
.token.constant,
.token.symbol,
.token.deleted {
color: #905;
}

.token.selector,
.token.attr-name,
.token.string,
.token.char,
.token.builtin,
.token.inserted {
color: #690;
}

.token.operator,
.token.entity,
.token.url,
.language-css .token.string,
.style .token.string {
color: #a67f59;
background: hsla(0, 0%, 100%, .5);
}

.token.atrule,
.token.attr-value,
.token.keyword {
color: #07a;
}

.token.function {
color: #DD4A68;
}

.token.regex,
.token.important,
.token.variable {
color: #e90;
}

.token.important,
.token.bold {
font-weight: bold;
}
.token.italic {
font-style: italic;
}

.token.entity {
cursor: help;
}

目前来讲模块化已经是Web前端开发的标配了,主流无非是CommonJS规范和AMD规范

有人纳闷了，CMD呢？鸿星尔克之于美津浓，感受下，自家东西不表多

以AMD规范的翘楚 RequireJS 举例，它提供了requirejs-text插件，使得开发者可以异步地引入文本文件，如：

require(["some/module", "text!some/module.html", "text!some/module.css"],
    function(module, html, css) {
        //the html variable will be the text
        //of the some/module.html file
        //the css variable will be the text
        //of the some/module.css file.
    }
);

这时候我们已经在匿名的回调函数中拿到了html和css的实参字符串，html的模板字符串可以通过innerHTML使用，但是css字符串还需要插入进style才能生效，如：

    ···

        document.getElementsByTagName("style")[0].innerHTML = css;

    ···

这时一个模块的三个基本要素（模板、样式、脚本）就加载齐全了。

插一句， SeaJS同样使用插件实现了引入文本文件的功能
`seajs-text`实现了加载模板字符串的功能，
`seajs-css`实现了加载样式表字符串的功能
`seajs-style`能够加载一个css文件，和link标签一样

那么Browserify是如何来实现以上功能的呢？

作为前端CommonJS化的宠儿，目前模块化开发的绝对主流Browserify，配合HTML5的script标签新属性async，可以无阻塞的加载模块

需要注意的是：`async`属性一旦使用，就要考虑好`browserify`打包好的那些模块是否有依赖性，如果有依赖性，建议把这些依赖的模块打包为一个模块，不然async标示过的脚本是不会等待`DomReady`之后再执行的，这样很危险

这里不会介绍Browserify的使用场景以及怎么使用，而是为了解决特定的引入文本文件的功能，这里默认大家已经知晓了它的简单使用，不明请去官网查阅

Browserify使用了transform以及配合transform的相应插件实现了引入模板、样式等等文本文件的功能

而transform又是什么？

Transform source code before parsing it for require() calls with the transform function or module name tr

就是说，在解析require调用之前来转换引入的源代码，通过这一层类似于中间件的功能，使得browserify在拓展性上大有可为

注：在项目中我习惯使用CLI，用watchify配合transform插件，来实现实时转化和编译

怎么引入模板文件

我使用过的三个transform插件可以实现：

• stringify
• html2js-browserify
• browserify-compile-templates （限定了你使用的模板引擎为Underscore Template，把单独模板放到同一html静态文件，中，通过script的ID来分别调用，灵活性欠妥，不推荐）
• blissify （限定了你使用的模板引擎为Biss，不推荐）

stringify和html2js-browserify非常类似，使用API也类似，一起提及

项目使用中：

    npm install -S-dev browserify
    npm install -S-dev watchify
    npm install -S-dev stringify

或者html2js-browserify

    npm install -S-dev browserify
    npm install -S-dev watchify
    npm install -S-dev html2js-browserify

新建html文件，编写需要使用的模板（以Ejs举例）

../templates/header.html

    <header>
        <nav>
            <span class="home">Home</span>
            <span class="user">MyZone</span>
            <% if (isAmin) { %>
                <span>
                    Welcome! <%= name %> administer
                <span>
            <% } %>
        </nav>
    </header>

在我们的CommonJS模块里就可以使用了

../modules/header/header.js

    var $ = require(‘jquery‘);
    var _ = require(‘underscore‘);
    var tpl = require(‘../../templates/header.html‘);

    var data = {
        name: ‘转二‘，
        isAdmin: true
    };

    $(‘.header‘).html(_.template(tpl)(data));

最简单的命令行（使用wacthify附加监视功能）如下：

    browserify -t stringify header.js -o header_bundle.js

或者

    browserify -t html2js-browserify header.js -o header_bundle.js

怎么引入样式文件

• 无预处理器编译的
  • cssify
  • browserify-css

browserify-css

    npm install -S-dev browserify
    npm install -S-dev watchify
    npm install -S-dev browserify-css

app.css:

    @import url("modules/foo/index.css");
    @import url("modules/bar/index.css");
    body {
        background-color: #fff;
    }

app.js:

    var css = require(‘./app.css‘);
    console.log(css);

编译时如果添加参数 --autoInject=true，那么你的HTML文件的head标签将被插入style，否则需要你手动插入

    watchify -t browserify-css [ --autoInject=true ] app.js > bundle.js

cssify

这个插件使用的人最多，可能是因为最简单

    npm install -S-dev browserify
    npm install -S-dev watchify
    npm install -S-dev cssify

style.css:

    body {
      background: pink;
    }

app.js:

var styleNode = require(‘./style.css‘);

console.log(styleNode);

编译时默认将require的样式表插入head标签

    watchify -t cssify app.js > bundle.js

• 包含预处理器编译的
  • node-lessify
  • require-stylify

以require-stylify为例，node-lessify很类似，但是只能编译less

    npm install -S-dev browserify
    npm install -S-dev watchify
    npm install -S-dev require-stylify

app.js

    require(‘./less/main.less‘);
    require(‘./sass/sassFile.scss‘);

编译后被引入的样式表就会出现在head标签中了，

    watchify -t require-stylify app.js > bundle.js

实际上样式被编译后，生成的css文件直接存在于预处理文件的同目录下

即 ./less/main.css ./sass/sassFile.css

感谢阅读

同步自个人博客：http://www.gyroer.com