OpenParable
Skip to content
← Back to skills

Devtools Imports

Development
devtools-imports

Devtools Imports is an Agent Skill for development published in the ChromeDevTools/devtools-frontend repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Conventions for importing code in Devtools to avoid build errors. Covers cross-module imports, internal imports, and the "import * as" requirement.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/ChromeDevTools/devtools-frontend/blob/HEAD/.agents/skills/devtools-imports/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/devtools-imports, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Imports

This codebase follows a special convention for importing code that must be followed to avoid build errors.

In DevTools each folder of code is considered a module:

  • front_end/models/trace is the trace module.
  • front_end/panels/timeline is the timeline module.

Within each module there are multiple TypeScript files. The file that is named the same as the folder name is called the entrypoint.

  • front_end/models/trace/trace.ts is the trace module's entrypoint
  • front_end/models/trace/ModelImpl.ts is part of the implementation of the trace module.

Importing from another module

When you want to reuse code from other modules, you must import that module via its entrypoint. Imagine we are in front_end/panels/timeline/TimelinePanel.ts. This import is GOOD:

import * as Trace from '../models/trace/trace.js'; // import the entrypoint

This import is BAD because we import a file that is NOT the entrypoint:

import * as ModelImpl from '../models/trace/ModelImpl.js' // NEVER ALLOWED

Additionally, you must import using the import * as syntax.

import {ModelImpl, X, Y} from '../models/trace/trace.js'; // BAD
import * as Trace from '../models/trace/trace.js'; // GOOD

Importing from within the same module

If you are within the same module, it is OK to import from files directly rather than go via the entrypoint. You can also import specifically what you need.

For example, if you are editing front_end/models/trace/ModelImpl.ts this would be acceptable:

import {Foo} from './Foo.js'; // allowed because Foo.ts is in the same directory.