Files

Eoghan Murray 26c331b3b7 yarn format - prettier improvements & add .editorconfig (#1471 )

Some dev improvements:
* Add .editorconfig config file https://editorconfig.org/
* move the singleQuote spec into .editorconfig and add old .changesets/*.md to .prettierignore so that we don't incorrectly reformat new changeset files to single quote from the double quote which they can be autogenerated with in github
* .gitignore Ignore emacs chaff files
* Add `yarn format:head` a convenience command to run prettier against just those files in the head commit
* Some mention of `yarn format` in the docs
* Fix some test html closing tags; authoring mistakes, rather than deliberately malformed html — picked up by an explicit `yarn prettier --write '**/*.html'`

2024-05-13 11:53:08 +01:00

scripts

Chore: Make inject script more robust on repl & stream (#1429 )

2024-04-05 12:15:14 +02:00

src

perf: Avoid an extra function call and object clone during event emission (#1441 )

2024-04-19 12:50:06 +01:00

test

yarn format - prettier improvements & add .editorconfig (#1471 )

2024-05-13 11:53:08 +01:00

.gitignore

[Plugin] Live stream canvas via webrtc (#976 )

2022-09-15 11:24:05 +08:00

.release-it.json

CI: add a prettier GitHub action to format code automatically (#988 )

2022-09-06 09:38:43 +08:00

CHANGELOG.md

Version Packages (alpha) (#1436 )

2024-04-18 16:21:24 +02:00

jest.config.js

Canvas recording: Preserve drawing buffer (#1273 )

2023-08-04 18:35:49 +02:00

package.json

Version Packages (alpha) (#1436 )

2024-04-18 16:21:24 +02:00

README.md

Fix #972 [Docs]: Add Readme.md to packages/rrweb (#1025 )

2022-10-17 18:16:40 +08:00

rollup.config.js

Enable preserveSource (#1309 )

2023-10-06 10:42:59 +01:00

tsconfig.json

fix CI error (#1045 )

2022-11-07 12:54:36 +08:00

README.md

Try rrweb

rrweb

This is a simpler version of the original rrewb README within this rrweb subpackage

中文文档

rrweb refers to 'record and replay the web', which is a tool for recording and replaying users' interactions on the web.

Guide

📚 Read the rrweb guide here. 📚

🍳 Recipes 🍳

Project Structure

rrweb mainly includes two funtions:

Record: The record function is used to record all the mutations in the DOM
Replay: The replay function is to replay the recorded mutations one by one according to the corresponding timestamp.

Roadmap

rrdom: an ad-hoc DOM for rrweb session data #419
storage engine: do deduplication on a large number of rrweb sessions
more end-to-end tests
compact mutation data in common patterns
provide plugins via the new plugin API, including:
- XHR plugin
- fetch plugin
- GraphQL plugin
- ...

Internal Design

Contribute Guide

Since we want the record and replay sides to share a strongly typed data structure, rrweb is developed with typescript which provides stronger type support.

Typescript handbook

Fork this repository.
Run yarn install in the root to install required dependencies for all sub-packages (note: npm install is not recommended).
Run yarn dev in the root to get auto-building for all the sub-packages whenever you modify anything.
Navigate to one of the sub-packages (in the packages folder) where you'd like to make a change.
Patch the code and run yarn test to run the tests, make sure they pass before you commit anything.
Push the code and create a pull request.

Protip: You can run yarn test in the root folder to run all the tests.

In addition to adding integration tests and unit tests, rrweb also provides a REPL testing tool.

Using the REPL tool

Core Team Members

_Yuyz0112

_Mark-Fenng

_eoghanmurray

_Juice10

Who's using rrweb