Skip to content

fix(repl): avoid duplicate formatter mounts #10472

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Jul 11, 2024
Merged

fix(repl): avoid duplicate formatter mounts #10472

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7d1226f
fix(repl): Avoid duplicate formatter mounts
baiwusanyu-c Mar 7, 2024
9228d31
Merge branch 'main' into bwsy/fix/10466
baiwusanyu-c Mar 11, 2024
74757ee
Merge branch 'main' into bwsy/fix/10466
baiwusanyu-c Mar 12, 2024
02ec969
fix(repl): updated code
baiwusanyu-c Mar 13, 2024
a98ab7d
Merge branch 'main' into bwsy/fix/10466
baiwusanyu-c Mar 13, 2024
21c8bbf
Merge branch 'main' into bwsy/fix/10466
baiwusanyu-c Mar 18, 2024
8a70035
Merge branch 'main' into bwsy/fix/10466
baiwusanyu-c Apr 22, 2024
f5fff40
Merge branch 'main' into bwsy/fix/10466
baiwusanyu-c Apr 29, 2024
7a47460
Merge branch 'main' into bwsy/fix/10466
baiwusanyu-c Jul 11, 2024
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
1 change: 1 addition & 0 deletions packages/runtime-core/src/customFormatter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ export function initCustomFormatter() {
// custom formatter for Chrome
// https://www.mattzeunert.com/2016/02/19/custom-chrome-devtools-object-formatters.html
const formatter = {
__vue_custom_formatter: true,
header(obj: unknown) {
// TODO also format ComponentPublicInstance & ctx.slots/attrs in setup
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this PR works, I prefer fixing the issue in the playground codebase.
Otherwise, we need some kind of versioning in the custom formatter.
Consider the scenario where we implemented the feature mentioned in this TODO comment in the future, and the page has loaded several versions of Vue; we would still need to add the latest custom formatter despite the presence of another version of Vue custom formatter.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you mean that I should modify @vue/sfc-playground and find a way to ensure that the custom formatter is always up to date when using multiple versions of vue?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think just modifying the sfc-playground package is enough.

There are very few cases that we need to worry about too many devtoolFormatters so the deduplication might be overkill.

if (!isObject(obj)) {
Expand Down
8 changes: 7 additions & 1 deletion packages/sfc-playground/src/App.vue
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,13 @@ onMounted(() => {
:preview-options="{
customCode: {
importCode: `import { initCustomFormatter } from 'vue'`,
useCode: `initCustomFormatter()`,
useCode: `if (window.devtoolsFormatters) {
const index = window.devtoolsFormatters.findIndex((v) => v.__vue_custom_formatter)
window.devtoolsFormatters.splice(index, 1)
initCustomFormatter()
} else {
initCustomFormatter()
}`,
},
}"
/>
Expand Down