Node Asset Packager 技术文档

1. 安装指南

安装步骤

1. 确保你已经安装了 Node.js 和 npm。

2. 在项目根目录下运行以下命令安装 nap：

   npm install nap
   

3. 确保在 package.json 中包含所需的预处理器依赖项，例如 coffee-script、stylus 和 less。

2. 项目的使用说明

基本使用

nap 是一个用于编译、管理和打包样式表、客户端 JavaScript 和 JavaScript 模板的 Node.js 工具。它可以帮助你在开发和生产环境中管理静态资源。

示例

1. 声明资源包

首先，你需要在项目中声明资源包。以下是一个示例：

var app = express();
var nap = require('nap');

app.locals.nap = nap;

nap({
  assets: {
    js: {
      backbone: [
        '/app/coffeescripts/models/**/*',
        '/app/coffeescripts/views/**/*',
        '/app/coffeescripts/routers/**/*'
      ]
    },
    css: {
      all: [
        '/public/stylesheets/blueprint.css',
        '/app/stylesheets/**/*'
      ]
    },
    jst: {
      templates: [
        '/app/templates/index.jade',
        '/app/templates/footer.jade'
      ]
    }
  }
});

2. 在视图中包含资源包

在视图中使用 nap 提供的助手函数来包含资源包。以下是一个使用 Jade 模板的示例：

!!!
html
  head
    title= title
    != nap.css('all')
  body
    != body
    #scripts
      != nap.jst('templates')
      != nap.js('backbone')

3. 生产环境中合并与压缩

在生产环境中，你可以调用 nap.package() 来合并和压缩资源包：

nap({
  mode: 'production',
  assets: {
    js: //...
    css: //...
    jst: //...
  }
});

nap.package();

3. 项目API使用文档

nap(options)

nap 函数用于配置资源包。你可以传递一个包含以下选项的对象：

• assets: 包含所有资源包声明的对象。
• appDir: 默认值为 process.cwd()，用于解析文件的基本目录。
• publicDir: 默认值为 public，静态内容的服务目录。
• mode: 默认值为 production 或 development，取决于 NODE_ENV 环境变量。
• cdnUrl: 如果你使用 CDN，可以传递资源包存储的 URL 根路径。
• gzip: 默认值为 false，是否启用 Gzip 压缩。
• minify: 默认值为 true，是否启用代码压缩。
• uglifyOpts: 传递给 uglify 的选项，用于微调代码压缩。

nap.js(packageName, [gzip])

生成包含指定 JavaScript 资源包的 <script> 标签。

nap.css(packageName, [gzip])

生成包含指定 CSS 资源包的 <link> 标签。

nap.jst(packageName)

生成包含指定 JavaScript 模板资源包的 <script> 标签。

nap.package([callback])

在生产模式下，合并、压缩并输出资源包。可以传递一个回调函数，在资源包打包完成后执行。

4. 项目安装方式

通过 npm 安装

npm install nap

依赖项

确保在 package.json 中包含所需的预处理器依赖项，例如：

"dependencies": {
  "coffee-script": "^1.12.7",
  "stylus": "^0.54.7",
  "less": "^2.7.2"
}

配置文件

在项目中创建一个配置文件，例如 nap.config.js，并按照示例配置资源包。

运行项目

在开发环境中，直接运行项目即可。在生产环境中，调用 nap.package() 来打包资源。

通过以上步骤，你可以轻松地使用 Node Asset Packager 来管理你的静态资源。