Deno 风格指南

⚠️ 请注意，这是 Deno 运行时和 Deno 标准库中 **内部运行时代码** 的风格指南。这不是 Deno 用户的通用风格指南。

版权声明跳转到标题

// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.

在文件名中使用下划线，而不是连字符。跳转到标题

示例：使用 file_server.ts 而不是 file-server.ts。

为新功能添加测试。跳转到标题

每个模块都应该包含或附带对其公共功能的测试。

TODO 注释跳转到标题

TODO 注释通常应该包含一个问题或作者的 github 用户名（在括号中）。示例

// TODO(ry): Add tests.
// TODO(#123): Support Windows.
// FIXME(#349): Sometimes panics.

不鼓励使用元编程。包括使用 Proxy。跳转到标题

即使这意味着更多代码，也要明确。

在某些情况下，使用这些技术可能是有意义的，但在绝大多数情况下，它没有意义。

包容性代码跳转到标题

请遵循 https://chromium.googlesource.com/chromium/src/+/HEAD/styleguide/inclusive_code.md 中概述的包容性代码指南。

Rust 跳转到标题

遵循 Rust 约定，并与现有代码保持一致。

TypeScript 跳转到标题

代码库的 TypeScript 部分是标准库 std。

使用 TypeScript 而不是 JavaScript。跳转到标题

不要使用文件名 `index.ts`/`index.js`。跳转到标题

Deno 不会以特殊方式处理 "index.js" 或 "index.ts"。通过使用这些文件名，它表明它们可以从模块说明符中省略，而实际上它们不能。这很令人困惑。

如果代码目录需要默认入口点，请使用文件名mod.ts。文件名mod.ts遵循Rust的约定，比index.ts更短，并且没有关于其工作方式的任何先入为主的观念。

导出函数：最多 2 个参数，将其余参数放入选项对象中。跳转到标题

设计函数接口时，请遵循以下规则。

属于公共 API 的函数最多接受 2 个必填参数，以及（如果需要）一个选项对象（总共最多 3 个）。
可选参数通常应放在选项对象中。

不在选项对象中的可选参数可能可以接受，如果只有一个，并且似乎无法想象我们将来会添加更多可选参数。
“options”参数是唯一一个作为常规“Object”的参数。

其他参数可以是对象，但它们必须与“普通”Object 运行时区分开来，方法是具有以下任一特征：
- 一个区分原型（例如Array、Map、Date、class MyThing）。
- 一个众所周知的符号属性（例如，具有Symbol.iterator的可迭代对象）。
这允许 API 以向后兼容的方式发展，即使选项对象的位置发生变化。

// BAD: optional parameters not part of options object. (#2)
export function resolve(
  hostname: string,
  family?: "ipv4" | "ipv6",
  timeout?: number,
): IPAddress[] {}

// GOOD.
export interface ResolveOptions {
  family?: "ipv4" | "ipv6";
  timeout?: number;
}
export function resolve(
  hostname: string,
  options: ResolveOptions = {},
): IPAddress[] {}

export interface Environment {
  [key: string]: string;
}

// BAD: `env` could be a regular Object and is therefore indistinguishable
// from an options object. (#3)
export function runShellWithEnv(cmdline: string, env: Environment): string {}

// GOOD.
export interface RunShellOptions {
  env: Environment;
}
export function runShellWithEnv(
  cmdline: string,
  options: RunShellOptions,
): string {}

// BAD: more than 3 arguments (#1), multiple optional parameters (#2).
export function renameSync(
  oldname: string,
  newname: string,
  replaceExisting?: boolean,
  followLinks?: boolean,
) {}

// GOOD.
interface RenameOptions {
  replaceExisting?: boolean;
  followLinks?: boolean;
}
export function renameSync(
  oldname: string,
  newname: string,
  options: RenameOptions = {},
) {}

// BAD: too many arguments. (#1)
export function pwrite(
  fd: number,
  buffer: ArrayBuffer,
  offset: number,
  length: number,
  position: number,
) {}

