Merge pull request #22487 from 1234tgk/ts-migrate/addon-storyshots

Migrate @storybook/addon-storyshots to strict TS
storybookjs · May 31, 2023 · 294fe71 · 294fe71
2 parents d17c035 + f6795ef
commit 294fe71
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 11 deletions.
diff --git a/code/addons/storyshots-core/package.json b/code/addons/storyshots-core/package.json
@@ -32,6 +32,7 @@
     "*.d.ts"
   ],
   "scripts": {
+    "check": "../../../scripts/node_modules/.bin/tsc --noEmit",
     "prep": "../../../scripts/prepare/tsc.ts"
   },
   "dependencies": {

diff --git a/code/addons/storyshots-core/src/Stories2SnapsConverter.test.ts b/code/addons/storyshots-core/src/Stories2SnapsConverter.test.ts
@@ -7,7 +7,7 @@ describe('getSnapshotFileName', () => {
     const context = { fileName: 'foo.js', kind: 'kind' };
 
     const result = target.getSnapshotFileName(context);
-    const platformAgnosticResult = result.replace(/\\|\//g, '/');
+    const platformAgnosticResult = result?.replace(/\\|\//g, '/');
 
     // This is an absolute path, so we need to use `toContain()`
     expect(platformAgnosticResult).toContain('__snapshots__/foo.storyshot');
@@ -17,7 +17,7 @@ describe('getSnapshotFileName', () => {
     const context = { fileName: 'foo.web.stories.js', kind: 'kind' };
 
     const result = target.getSnapshotFileName(context);
-    const platformAgnosticResult = result.replace(/\\|\//g, '/');
+    const platformAgnosticResult = result?.replace(/\\|\//g, '/');
 
     // This is an absolute path, so we need to use `toContain()`
     expect(platformAgnosticResult).toContain('__snapshots__/foo.web.stories.storyshot');
@@ -27,7 +27,7 @@ describe('getSnapshotFileName', () => {
     const context = { fileName: 'test/foo.js', kind: 'kind' };
 
     const result = target.getSnapshotFileName(context);
-    const platformAgnosticResult = result.replace(/\\|\//g, '/');
+    const platformAgnosticResult = result?.replace(/\\|\//g, '/');
 
     // This is an absolute path, so we need to use `toContain()`
     expect(platformAgnosticResult).toContain('test/__snapshots__/foo.storyshot');

diff --git a/code/addons/storyshots-core/src/Stories2SnapsConverter.ts b/code/addons/storyshots-core/src/Stories2SnapsConverter.ts
@@ -55,7 +55,7 @@ export class Stories2SnapsConverter {
               }
         `
       );
-      return null;
+      return undefined;
     }
 
     return this.getStoryshotFile(fileName);

diff --git a/code/addons/storyshots-core/src/api/StoryshotsOptions.ts b/code/addons/storyshots-core/src/api/StoryshotsOptions.ts
@@ -9,7 +9,7 @@ export interface TestMethodOptions {
   renderTree: RenderTree;
   renderShallowTree: RenderTree;
   stories2snapsConverter: Stories2SnapsConverter;
-  snapshotFileName: string;
+  snapshotFileName?: string;
   options: any;
   done?: () => void;
 }

diff --git a/code/addons/storyshots-core/src/api/index.ts b/code/addons/storyshots-core/src/api/index.ts
@@ -54,7 +54,7 @@ function testStorySnapshots(options: StoryshotsOptions = {}) {
   // subsequent calls to `it()` etc will all happen within this tick, which is required
   // by Jest (cannot add tests asynchronously)
   globalWindow.__STORYBOOK_STORY_STORE__.initializationPromise.then(() => {
-    const data = storybook.raw().reduce(
+    const data = storybook.raw()?.reduce(
       (acc, item) => {
         if (storyNameRegex && !item.name.match(storyNameRegex)) {
           return acc;
@@ -86,7 +86,7 @@ function testStorySnapshots(options: StoryshotsOptions = {}) {
       }[]
     );
 
-    if (data.length) {
+    if (data && data.length) {
       callTestMethodGlobals(testMethod);
 
       snapshotsTests({

diff --git a/code/addons/storyshots-core/src/frameworks/configure.ts b/code/addons/storyshots-core/src/frameworks/configure.ts
@@ -74,7 +74,7 @@ function getConfigPathParts(input: string): Output {
 
         return specifier;
       });
-      output.requireContexts = output.stories.map((specifier) => {
+      output.requireContexts = output.stories?.map((specifier) => {
         const { path: basePath, recursive, match } = toRequireContext(specifier);
 
         // eslint-disable-next-line no-underscore-dangle

diff --git a/code/addons/storyshots-core/src/frameworks/frameworkLoader.ts b/code/addons/storyshots-core/src/frameworks/frameworkLoader.ts
@@ -28,7 +28,7 @@ function getLoaders(): Loader[] {
       return null;
     })
     .filter(Boolean)
-    .map((loader) => require(loader).default);
+    .map((loader) => loader && require(loader).default);
 }
 
 function loadFramework(options: StoryshotsOptions) {

diff --git a/code/addons/storyshots-core/tsconfig.json b/code/addons/storyshots-core/tsconfig.json
@@ -5,7 +5,7 @@
     "jsx": "preserve",
     "skipLibCheck": true,
     "skipDefaultLibCheck": true,
-    "strict": false
+    "strict": true
   },
   "include": ["src/**/*.ts"]
 }
diff --git a/code/frameworks/angular/src/client/angular-beta/StorybookModule.ts b/code/frameworks/angular/src/client/angular-beta/StorybookModule.ts
@@ -12,7 +12,7 @@ export const getApplication = ({
   storyFnAngular: StoryFnAngularReturnType;
   component?: any;
   targetSelector: string;
-  analyzedMetadata: PropertyExtractor;
+  analyzedMetadata?: PropertyExtractor;
 }) => {
   const { props, styles, moduleMetadata = {} } = storyFnAngular;
   let { template } = storyFnAngular;