Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ newPRWelcomeComment: |

Things that will help get your PR across the finish line:

- Follow the TypeScript [coding style](https://github.com/rrweb-io/rrweb/blob/master/docs/development/coding-style.md).
- Follow the TypeScript [coding style](https://github.com/rrweb-io/rrweb/blob/main/docs/development/coding-style.md).
- Run `yarn lint` locally to catch formatting errors earlier.
- Document any user-facing changes you've made following the [documentation styleguide](https://github.com/rrweb-io/rrweb/blob/master/blob/main/docs/styleguide.md).
- Document any user-facing changes you've made following the [documentation styleguide](https://github.com/rrweb-io/rrweb/blob/main/docs/styleguide.md).
- Include tests when adding/changing behavior.
- Include screenshots and animated GIFs whenever possible.

Expand Down
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ the process for contributing will follow standard GitHub protocol.

We actively welcome your pull requests (PRs)!

1. Fork the repo and create your branch from `master`.
1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests
3. Ensure the test suite passes or ask for help as to why tests are failing
4. We use [changesets](https://github.com/changesets/changesets/blob/main/docs/intro-to-using-changesets.md) to enable you to easily document your PR so that it can be packaged up into the next release. A github plugin will prompt you to fill in your changeset if you haven't already done so.
Expand Down Expand Up @@ -79,7 +79,7 @@ See [documentation](docs/development/coding-style.md)

## License

rrweb is [MIT licensed](https://github.com/rrweb-io/rrweb/blob/master/LICENSE).
rrweb is [MIT licensed](LICENSE).

By contributing to rrweb, you agree that your contributions will be licensed
under its MIT license.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ In addition to adding integration tests and unit tests, rrweb also provides a RE
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
6 changes: 3 additions & 3 deletions README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ rrweb 是 'record and replay the web' 的简写,旨在利用现代浏览器所

rrweb 主要由 3 部分组成:

- **[rrweb-snapshot](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-snapshot/)**,包含 snapshot 和 rebuild 两个功能。snapshot 用于将 DOM 及其状态转化为可序列化的数据结构并添加唯一标识;rebuild 则是将 snapshot 记录的数据结构重建为对应的 DOM。
- **[rrweb-snapshot](packages/rrweb-snapshot/)**,包含 snapshot 和 rebuild 两个功能。snapshot 用于将 DOM 及其状态转化为可序列化的数据结构并添加唯一标识;rebuild 则是将 snapshot 记录的数据结构重建为对应的 DOM。
- **[rrweb](https://github.com/rrweb-io/rrweb)**,包含 record 和 replay 两个功能。record 用于记录 DOM 中的所有变更(mutation);replay 则是将记录的变更按照对应的时间一一重放。
- **[rrweb-player](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-player/)**,为 rrweb 提供一套 UI 控件,提供基于 GUI 的暂停、快进、拖拽至任意时间点播放等功能。
- **[rrweb-player](packages/rrweb-player/)**,为 rrweb 提供一套 UI 控件,提供基于 GUI 的暂停、快进、拖拽至任意时间点播放等功能。

## Roadmap

Expand Down Expand Up @@ -174,7 +174,7 @@ rrweb 主要由 3 部分组成:
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion docs/recipes/customize-replayer.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ rrwebPlayer.addEventListener('ui-update-progress', (event) => {

## Develop a new replayer UI with `Replayer`.

Please refer [rrweb-player](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-player/).
Please refer [rrweb-player](../../packages/rrweb-player/).
2 changes: 1 addition & 1 deletion docs/recipes/customize-replayer.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,4 +71,4 @@ rrwebPlayer.addEventListener('ui-update-progress', (event) => {

## 基于 `Replayer` 开发自己的回放器 UI

可以参照 [rrweb-player](https://github.com/rrweb-io/rrweb/tree/master/packages/rrweb-player/) 的方式进行开发。
可以参照 [rrweb-player](../../packages/rrweb-player/) 的方式进行开发。
2 changes: 1 addition & 1 deletion docs/recipes/export-to-video.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ The event data recorded by rrweb is a performant, easy to compress, text-based f

But if you really need to convert it into a video format, there are some tools that can do this work.

Use [rrvideo](https://github.com/rrweb-io/rrweb/blob/master/packages/rrvideo/README.md).
Use [rrvideo](../../packages/rrvideo/README.md).
2 changes: 1 addition & 1 deletion docs/recipes/export-to-video.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@

rrweb 录制的数据是一种高效、易于压缩的文本格式,可以用于像素级的回放。但如果有进一步将录制数据转换为视频的需求,同样可以通过一些工具实现。

使用 [rrvideo](https://github.com/rrweb-io/rrweb/blob/master/packages/rrvideo/README.zh_CN.md)。
使用 [rrvideo](../../packages/rrvideo/README.zh_CN.md)。
26 changes: 13 additions & 13 deletions docs/releases/next-channel.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,19 @@ The `next` branch intentionally carries `.changeset/pre.json`:
Keep this file in prerelease mode on `next`. The `tag` must stay `next` so
Changesets publishes prerelease packages with the npm `next` dist-tag.

Do not put `master` into the `next` prerelease mode. Current `master` should not
have `.changeset/pre.json`; stable releases from `master` continue to publish as
Do not put `main` into the `next` prerelease mode. Current `main` should not
have `.changeset/pre.json`; stable releases from `main` continue to publish as
normal and move `latest` only through the regular stable release process.

## Regular operation

Bring stable branch updates into `next` as needed, either by merging `master` or
Bring stable branch updates into `next` as needed, either by merging `main` or
by cherry-picking specific commits:

```sh
git switch next
git fetch origin
git merge origin/master
git merge origin/main
```

If the merge conflicts on `.changeset/pre.json`, resolve the conflict by keeping
Expand All @@ -44,20 +44,20 @@ before promotion. Include normal Changesets for user-facing package changes; the
release workflow will turn those changesets into generated prerelease version
commits on `next`.

## Promoting work back to master
## Promoting work back to main

Do not merge `next` wholesale back to `master`. Promotion should copy only the
Do not merge `next` wholesale back to `main`. Promotion should copy only the
human-authored feature work that is ready for stable release:

```sh
git switch master
git switch main
git fetch origin
git cherry-pick <feature-commit-sha>
```

Cherry-pick source, docs, tests, and normal changeset commits that describe the
feature. Never cherry-pick generated `Version Packages (next)` commits from
`next` to `master`.
`next` to `main`.

When promoting, exclude release-generated files from the cherry-pick if they are
present in the selected commits:
Expand All @@ -67,12 +67,12 @@ present in the selected commits:
- version-only `package.json` changes

Those files are generated separately by the stable release workflow after the
promoted changesets land on `master`.
promoted changesets land on `main`.

If a cherry-pick includes both feature code and generated release changes, use a
non-committing cherry-pick and reset generated release files before committing.
Restore prerelease metadata and generated changelogs outright, then inspect
package manifests hunk-by-hunk so version-only changes do not move to `master`:
package manifests hunk-by-hunk so version-only changes do not move to `main`:

```sh
git cherry-pick --no-commit <feature-commit-sha>
Expand All @@ -92,17 +92,17 @@ metadata changes only when they are part of the promoted feature.

## Release workflow and Chrome extension

The release workflow runs on both `master` and `next`. On `next`, Changesets
The release workflow runs on both `main` and `next`. On `next`, Changesets
publishes prerelease packages to npm using the `next` dist-tag.

Chrome extension publication is also branch-specific:

- `master` publishes the production extension listing. Its extension ID is
- `main` publishes the production extension listing. Its extension ID is
hard-coded in `.github/workflows/release.yml`, and it uses the existing
`CWS_CLIENT_ID`, `CWS_CLIENT_SECRET`, and `CWS_REFRESH_TOKEN` secrets.
- `next` publishes the prerelease extension listing with
`NEXT_CWS_EXTENSION_ID`, `NEXT_CWS_CLIENT_ID`, `NEXT_CWS_CLIENT_SECRET`, and
`NEXT_CWS_REFRESH_TOKEN`.

Keep those listings and credentials separate. Changes to the `next` listing
should not affect the production Chrome Web Store listing used by `master`.
should not affect the production Chrome Web Store listing used by `main`.
2 changes: 1 addition & 1 deletion packages/all/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,7 +175,7 @@ The legacy UMD global is `rrweb`, so you will need to prefix the example APIs, e
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/packer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ And the [guide](../../guide.md) for more info on rrweb.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/rrweb-plugin-console-record/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ See the [guide](../../../guide.md) for more info on rrweb.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
/* eslint-disable @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-return */
/**
* Class StackFrame is a fork of https://github.com/stacktracejs/stackframe/blob/master/stackframe.js
* Class StackFrame is a fork of https://github.com/stacktracejs/stackframe/blob/HEAD/stackframe.js
* I fork it because:
Comment on lines 2 to 4
* 1. There are some build issues when importing this package.
* 2. Rewrites into typescript give us a better type interface.
Expand Down Expand Up @@ -34,7 +34,7 @@ export class StackFrame {
}

/**
* ErrorStackParser is a fork of https://github.com/stacktracejs/error-stack-parser/blob/master/error-stack-parser.js
* ErrorStackParser is a fork of https://github.com/stacktracejs/error-stack-parser/blob/HEAD/error-stack-parser.js
* I fork it because:
Comment on lines 36 to 38
* 1. There are some build issues when importing this package.
* 2. Rewrites into typescript give us a better type interface.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ export function stringify(
obj,
function (key, value: string | bigint | object | null | undefined) {
/**
* forked from https://github.com/moll/json-stringify-safe/blob/master/stringify.js
* forked from https://github.com/moll/json-stringify-safe/blob/HEAD/stringify.js
* to deCycle the object
Comment on lines 95 to 97
*/
if (stack.length > 0) {
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/rrweb-plugin-console-replay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ See the [guide](../../../guide.md) for more info on rrweb.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/rrweb-plugin-network-record/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ See the [guide](../../../guide.md) for more info on rrweb.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/plugins/rrweb-plugin-network-replay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ See the [guide](../../../guide.md) for more info on rrweb.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ record({
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ replayer.play(); // ERROR: [sequential-id-plugin]: expect to get an id with valu
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/record/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ All `record` related code will get moved here in the future.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/replay/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,7 @@ All `Replayer` related code will get moved here in the future.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/rrdom-nodejs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ See the [guide](../../guide.md) for more info on rrweb.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/rrdom/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ See the [guide](../../guide.md) for more info on rrweb.
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/rrvideo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ You can find an example of the rrvideo config file [here](./rrvideo.config.examp
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
2 changes: 1 addition & 1 deletion packages/rrvideo/README.zh_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ rrvideo 配置文件可参考[示例](./rrvideo.config.example.json)。
<tr>
<td align="center">
<a href="http://www.smartx.com/" target="_blank">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/master/static/logos/smartx.png" alt="SmartX">
<img width="195px" src="https://raw.githubusercontent.com/rrweb-io/web/HEAD/static/logos/smartx.png" alt="SmartX">
</a>
</td>
<td align="center">
Expand Down
Loading
Loading