// BETTER.
export interface PWrite {
  fd: number;
  buffer: ArrayBuffer;
  offset: number;
  length: number;
  position: number;
}
export function pwrite(options: PWrite) {}

注意：当其中一个参数是函数时，您可以灵活地调整顺序。请参阅示例，例如 Deno.serve、Deno.test、Deno.addSignalListener。另请参阅此帖子。

导出用作导出成员参数的所有接口跳转到标题

无论何时使用包含在导出成员的参数或返回类型中的接口，都应导出所使用的接口。以下是一个示例

// my_file.ts
export interface Person {
  name: string;
  age: number;
}

export function createPerson(name: string, age: number): Person {
  return { name, age };
}

// mod.ts
export { createPerson } from "./my_file.ts";
export type { Person } from "./my_file.ts";

最小化依赖项；不要进行循环导入。跳转到标题

虽然std没有外部依赖项，但我们仍然必须注意保持内部依赖项简单易管理。特别是，注意不要引入循环导入。

如果文件名以下划线开头：`_foo.ts`，请不要链接到它。跳转到标题

可能存在内部模块是必需的，但其 API 不打算稳定或链接到的情况。在这种情况下，请在前面加上下划线。按照惯例，只有其自身目录中的文件应该导入它。

对导出符号使用 JSDoc。跳转到标题

我们力求提供完整的文档。理想情况下，每个导出符号都应该有一行文档。

如果可能，请对 JSDoc 使用单行。示例

/** foo does bar. */
export function foo() {
  // ...
}

重要的是文档易于人类阅读，但也需要提供额外的样式信息，以确保生成的文档更像富文本。因此，JSDoc 通常应遵循 Markdown 标记来丰富文本。

虽然 Markdown 支持 HTML 标签，但在 JSDoc 块中禁止使用 HTML 标签。

代码字符串文字应使用反引号（`）而不是引号括起来。例如

/** Import something from the `deno` module. */

不要记录函数参数，除非它们对其意图不明显（尽管如果它们对其意图不明显，则应考虑 API 本身）。因此，@param 通常不应使用。如果使用@param，则不应包含type，因为 TypeScript 已经是强类型的。

/**
 * Function with non-obvious param.
 * @param foo Description of non-obvious parameter.
 */

应尽可能减少垂直间距。因此，单行注释应写成

/** This is a good single-line JSDoc. */

而不是

/**
 * This is a bad single-line JSDoc.
 */

代码示例应使用 Markdown 格式，如下所示

/** A straightforward comment and an example:
 * ```ts
 * import { foo } from "deno";
 * foo("bar");
 * ```
 */

代码示例不应包含额外的注释，并且不应缩进。它已经在注释中。如果需要进一步注释，则它不是一个好的示例。

使用指令解决代码风格问题跳转到标题

目前，构建过程使用 dlint 来验证代码中的代码风格问题。如果任务需要不符合代码风格的代码，请使用 deno-lint-ignore <code> 指令来抑制警告。

// deno-lint-ignore no-explicit-any
let x: any;

这确保了持续集成过程不会因为代码风格问题而失败，但应该谨慎使用。

每个模块都应该有一个测试模块。跳转到标题

每个具有公共功能的模块 foo.ts 都应该有一个测试模块 foo_test.ts。std 模块的测试应该放在 std/tests 中，因为它们有不同的上下文；否则，它应该只是被测试模块的同级目录。

单元测试应该明确。跳转到标题

为了更好地理解测试，函数应该被正确命名，就像在整个测试命令中提示的那样。

foo() returns bar object ... ok

测试示例

import { assertEquals } from "https://deno.land/[email protected]/assert/mod.ts";
import { foo } from "./mod.ts";

Deno.test("foo() returns bar object", function () {
  assertEquals(foo(), { bar: "bar" });
});

注意：有关更多信息，请参阅跟踪问题。

顶层函数不应该使用箭头语法。跳转到标题

顶层函数应该使用 function 关键字。箭头语法应该限制在闭包中。

错误

export const foo = (): string => {
  return "bar";
};

正确

export function foo(): string {
  return "bar";
}

`std` 跳转到标题

不要依赖外部代码。跳转到标题

https://deno.land/std/ 旨在成为所有 Deno 程序都可以依赖的基础功能。我们希望向用户保证，此代码不包含可能未经审查的第三方代码。

记录并维护浏览器兼容性。跳转到标题

如果模块与浏览器兼容，请在模块顶部的 JSDoc 中包含以下内容

// This module is browser-compatible.

通过不使用全局 Deno 命名空间或对其进行功能测试来维护此类模块的浏览器兼容性。确保任何新的依赖项也与浏览器兼容。

优先使用 `#` 而不是 `private` 跳转到标题

