Skip to content
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

Jump to bottom

feat: Adding possibility to get rid of prototypes from the output #6504

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

feat: Adding possibility to get rid of prototypes from the output #6504

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5c0d56f
Update index.ts
spamshaker Sep 14, 2024
d017017
Update types.ts
spamshaker Sep 14, 2024
f03ed3b
Merge branch 'main' into spamshaker-patch-1
spamshaker Sep 14, 2024
b26cbcb
Update config documentation to include diff.printBasicPrototype
Sep 14, 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
8 changes: 8 additions & 0 deletions docs/config/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2294,6 +2294,7 @@ export default {
aIndicator: c.bold('--'),
bIndicator: c.bold('++'),
omitAnnotationLines: true,
printBasicPrototype: false,
} satisfies DiffOptions
```

Expand Down Expand Up @@ -2330,6 +2331,13 @@ Annotation that is output at the end of diff result if it's truncated.

Color of truncate annotation, default is output with no color.

#### diff.printBasicPrototype

- **Type**: `boolean`
- **Default**: `true`

Allows to set pretty-format option printBasicPrototype for diff output
Comment on lines +2334 to +2339
Copy link
Contributor

Choose a reason for hiding this comment

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

Isn't it already default false on Vitest? https://vitest.dev/guide/snapshot.html#_2-printbasicprototype-is-default-to-false

Copy link
Contributor

@hi-ogawa hi-ogawa Sep 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Aha, I just notice these two diff.printBasicPrototype and snapshotFormat.printBasicPrototype are different things. I think adding this option is okay to start with, but I wonder if we should have these two same as default.

Btw, can you add a test?


### fakeTimers

- **Type:** `FakeTimerInstallOpts`
Expand Down
4 changes: 3 additions & 1 deletion packages/utils/src/diff/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@
]
const FORMAT_OPTIONS = {
plugins: PLUGINS,
printBasicPrototype: true

Check failure on line 56 in packages/utils/src/diff/index.ts

View workflow job for this annotation

GitHub Actions / Lint: node-latest, ubuntu-latest 

Missing trailing comma
}
const FALLBACK_FORMAT_OPTIONS = {
callToJSON: false,
Expand Down Expand Up @@ -180,11 +181,12 @@
formatOptions: PrettyFormatOptions,
options?: DiffOptions,
): PrettyFormatOptions {
const { compareKeys } = normalizeDiffOptions(options)
const { compareKeys, printBasicPrototype } = normalizeDiffOptions(options)

return {
...formatOptions,
compareKeys,
printBasicPrototype

Check failure on line 189 in packages/utils/src/diff/index.ts

View workflow job for this annotation

GitHub Actions / Lint: node-latest, ubuntu-latest 

Missing trailing comma
}
}

Expand Down
2 changes: 2 additions & 0 deletions packages/utils/src/diff/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export interface DiffOptions {
includeChangeCounts?: boolean
omitAnnotationLines?: boolean
patchColor?: DiffOptionsColor
printBasicPrototype?: boolean
compareKeys?: CompareKeys
truncateThreshold?: number
truncateAnnotation?: string
Expand All @@ -51,6 +52,7 @@ export interface DiffOptionsNormalized {
includeChangeCounts: boolean
omitAnnotationLines: boolean
patchColor: DiffOptionsColor
printBasicPrototype: boolean
truncateThreshold: number
truncateAnnotation: string
truncateAnnotationColor: DiffOptionsColor
Expand Down
Loading