编码风格

以下内容改编自 Electron 的编码风格指南。

你可以运行 yarn lint，查看 eslint 检测出的风格问题。

通用代码

• 文件以换行符结尾。
• 在函数末尾显式返回时，使用不带任何值的 return。
  • 即不使用 return null、return undefined、null 或 undefined
• 运行 yarn format，按标准格式重写所有文件。
• 运行 yarn format:head，重写上次提交中的文件。

文档

• 使用 remark 的 Markdown 风格书写。

TypeScript

• 使用 standard JavaScript 风格。
• 文件名应使用 - 而非 _ 进行连接，例如 file-name.js 而非 file_name.js，因为在 github/atom 中，模块名通常采用 module-name 的形式。这一规则仅适用于 .js 文件。
• 在合适的地方使用较新的 ES6/ES2015 语法
  • const 用于 require 及其他常量。如果值是原始类型，使用大写命名（例如 const NUMBER_OF_RETRIES = 5）。
  • let 用于定义变量。
  • 箭头函数 替代 function () { }
  • 模板字符串 替代使用 + 的字符串拼接。

命名方式

Electron API 采用与 Node.js 相同的大小写规范：

• 当模块本身是一个类，如 BrowserWindow，使用 PascalCase。
• 当模块是一组 API 的集合，如 globalShortcut，使用 camelCase。
• 当 API 是对象的属性，且复杂到足以单独成章，如 win.webContents，使用 mixedCase。
• 对于其他非模块 API，使用自然的标题形式，如 <webview> Tag 或 Process Object。

创建新 API 时，优先使用 getter 和 setter，而非 jQuery 式的单函数风格。例如，.getText() 和 .setText(text) 优于 .text([text])。相关 讨论见此处。