用途
该资料说明 Chrome DevTools 前端代码库中 TypeScript 代码的导入约定。遵循这些规则可以避免构建错误。
模块与入口概念
在 DevTools 中,每个代码文件夹被视为一个模块,例如 front_end/models/trace 是 trace 模块,front_end/panels/timeline 是 timeline 模块。每个模块内包含多个 TypeScript 文件,其中与文件夹同名的文件称为入口点(entrypoint),例如 front_end/models/trace/trace.ts 是 trace 模块的入口,而 front_end/models/trace/ModelImpl.ts 属于该模块的实现部分。
跨模块导入规则
当需要复用其他模块的代码时,必须通过该模块的入口点导入。资料以 front_end/panels/timeline/TimelinePanel.ts 为例:
正确写法: import * as Trace from '../models/trace/trace.js';
错误写法(导入了非入口文件): import * as ModelImpl from '../models/trace/ModelImpl.js';
此外,必须使用 "import * as" 语法,例如以下写法是错误的: import {ModelImpl, X, Y} from '../models/trace/trace.js'; 而 import * as Trace from '../models/trace/trace.js'; 是正确的。
模块内部导入规则
如果在同一模块内,可以直接从文件导入,而不必经过入口点,也可以只导入所需的具体成员。例如编辑 front_end/models/trace/ModelImpl.ts 时,import {Foo} from './Foo.js'; 是可接受的,因为 Foo.ts 位于同一目录。
适用场景与限制
该约定适用于参与该前端代码库开发、修改 TypeScript 文件的开发者。资料未提供其他使用步骤、工具或效果说明。