我们在标准模块代码库中优先使用私有字段 (#) 语法而不是 TypeScript 的 private 关键字。私有字段即使在运行时也能使属性和方法私有。另一方面，TypeScript 的 private 关键字只保证在编译时私有，而字段在运行时是公开可访问的。

正确

class MyClass {
  #foo = 1;
  #bar() {}
}

错误

class MyClass {
  private foo = 1;
  private bar() {}
}

命名约定跳转到标题

对函数、方法、字段和局部变量使用 camelCase。对类、类型、接口和枚举使用 PascalCase。对静态顶层项目使用 UPPER_SNAKE_CASE，例如 string、number、bigint、boolean、RegExp、静态项目的数组、静态键值对的记录等。

正确

function generateKey() {}

let currentValue = 0;

class KeyObject {}

type SharedKey = {};

enum KeyType {
  PublicKey,
  PrivateKey,
}

const KEY_VERSION = "1.0.0";

const KEY_MAX_LENGTH = 4294967295;

const KEY_PATTERN = /^[0-9a-f]+$/;

错误

function generate_key() {}

let current_value = 0;

function GenerateKey() {}

class keyObject {}

type sharedKey = {};

enum keyType {
  publicKey,
  privateKey,
}

const key_version = "1.0.0";

const key_maxLength = 4294967295;

const KeyPattern = /^[0-9a-f]+$/;

当名称为 camelCase 或 PascalCase 时，即使它们的部分是首字母缩略词，也始终遵循它们的规则。

注意：Web API 使用大写首字母缩略词 (JSON、URL、URL.createObjectURL() 等)。Deno 标准库不遵循此约定。

正确

class HttpObject {
}

错误

class HTTPObject {
}

正确

function convertUrl(url: URL) {
  return url.href;
}

错误

function convertURL(url: URL) {
  return url.href;
}

Deno 风格指南

版权声明 跳转到标题#

在文件名中使用下划线，而不是连字符。 跳转到标题#

为新功能添加测试。 跳转到标题#

TODO 注释 跳转到标题#

不鼓励使用元编程。包括使用 Proxy。 跳转到标题#

包容性代码 跳转到标题#

Rust 跳转到标题#

TypeScript 跳转到标题#

使用 TypeScript 而不是 JavaScript。 跳转到标题#

不要使用文件名 index.ts/index.js。 跳转到标题#

导出函数：最多 2 个参数，将其余参数放入选项对象中。 跳转到标题#

导出用作导出成员参数的所有接口 跳转到标题#

最小化依赖项；不要进行循环导入。 跳转到标题#

如果文件名以下划线开头：_foo.ts，请不要链接到它。 跳转到标题#

对导出符号使用 JSDoc。 跳转到标题#

使用指令解决代码风格问题 跳转到标题#

每个模块都应该有一个测试模块。 跳转到标题#

单元测试应该明确。 跳转到标题#

顶层函数不应该使用箭头语法。 跳转到标题#

std 跳转到标题#

不要依赖外部代码。 跳转到标题#

记录并维护浏览器兼容性。 跳转到标题#

优先使用 # 而不是 private 跳转到标题#

命名约定 跳转到标题#