Improve type safety and code quality

[bryanjtc]

Description

This pull request introduces several changes to the codebase, primarily in the src/csf and src/playwright directories. These changes aim to improve the code quality and functionality of the project.

Changes in src/config/jest-playwright.ts

• New Import: import type { Config } from '@jest/types'.
• Modification: TEST_RUNNER_PATH now uses the nullish coalescing operator ?? instead of ||.
• Update: getJestPlaywrightConfig explicitly declares return type as Config.InitialOptions.
• Refactoring: Replaced string concatenation with template literals for path definitions.
• Enhancement in getJestConfig function:
  • Explicitly declared return type as Config.InitialOptions.
  • Utilized optional chaining and nullish coalescing for testMatch.
  • Introduced const config with type Config.InitialOptions.

Changes in Snapshot Files

src/csf/__snapshots__/transformCsf.test.ts.snap

• New Snapshot Test: For transformCsf handling cases with no stories.

Changes in src/csf/transformCsf.test.ts

• New Test Case: 'returns empty result if there are no stories'.

Modifications in src/csf/transformCsf.ts

• Type Changes: In makePlayTest and makeDescribe, return type altered to t.ExpressionStatement[].
• Function Update: transformCsf
  • Adjusted default parameters.
  • Generic Record type used in storyPlays.
  • Altered playTests to exclude null values.

Changes in src/playwright/hooks.ts

• Type Modification: HttpHeaderSetter to return Promise<Record<string, string>>.

Adjustments in src/playwright/index.ts

• Function Simplification: process function signature streamlined by removing config parameter.

Updates in src/playwright/transformPlaywright.test.ts

• Snapshot Serializer Improvement: in expect.addSnapshotSerializer.

Revisions in src/playwright/transformPlaywright.ts

• Function Update: testPrefixer with enhanced type safety and template literals usage.
• Refactoring: makeTitleFactory uses template literals for filePath.

Modifications in src/playwright/transformPlaywrightJson.test.ts

• Enhanced Testing: For transformPlaywrightJson with type satisfactions.
• New Test Case: For handling unsupported index versions.
• New Test Case: For handling empty statements.

Changes in src/playwright/transformPlaywrightJson.ts

• Type and Logic Updates: To handle version-specific processing in transformPlaywrightJson.

Adjustments in src/setup-page.ts

• Function Refactoring: sanitizeURL with template literals and improved logic.
• Simplification: In setupPage with nullish coalescing.

Changes in src/test-storybook.ts

• Code Refactoring: For readability and efficiency.

Modifications in TypeScript Definitions (src/typings.d.ts)

• Type Enhancements: New imports and updated global variable types.

Revisions in CLI Options Utilities (src/util/getCliOptions.*)

• Streamlined Processing: Of CLI options and improved type clarity.

Changes in src/util/getStorybookMain.test.ts

• Import Changes: Added storybookMainConfig to the existing imports.
• New Test Added:
  • Test to ensure that getStorybookMain returns the configDir value from storybookMainConfig if it exists.

Changes in src/util/getStorybookMain.ts

• Export Added: storybookMainConfig Map is now exported.
• getStorybookMain Function Changes:
  • Modified to check storybookMainConfig for 'configDir' key instead of configDir argument.
  • Updated setting and getting logic in storybookMainConfig to use 'configDir' as a constant key.

Changes in .storybook/main.ts

• Modification in features Configuration:
  • Update in storyStoreV7:
    • Previous Behavior: Set to false if process.env.STORY_STORE_V7 equals 'false', otherwise true.
    • New Behavior: Now true unless process.env.STORY_STORE_V7 is explicitly 'false'.

Changes in .storybook/test-runner.ts

• Enhancement in Test Runner Configuration:
  • Refinement: Added optional chaining (?.) to innerHTML method call on elementHandler.
  • Benefit: Improves code robustness by handling potential null or undefined values for elementHandler.

Changes in test-runner-jest.config.js

• Documentation Enhancement:
  • Addition: JSDoc comment block above the module exports.
  • Purpose: Specifies the type of the exported configuration as import('@jest/types').Config.InitialOptions.
  • Impact: Enhances code readability and ensures type safety by explicitly defining the configuration structure.

These changes collectively enhance the codebase by improving type safety, code readability, and adherence to coding standards. The introduction of new tests and error handling ensures more robust functionality.

From: #323

📦 Published PR as canary version: 0.15.3--canary.383.049359f.0

✨ Test out this PR locally via:

npm install @storybook/test-runner@0.15.3--canary.383.049359f.0
# or 
yarn add @storybook/test-runner@0.15.3--canary.383.049359f.0

Version

Published prerelease version: v0.15.3-next.0

Changelog

🐛 Bug Fix

• Improve type safety and code quality #383 (@bryanjtc @yannbf)
• Refactor: Improve internal code #378 (@bryanjtc @yannbf)

Authors: 2

• Bryan Thomas (@bryanjtc)
• Yann Braga (@yannbf)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

❗ No coverage uploaded for pull request base (enable-strict-mode@1843bee). Click here to learn what that means.

Additional details and impacted files

@@                  Coverage Diff                  @@
##             enable-strict-mode     #383   +/-   ##
=====================================================
  Coverage                      ?   92.05%           
=====================================================
  Files                         ?       15           
  Lines                         ?      277           
  Branches                      ?       72           
=====================================================
  Hits                          ?      255           
  Misses                        ?       22           
  Partials                      ?        0           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[yannbf]

Thank you so much! Great stuff 🚀

[github-actions]

🚀 PR was released in v0.16.0 🚀