JavaScript Standard Style 代码规范完全指南

JavaScript Standard Style 代码规范完全指南

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

什么是 JavaScript Standard Style？

JavaScript Standard Style 是一个开源的 JavaScript 代码规范工具，它提供了一套开箱即用的代码风格规则，旨在帮助开发者保持代码风格的一致性，同时提高代码质量。这个工具最大的特点是零配置，开发者无需花费时间在配置各种规则上，安装后即可直接使用。

核心特性

1. 零配置

• 无需维护复杂的配置文件
• 安装后立即生效
• 适用于个人项目和团队协作

2. 自动修复

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

3. 早期问题检测

• 在开发阶段就能发现潜在问题
• 减少代码审查时的风格讨论
• 提高代码质量和可维护性

安装与使用

全局安装

npm install standard --global

项目本地安装

npm install standard --save-dev

基本使用

检查当前目录下的所有 JavaScript 文件：

standard

检查特定文件或目录：

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

自动修复

standard --fix

主要代码规范规则

1. 缩进：使用 2 个空格
2. 字符串：优先使用单引号
3. 未使用变量：禁止声明未使用的变量
4. 分号：不使用分号
5. 行首字符：禁止以 (, [, 或 ` 开头
6. 关键字后空格：如 if (condition)
7. 函数名后空格：如 function name (arg)
8. 相等比较：使用 === 而非 ==（null/undefined 检查除外）
9. Node.js 错误处理：必须处理回调函数的 err 参数
10. 浏览器全局变量：使用 window 前缀（document 和 navigator 除外）

集成到项目工作流

1. 在 package.json 中添加配置

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

2. 运行测试时自动检查

npm test

编辑器集成

Visual Studio Code

安装 vscode-standard 插件，支持：

• 实时错误提示
• 保存时自动格式化
• 代码片段支持

Sublime Text

通过 Package Control 安装：

• SublimeLinter
• SublimeLinter-contrib-standard
• StandardFormat（保存时自动格式化）

Atom

安装：

• linter-js-standard（语法检查）
• standard-formatter（自动格式化）
• standardjs-snippets（代码片段）

Vim

配置 Syntastic 插件：

let g:syntastic_javascript_checkers = ['standard']

常见问题解答

1. 为什么选择 Standard Style？

• 减少风格争论，专注于代码逻辑
• 节省配置时间
• 大型项目验证过的规范

2. 如何忽略特定文件？

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

3. 如何禁用特定规则？

使用特殊注释：

/* eslint-disable no-unused-vars */
var unusedVar = 42

4. 支持最新的 JavaScript 语法吗？

是的，支持 ES6+ 语法特性

5. 如何处理第三方库污染全局空间？

在文件顶部添加：

/* global LibraryName */

技术优势

1. 一致性：确保整个项目代码风格统一
2. 可读性：遵循社区最佳实践
3. 可维护性：减少风格相关的代码审查
4. 效率：自动修复节省时间

适用场景

• 个人项目快速启动
• 团队协作开发
• 开源项目维护
• 教学示例代码

JavaScript Standard Style 通过提供一套合理、经过验证的默认规则，帮助开发者避免在代码风格上浪费时间，让开发者可以更专注于业务逻辑和代码质量本身。它的零配置特性和自动修复功能特别适合希望快速建立代码规范的项目和团队。

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