Kaffeine 项目技术文档

1. 安装指南

环境要求

• Node.js 版本 >= 0.3.1

安装步骤

1. 打开终端或命令行工具。
2. 运行以下命令安装 Kaffeine：

   npm install kaffeine
   

2. 项目的使用说明

编译脚本

从命令行编译 Kaffeine 脚本：

kaffeine -c /path/to/script.k

直接运行 Kaffeine 文件

使用 knode 命令直接运行 Kaffeine 文件：

knode /path/to/script.k

在脚本中引入 Kaffeine 文件

在其他脚本中引入 Kaffeine 文件（例如 my_script.k）：

require('kaffeine')
require('my_script')

3. 项目API使用文档

主要功能

• Progressively enhance Javascript syntax: 确保原生 JavaScript 仍然正常工作。
• 避免不必要的功能: 专注于小而实用的功能集和实用主义。
• 可扩展性: 模块化、可扩展和可测试。
• 不依赖空格: 虽然看起来不错，但空格在实际开发中可能会带来不便。

示例代码

Edge::add = (nick, name, complete) {
  @client.select 15
  user = User.find! {id: nick}
  puzzle = Puzzle.find! {name: name}
  err, data = client.set! "u:#{user}:p:#{puzzle}"
  complete()
}

4. 项目安装方式

通过 npm 安装

npm install kaffeine

依赖项

• 依赖于 brequire，可以通过以下命令安装：

  npm install brequire
  

构建浏览器测试

运行以下命令构建浏览器测试：

bin/build

运行测试

• 通过 Node.js:
  • 运行所有测试：

    bin/expect
    

  • 运行特定测试：

    bin/expect file_name
    

• 通过浏览器:
  • 加载 browser/runner.html 文件。

集成测试

• 运行 Node.js 集成测试：

  node test/test_node.js
  

• 运行 Kaffeine 集成测试：

  knode test/test_knode.js
  

5. 待办事项

• 需要 --- 操作符来分隔 bangs!
• 嵌套 for 循环 - 是否存在问题？