Node.js 项目中集成 CoffeeScript 的三种主流方案

Node.js 应用基于 JavaScript 开发，而 CoffeeScript 是一种可编译为 JavaScript 的语言。由于 CoffeeScript 与 JavaScript 之间存在一对一的映射关系，其使用方式非常灵活。本文将汇总在 Node.js 项目中引入和使用 CoffeeScript 的几种常见方法。

直接运行纯 CoffeeScript 项目

第一种方法是通过 coffee 命令直接运行纯 CoffeeScript 项目。通常人们认为 CoffeeScript 是 JavaScript 的附属，但实际上它可以作为独立语言使用。在 Node 平台全局安装 coffee-script 包后，可以通过 coffee 命令进入交互模式（REPL）。如果项目完全由 CoffeeScript 编写，只需对入口脚本执行 coffee 命令即可。例如，若入口文件名为 app.coffee，则执行相应命令。

coffee app.coffee

注意，这里的扩展名 coffee 是不能省略的。

这种方式可以说是使用 CoffeeScript 最“官方”且直接的方法。一旦以 coffee 文件作为项目入口，整个项目即可同时兼容 CoffeeScript 和 JavaScript。在项目内部，可以任意 require 引入 js 或 coffee 文件及模块，甚至可以在 js 文件中 require coffee 文件。在引用无论是 coffee 还是 js 文件时，无需添加扩展名，只要基础名称不冲突即可。

这种方式存在一个主要局限：如果作为模块，它仅适用于 CoffeeScript 项目；如果作为应用，运行环境必须安装 coffee-script。鉴于 CoffeeScript 目前仍属小众语言，若将其作为模块发布，会丧失对普通 JavaScript 用户的吸引力。

另一个潜在缺点是性能方面。由于 Node.js 内置的是 JavaScript 引擎，CoffeeScript 代码需先编译为 JavaScript 再运行，这会消耗少量时间。尽管 CoffeeScript 到 JavaScript 的编译速度较快，但这部分开销通常集中在应用启动时的 require 阶段。运行时极少需要动态加载新的 CoffeeScript 文件，因此对 Node.js 最常见的 Web 服务器场景影响微乎其微。

在 JavaScript 项目中动态引用 CoffeeScript

第二种方法是在 JavaScript 项目中引用 CoffeeScript。npm 中的 coffee-script 包既可以全局安装，也可以作为项目依赖模块安装。将其作为项目模块的意义在于为项目添加一个 CoffeeScript 编译器，使项目能够在运行时随时编译 CoffeeScript 文件。

如果你希望像第一种方式那样随意引用 CoffeeScript 文件，只需进行注册。假设项目入口文件是 app.js，只需在该文件最前面添加以下代码：

require('coffee-script/register');

注册后，你就可以在项目中随意 require 引入 CoffeeScript 文件了。

这种方式本质上与第一种类似，区别在于 coffee-script 未全局安装，而是作为项目依赖。因此，该模块可以独立存在，作为应用运行时也不需要环境预先安装 coffee-script。

这种方式的缺点可能是导致代码结构混杂，JavaScript 与 CoffeeScript 并存。虽然第一种方式也可能出现这种情况，但纯 CoffeeScript 项目通常不会混入 JavaScript。总体而言，统一项目语言是更好的实践，但在已用 JavaScript 构建大体结构的项目中，若希望部分使用 CoffeeScript，此方法提供了灵活性。

性能问题与第一种方式相同，此处不再赘述。

通过编译或自动化构建工具处理 CoffeeScript

第三种方法是正统的编译方式。编译让人联想到 C 或 Java 等编译型语言。作为编译型语言，编译后再运行是标准做法。CoffeeScript 提供了 coffee -c 命令用于编译。

编译单个 CoffeeScript 文件很简单。例如，要编译 app.coffee 文件，只需在当前目录执行：

coffee -c app.coffee

执行后，当前目录下会出现名为 app.js 的文件。该指令也可应用于目录。若将项目中所有 CoffeeScript 源文件放在 src 目录下，可执行：

coffee -c src

src 目录及其所有子目录下的 CoffeeScript 源文件都会被编译为 JavaScript 文件，并保留在与源文件相同的目录结构中。

对于大型项目，将源文件和编译结果混放并不理想。可以通过指定输出目录来解决：

coffee -c -o outputs src

该命令的参数顺序较为特殊。根据 coffee 的帮助文档，定义如下：

coffee [options] path/to/script.coffee -- [args]

注意，所有选项（options）位于 coffee 命令和文件路径之间。最后的 args 是执行目标文件时传递的参数。因此，所有选项应放在 coffee 和文件名之间。-c 选项没有独立参数，仅表示编译最后提供的文件，因此以下写法也是有效的：

coffee -o outputs -c src

若需添加其他选项，例如让编译结果不被自执行函数体包围，可执行：

coffee -o outputs -c -b src

若希望将所有源文件编译为一个名为 out.js 的目标文件，可执行：

coffee -o outputs -c -j out src

每次修改代码都手动执行编译命令较为繁琐。coffee 命令提供了 -w 选项，用于监视源文件变动并自动编译：

coffee -o outputs -c -w src

对于大型项目，最好提前确定编译方式，使所有开发人员只需一个指令即可完成编译，这需要自动化构建支持。

CoffeeScript 提供了一个自动化构建工具 cake，类似于 C 世界的 make。如官网所述，cake 是一个简单的构建系统。其核心功能是执行名为 cakefile 的脚本，该脚本由 CoffeeScript 编写。cakefile 仅提供有限的内建函数，如 task，用于声明指令及其描述和执行函数。其余部分相当于编写一个纯 Node.js 项目，需使用 fs 模块输出编译后的字符串，或使用 child_process 模块执行 shell 指令。cake 构建的目标不限于 CoffeeScript，由于它实际执行 Node 脚本，可处理任何自动化任务。

此外，还有更优秀的第三方自动化构建工具可完成 CoffeeScript 的自动编译，如著名的 Grunt 以及国内的 fekkit 等。

这种正统的编译方式看似最可靠，深受传统程序员喜爱。它有助于团队形成固定的开发模式。编译后的项目成为纯 JavaScript 项目，无论是直接运行还是作为模块被其他项目引用，均无需额外依赖。且运行时无需编译，完全消除了编译导致的性能问题。

其缺点在于配置繁琐。若项目规模不大，花费时间配置 cakefile 或 Grunt 可能得不偿失。

综上所述，在 Node.js 项目中编写 CoffeeScript 可以非常简单。希望读者能尽快尝试使用 CoffeeScript，并期望以上内容对大家有所帮助。