Refactor: Improve internal code

[bryanjtc]

Pull Request Summary

Description:
This pull request introduces several changes and additions to the codebase. These changes enhance the codebase and improve error handling and type checking. Below is a detailed summary of the changes made in each file:

.github/workflows/typecheck.yml

• Added a new workflow file named typecheck.yml.
• This workflow runs on push and pull request events.
• It uses Node.js version 18.x and installs dependencies using the bahmutov/npm-install action.
• Finally, it runs the TypeScript type checker using yarn tsc.

src/config/jest-playwright.ts

• Modified the browsers property by checking if TEST_BROWSERS exists.

src/csf/transformCsf.ts

• Introduced a result variable and assigned the input to it.
• Checked if testPrefixer exists, and if so, performed some additional operations.
• If result is falsy, it's set to a null literal.

src/csf/transformCsf.test.ts

• Created a new test file for the transformCsf function and prefixFunction.

src/playwright/transformPlaywright.ts

• Updated the makeTitleFactory function to ensure the returned value is always a string.

src/setup-page.ts

• Added conditional logic to check if testRunnerConfig exists before calling the defaultPrepare function.

src/test-storybook.ts

• Improved error handling when an error occurs, including checking if the error is an instance of Error and creating an error object with a stack if necessary.

src/util/getCliOptions.test.ts

• Added a new test case that checks whether default options are returned when no options are passed.
• Added new test cases that check whether string options, boolean options and extra arguments are handled correctly.

src/util/getCliOptions.ts

• Updated the handling of boolean and string options, ensuring they are correctly processed.

src/util/getParsedCliOptions.test.ts

• Created a new test file for the getParsedCliOptions function.

src/util/getParsedCliOptions.ts

• Improved error handling to catch and handle Commander errors.
• Added an unknown option handling and warning for unknown options.

src/util/getStorybookMetadata.ts

• Updated the getStorybookMetadata function to handle cases where configDir is not provided.

src/util/getTestRunnerConfig.test.ts

• Added a new test file for the getTestRunnerConfig function.

src/util/getTestRunnerConfig.ts

• Updated the getTestRunnerConfig function to handle cases where configDir is not provided.

tsconfig.json

• Updated the TypeScript configuration to include stricter type checking and set noEmit to true.

Changes in jest.config.js:

• ModuleNameMapper Added: A new moduleNameMapper section has been included to map various '@storybook/test-runner/playwright' paths to corresponding '/playwright' paths.

Additions in src/config/jest-playwright.test.ts:

• New File Creation: This file introduces unit tests for the Jest configuration in a Playwright environment.

Additions in src/playwright/hooks.test.ts:

• New File Creation: This file introduces unit tests for the hooks in a Playwright environment.

Additions in src/playwright/hooks.test.ts:

• New File Creation: This file introduces unit tests for the hooks in a Playwright environment.

From #323

📦 Published PR as canary version: 0.15.3--canary.378.1843bee.0

✨ Test out this PR locally via:

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (53fdd0f) 80.64% compared to head (e2afb66) 96.10%.

❗ Current head e2afb66 differs from pull request most recent head 1843bee. Consider uploading reports for the commit 1843bee to get more accurate results

Additional details and impacted files

@@             Coverage Diff             @@
##             next     #378       +/-   ##
===========================================
+ Coverage   80.64%   96.10%   +15.46%     
===========================================
  Files          12       14        +2     
  Lines         217      257       +40     
  Branches       56       69       +13     
===========================================
+ Hits          175      247       +72     
+ Misses         42       10       -32     

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

[bryanjtc]

@yannbf This is part 1 from the changes proposed in #323
This pr doesn't have any breaking changes. It should be easier to review.

[yannbf]

Hey @bryanjtc! Thank you so much for all these contributions! I finally have time to go through them, and will start reviewing, adding work on top of and responding to them.

[github-actions]

🚀 PR was released in v0.16.0 🚀