简介
clever-coffeescript-style-guide 是一个用于检测和格式化 CoffeeScript 代码的 npm 包，它根据开发者社区的最佳实践规则进行修改和选择。
它提供了一组经过精心设计的规则（准确来说已经有 56 条规则），使得调试和代码审查更加有效和简单。
安装
在终端运行以下命令来安装 clever-coffeescript-style-guide：
npm install --save-dev clever-coffeescript-style-guide
使用
配置
在项目的 package.json 中添加以下代码实现配置方式：
"lint": {
"clever-coffee": {
"extends": "clever-coffeescript-style-guide",
"globals": [ "myGlobalVariable" ]
}
}extends：基于这个规则集执行代码约束限制。globals：在这里定义全局变量，以便 linter 不会将此类变量标识为未定义。
执行
运行以下命令以开始检查和修复 CoffeeScript 文件：
npx coffeelint -f node_modules/clever-coffeescript-style-guide/chosenRuleSetConfig.coffee myfile.coffee
npx：在不全局安装包的情况下为其创建一个别名。coffeelint：命令行工具。-f：指定使用的 CoffeeLint 配置文件。node_modules/clever-coffeescript-style-guide/chosenRuleSetConfig.coffee：配置文件的位置。myfile.coffee：您要检查和修复的文件的名称。
规则
下面列出了 clever-coffeescript-style-guide 中可用的规则：
- 缩进
- 行长度
- 空白行
- 函数括号空格
- 嵌套空格
- 变量命名
- 对象键和值
- 可读性命名
- 特殊赋值语句
- 注释
- 空格 or 星号
- 字符串引号
- 逗号位置
- 数组访问符
- 错误处理
- 代码块
- Unicode
- if 判断
- 新建行 after
- 逗号前有空格
- 尾随空格
- 一些子句中的尾随逗号
- 带节奏的代码
- 函数调用与参数
- 禁用指定的方法 / 属性
- 自定义代码库
- buildChainReturn
- 返回语句
- 这些关键字后没有空格
- 赋值
- 括号
- 模板字符串
- 循环
- 不允许使用双冒号操作符
- 操作符
- 变量初始化值
- 模块引入
- 全局变量
- 防止滥用 this
- function 标识符和括号之间有空格
- 空块
- 二进制和八进制文字
- switch
- 参数数量约束
- For 循环
- 常量命名
- 函数返回值
- if else if else
- 用 == 而不是 unless
- 一些 else 分支没有 if
- 数组切片
- 隐式返回值
- 定义多个变量
- while 循环
- 访问控制
- 过度使用 else
示例代码
以下是 clever-coffeescript-style-guide 所规定的格式化后的示例代码：
-- -------------------- ---- -------
- -----------
----- ------
------------ ------- ----- --
------- --
----
- -------- ----------------- --- --------- -----
--------- --
--- ----- --------- ---- --------
- --- -----------
--- - --- -- --
------ - - -
- -----------
--- - --- -- -- - - -总结
使用 clever-coffeescript-style-guide 来检查和格式化您的 CoffeeScript 代码是一个非常好的想法，因为它可以帮助您遵循最佳开发实践，并避免一些常见的错误。 请按照本文提供的步骤安装、配置和使用这个 npm 包，以确保您的 CoffeeScript 代码具有高质量、可读性和可维护性。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/79101