Skip to content

Latest commit

 

History

History
 
 

README.md

DevTools Reps

Reps is Firefox DevTools' remote object formatter. It stands for representation.

Example

const React = require("react");
let {
  Rep,
  Grip,
  MODE,
  ObjectInspector,
  ObjectInspectorUtils
} = require("devtools-reps");

function renderRep({ object, mode }) {
  return Rep({ object, defaultRep: Grip, mode });
}

ReactDOM.render(
  Rep({ object, defaultRep: Grip, mode }),
  document.createElement("div")
);

What is what?

Rep

Rep is the top-level component that is capable of formatting any type.

Supported types:

RegExp, StyleSheet, Event, DateTime, TextNode, Attribute, Func, ArrayRep, Document, Window, ObjectWithText, ObjectWithURL, GripArray, GripMap, Grip, Undefined, Null, StringRep, Number, SymbolRep,

Grip

Grip is a client representation of a remote JS object and is used as an input object for this rep component.

Getting started

You need to clone the debugger.html repository, then install dependencies, for which you'll need the Yarn tool:

git clone https://github.com/firefox-devtools/debugger.git
cd debugger.html
yarn install

Once everything is installed, you can start the development server with:

cd packages/devtools-reps/
yarn start

and navigate to http://localhost:8000 to access the dashboard.

Running the demo app

Navigating to the above address will have landed you on an empty launchpad UI:

Image of empty launchpad

Click on the Launch Firefox button. This should launch Firefox with a dedicated profile, listening for connections on port 6080.

The UI should update automatically and show you at least one tab for the new Firefox instance. If it doesn't, reload the dashboard.

Image of launchpad

Click on any of the tabs. This should open the demo app:

Image of demo app

Then you can type any expression in the input field. They will be evaluated against the target tab selected in the previous steps (so if there specific objects on window on this webpage, you can check how they are represented with reps etc, ...).

Running the tests

Reps tests are written with jest.

They are run on every pull request with Circle CI, and you can run them locally by executing yarn test from /packages/devtools-reps.

History

The Reps project was ported to Github January 18th, 2017. You can view the history of a file after that date on github or by running this query:

git log --before "2017-1-17" devtools/client/shared/components/reps

They were first moved to the devtools-reps repository, then to the devtools-core one, before being migrated to this repository.

License

MPL 2