Eco 项目技术文档

1. 安装指南

1.1 安装 Node.js

Eco 是一个基于 Node.js 的模板引擎，因此首先需要安装 Node.js。你可以从 Node.js 官网 下载并安装适合你操作系统的版本。

1.2 安装 Eco

安装 Node.js 后，可以通过 npm 安装 Eco。打开终端或命令行工具，输入以下命令：

npm install eco

1.3 验证安装

安装完成后，可以通过以下命令验证 Eco 是否安装成功：

npm list eco

如果显示了 Eco 的版本号，说明安装成功。

2. 项目的使用说明

2.1 基本用法

Eco 允许你在标记中嵌入 CoffeeScript 逻辑。你可以使用 eco.render() 方法来渲染模板。以下是一个简单的示例：

eco = require "eco"
fs  = require "fs"

template = fs.readFileSync __dirname + "/views/projects.html.eco", "utf-8"
console.log eco.render template, projects: [
  { name: "Mobile app", url: "/projects/1", description: "Iteration 1" },
  { name: "Home page redesign", url: "/projects/2" }
]

2.2 模板语法

Eco 的模板语法非常简单：

• <% expression %>：计算 CoffeeScript 表达式，但不打印其返回值。
• <%= expression %>：计算 CoffeeScript 表达式，转义其返回值并打印。
• <%- expression %>：计算 CoffeeScript 表达式，不转义其返回值并打印。
• <%= @property %>：打印上下文对象中 property 属性的转义值。
• <%= @helper() %>：调用上下文对象中的 helper 方法，并打印其转义的返回值。

2.3 空白处理

CoffeeScript 对空白敏感，但模板不敏感。因此，Eco 代码标签如果开始一个缩进的 CoffeeScript 块，必须以冒号结尾。要指示缩进块的结束，使用特殊标签 <% end %>。

3. 项目API使用文档

3.1 eco.render() 方法

eco.render() 是 Eco 的核心方法，用于渲染模板。它接受两个参数：

• 第一个参数是模板源代码，通常是一个字符串。
• 第二个参数是上下文对象，包含视图状态和任何你想要调用的辅助方法。

3.2 上下文对象

上下文对象在模板中作为 this 的值。你可以使用 CoffeeScript 的 @ 符号轻松访问上下文对象的属性和调用辅助方法。

3.3 辅助方法

上下文对象中的辅助方法可以访问上下文对象的其他属性，方式与在模板中访问它们相同：通过 this 或 @ 符号。

4. 项目安装方式

4.1 通过 npm 安装

Eco 可以通过 npm 安装，命令如下：

npm install eco

4.2 从 GitHub 克隆源码

你也可以从 GitHub 克隆 Eco 的源码：

git clone http://github.com/sstephenson/eco.git

4.3 运行测试

安装完成后，可以通过以下命令运行测试：

cake test

5. 总结

Eco 是一个强大的模板引擎，允许你在标记中嵌入 CoffeeScript 逻辑。通过本技术文档，你应该能够顺利安装、使用和理解 Eco 的核心功能。