Core: Enhance getPrettier function to provide prettier interface #33260

valentinpalkovic · 2025-12-02T20:05:14Z

What I did

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

stories
unit tests
integration tests
end-to-end tests

Manual testing

This section is mandatory for all contributions. If you believe no manual test is necessary, please state so explicitly. Thanks!

Documentation

Add or update documentation reflecting your changes
If you are deprecating/removing a feature, make sure to update
MIGRATION.MD

Checklist for Maintainers

When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts
Make sure this PR contains one of the labels below:
Available labels
- bug: Internal changes that fixes incorrect behavior.
- maintenance: User-facing maintenance tasks.
- dependencies: Upgrading (sometimes downgrading) dependencies.
- build: Internal-facing build tooling & test updates. Will not show up in release changelog.
- cleanup: Minor cleanup style change. Will not show up in release changelog.
- documentation: Documentation only changes. Will not show up in release changelog.
- feature request: Introducing a new feature.
- BREAKING CHANGE: Changes that break compatibility in some way with current major version.
- other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook publish.yml --field pr=<PR_NUMBER>

Summary by CodeRabbit

Refactor
- Enhanced code formatter with improved type safety and fallback handling when the external formatter is unavailable, ensuring more consistent formatting operations across the application.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

nx-cloud · 2025-12-02T20:05:48Z

View your CI Pipeline Execution ↗ for commit a243195

Command	Status	Duration	Result
`nx run-many -t compile,check,knip,test,pretty-d...`	✅ Succeeded	3m 10s	View ↗

☁️ Nx Cloud last updated this comment at 2025-12-03 06:45:19 UTC

coderabbitai · 2025-12-02T20:08:41Z

📝 Walkthrough

Walkthrough

Updated the Prettier API integration in the formatter utility by introducing a local Prettier interface and changing getPrettier() to return Promise<Prettier> instead of Promise<any>. The implementation now attempts dynamic import with a comprehensive fallback providing stubbed Prettier methods.

Changes

Cohort / File(s)	Summary
Prettier API Type Safety `code/core/src/common/utils/formatter.ts`	Introduced local `Prettier` interface to define the Prettier API shape. Updated `getPrettier()` return type from `Promise<any>` to `Promise<Prettier>`. Enhanced fallback implementation with stubbed methods (AstPath, doc, util, version, resolveConfig, format, check, clearConfigCache, formatWithCursor, getFileInfo, getSupportInfo, resolveConfigFile). Added explicit `Promise<string>` return type to `formatWithEditorConfig` helper.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Prettier interface completeness: Verify that the local Prettier interface accurately captures the necessary API surface and matches the expected type contract used throughout the codebase.
Fallback implementation robustness: Review the stubbed methods in the fallback implementation to ensure they provide sufficient mimicry of the real Prettier API and handle edge cases gracefully.
Type propagation: Confirm that all existing call sites of getPrettier() properly align with the new Promise<Prettier> type and no type mismatches are introduced.
Dynamic import error handling: Assess the logic for gracefully handling import failures and ensure the fallback activates correctly under various conditions.

✨ Finishing touches

📝 Generate docstrings

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (2)

code/core/src/common/utils/formatter.ts (2)
38-38: Minor: formatWithCursor fallback returns empty string instead of original content.

Other fallbacks like format (line 35) preserve the input content. For consistency, formatWithCursor should return the original content as formatted.
-      formatWithCursor: () => Promise.resolve({ formatted: '', cursorOffset: 0 }),
+      formatWithCursor: (content: string) => Promise.resolve({ formatted: content, cursorOffset: 0 }),
80-83: Minor inconsistency: Consider using await for consistency with line 60.

The formatFileContent function uses await format(...) (line 60), but here format is returned directly. While both work correctly due to async function semantics, using await consistently improves readability and provides better stack traces if errors occur.
-  return format(content, {
+  return await format(content, {
     ...(config as any),
     filepath: filePath,
   });

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 453d754 and a243195.

📒 Files selected for processing (1)

code/core/src/common/utils/formatter.ts (2 hunks)

🧰 Additional context used

📓 Path-based instructions (5)

**/*.{js,jsx,json,html,ts,tsx,mjs}