@fluid-experimental/devtools-core

@fluid-experimental/devtools-core

This library contains developer tools for use alongside the Fluid Framework. It is used to power our associated browser extensions.

TODO: link to extensions once they are published.

Installation

To get started, install the package by running the following command:

npm i @fluid-experimental/devtools-core -D

Usage

The Devtools' API surface is designed to fit nicely into most application flows.

Initialization

To initialize a debugger session for your container, call initializeDevtools. This function accepts a DevtoolsLogger for recording and communicating telemetry data, a list of initial Fluid Containers to associate with the session, and (optionally) customized data visualization configurations for visualizing Container data.

TODO: link to API docs once API shape has settled.

Clean-up

The Devtools object is managed as a global singleton. That singleton is automatically cleaned up prior to the Window's "unload" event. So typical application flows likely won't need to worry about cleanup. That said, if you wish to have tighter control over when the Devtools are torn down, you can simply call the dispose method on the handle returned by initialization.

Related Tooling

This library is designed to work alongside our Chromium browser extension.

TODO: link to code on github once package names have been finalized. TODO: link to the various browsers' webstore pages for our extension once it has been publiched.

Working in the package

Build

To build the package locally, first ensure you have run pnpm install from the root of the mono-repo. Next, to build the code, run npm run build from the root of the mono-repo, or use fluid-build via fluid-build -s build.

• Note: Once you have run a build from the root, assuming no other changes outside of this package, you may run npm run build directly within this directory for a faster build. If you make changes to any of this package's local dependencies, you will need to run a build again from the root before building again from directly within this package.

Test

To run the tests, first ensure you have followed the build steps above. Next, run npm run test from a terminal within this directory.

API Documentation

API documentation for @fluid-experimental/devtools-core is available at https://fluidframework.com/docs/apis/devtools-core.

Contribution Guidelines

There are many ways to contribute to Fluid.

• Participate in Q&A in our GitHub Discussions.
• Submit bugs and help us verify fixes as they are checked in.
• Review the source code changes.
• Contribute bug fixes.

Detailed instructions for working in the repo can be found in the Wiki.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [e-mail] with any additional questions or comments.

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services. Use of these trademarks or logos must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.

Help

Not finding what you're looking for in this README? Check out our GitHub Wiki or fluidframework.com.

Still not finding what you're looking for? Please file an issue.

Thank you!

Trademark

This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.

Use of these trademarks or logos must follow Microsoft's Trademark & Brand Guidelines.

Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.