connect-assets 项目技术文档

1. 安装指南

1.1 安装依赖

首先，确保你已经安装了Node.js和npm。然后，在你的项目目录中运行以下命令来安装connect-assets及其所需的编译器：

npm install connect-assets
npm install coffee-script stylus less node-sass jade ejs

1.2 配置项目

在你的项目配置文件中（通常是app.js或server.js），添加以下代码以启用connect-assets：

const connectAssets = require('connect-assets');

app.use(connectAssets());

1.3 创建资产目录

在项目根目录下创建一个assets目录，并在其中创建js和css子目录，用于存放JavaScript和CSS文件。

2. 项目的使用说明

2.1 标记函数

connect-assets提供了五个全局函数：js、jsInline、css、cssInline和assetPath，用于在视图中引入资产文件。

2.1.1 引入JavaScript和CSS文件

在Jade模板中，可以使用以下代码引入JavaScript和CSS文件：

!= css("normalize")
!= js("jquery")

这将生成如下HTML代码：

<link rel="stylesheet" href="/css/normalize-[hash].css" />
<script src="/js/jquery-[hash].js"></script>

2.1.2 内联引入JavaScript和CSS文件

使用jsInline和cssInline函数可以将文件内容直接嵌入到HTML标签中：

!= cssInline("normalize")
!= jsInline("jquery")

这将生成如下HTML代码：

<style>[contents]</style>
<script>[contents]</script>

2.1.3 引入图片

通过assetPath函数可以引用图片路径。首先，需要在配置中指定图片路径：

const assets = require('connect-assets');

app.use(assets({
  paths: [
    'assets/css',
    'assets/js',
    'assets/img'
  ]
}));

然后在Jade模板中使用assetPath函数：

img(src="#{assetPath('image-name.png')}")

这将生成如下HTML代码：

<img src="/assets/img/image-name-[hash].png">

2.2 Sprockets-style 拼接

你可以在.js.coffee和.js文件中使用Sprockets-style语法来指示依赖关系：

#= require dependency

或

//= require dependency

这样，当你使用js函数引入这些文件时，connect-assets会自动处理依赖关系。

3. 项目API使用文档

3.1 配置选项

connect-assets提供了多个配置选项，可以通过传递参数来定制其行为：

选项	默认值	描述
paths	["assets/js", "assets/css"]	资产文件的读取路径，按优先级排序。
helperContext	global	辅助函数（如css、js）的挂载对象。
servePath	"assets"	资产的虚拟路径，用于HTTP服务。
precompile	["."]	服务器初始化时预编译的资产列表。
build	dev: false; prod: true	是否将资产保存到磁盘。
buildDir	"builtAssets"	编译资产的保存目录。
compile	true	如果资产不存在于buildDir中，是否编译。
bundle	dev: false; prod: true	是否将资产打包到一个标签中。
compress	dev: false; prod: true	是否压缩资产。
gzip	false	是否生成gzipped文件。
fingerprinting	dev: false; prod: true	是否在资产文件名中添加指纹。
sourceMaps	dev: true; prod: false	是否提供源映射。

3.2 自定义Mincer配置

connect-assets依赖于mincer，你可以通过传递自定义初始化函数来配置mincer：

app.use(require('connect-assets')(options, function (instance) {
  // 自定义mincer环境配置
  instance.environment.registerHelper(/* ... */);
}));

4. 项目安装方式

4.1 通过npm安装

使用以下命令安装connect-assets：

npm install connect-assets

4.2 安装编译器

根据需要安装相应的编译器：

npm install coffee-script stylus less node-sass jade ejs

4.3 配置项目

在项目配置文件中添加以下代码：

const connectAssets = require('connect-assets');

app.use(connectAssets());

4.4 创建资产目录

在项目根目录下创建assets目录，并在其中创建js和css子目录。

通过以上步骤，你就可以成功安装并使用connect-assets来管理你的项目资产文件。