JavaScript Standard Style 代码规范完全指南

JavaScript Standard Style 代码规范完全指南

standard 项目地址: https://gitcode.com/gh_mirrors/sta/standard

什么是 JavaScript Standard Style

JavaScript Standard Style 是一个开源的 JavaScript 代码规范工具，它提供了一套开箱即用的代码风格规则，旨在帮助开发者快速建立统一的代码风格标准，减少团队协作中的风格争议。

核心特性

零配置

• 无需繁琐的配置文件（如 .eslintrc、.jshintrc 等）
• 安装即用，立即为项目提供一致的代码风格检查

自动修复

• 通过 standard --fix 命令可自动修复大多数风格问题
• 节省手动调整代码格式的时间

错误检测

• 不仅能发现风格问题，还能捕捉常见的编程错误
• 如未使用的变量、可能的全局污染等

安装与使用

全局安装

npm install standard --global

项目本地安装

npm install standard --save-dev

基本使用

检查项目中的所有 JavaScript 文件：

standard

检查特定目录或文件：

standard "src/**/*.js" "test/**/*.js"

集成到项目

在 package.json 中添加：

{
  "scripts": {
    "test": "standard && node my-tests.js"
  }
}

主要规则

1. 缩进：使用 2 个空格
2. 字符串：优先使用单引号
3. 变量：禁止未使用的变量
4. 分号：不使用分号（有自动检测机制确保安全）
5. 括号：行首禁止出现 (, [, 或 `
6. 关键字：关键字后需有空格，如 if (condition)
7. 函数：函数名后需有空格，如 function name (arg)
8. 比较运算符：使用 === 而非 ==（obj == null 例外）
9. 错误处理：必须处理 Node.js 回调中的 err 参数
10. 全局变量：浏览器全局变量需加 window. 前缀（document 和 navigator 除外）

编辑器集成

VS Code

安装 vscode-standard 插件，支持自动格式化

Atom

安装 linter-js-standard 插件

Sublime Text

安装 SublimeLinter 和 SublimeLinter-contrib-standard

常见问题解答

为什么选择 Standard？

• 减少风格争议，专注于代码质量
• 节省配置时间
• 自动修复功能提高开发效率

如何忽略特定文件？

创建 .standardignore 文件（类似 .gitignore）

如何禁用特定规则？

虽然不推荐，但可通过注释临时禁用：

// eslint-disable-next-line no-new
new Thing()

支持实验性 JavaScript 特性吗？

是的，可通过配置支持 ES Next 特性

支持 Flow 或 TypeScript 吗？

需要额外配置，但可以集成使用

技术原理

JavaScript Standard Style 基于 ESLint 实现，通过 standard-engine 提供统一的配置预设。其规则选择经过社区验证，平衡了可读性、安全性和开发效率。

适用场景

• 团队协作项目
• 开源项目
• 快速启动的新项目
• 需要统一代码风格的大型项目

总结

JavaScript Standard Style 通过提供一套精心设计的默认规则，解决了 JavaScript 代码风格统一的问题。它的零配置特性和自动修复功能使其成为提高代码质量和团队协作效率的理想选择。无论是个人项目还是企业级应用，都能从中受益。

standard 项目地址: https://gitcode.com/gh_mirrors/sta/standard