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.

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

Build: Migrate @storybook/addon-jest to strict TS #22389

Merged
merged 6 commits into from
May 31, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions code/addons/jest/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@
"@storybook/preview-api": "7.1.0-alpha.25",
"@storybook/theming": "7.1.0-alpha.25",
"react-resize-detector": "^7.1.2",
"tiny-invariant": "^1.3.1",
"upath": "^1.2.0"
},
"devDependencies": {
Expand Down
6 changes: 3 additions & 3 deletions code/addons/jest/src/components/Message.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ const titleEndToken = ':';
type MsgElement = string | JSX.Element;

class TestDetail {
description: MsgElement[];
description!: MsgElement[];

result: MsgElement[];
result!: MsgElement[];

stackTrace: string;
stackTrace!: string;
}
const StackTrace = styled.pre(({ theme }) => ({
background: theme.color.lighter,
Expand Down
12 changes: 6 additions & 6 deletions code/addons/jest/src/components/Panel.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ const SuiteTotals = styled(UnstyledSuiteTotals)(({ theme }) => ({
},
}));

const SuiteProgressPortion = styled.div<{ color: any; progressPercent: number }>(
const SuiteProgressPortion = styled.div<{ color?: string; progressPercent: number }>(
({ color, progressPercent }) => ({
height: 6,
top: 3,
Expand Down Expand Up @@ -114,7 +114,7 @@ const getColorByType = (type: string) => {
case StatusTypes.TODO_TYPE:
return convert(themes.light).color.purple;
default:
return null;
return undefined;
}
};

Expand All @@ -132,8 +132,8 @@ const TestPanel: FC<{ test: Test }> = ({ test }) => {
return (
<section ref={ref}>
<SuiteHead>
<SuiteTotals {...{ result, width }} />
{width > 240 ? (
<SuiteTotals {...{ result, width: width ?? 0 }} />
{width != null && width > 240 ? (
<ProgressWrapper>
{sortedTestsByCount.map((entry: any) => {
return (
Expand Down Expand Up @@ -261,7 +261,7 @@ const Content = styled(({ tests, className }: ContentProps) => (
});

interface PanelProps {
tests: null | Test[];
tests?: Test[];
}

const Panel = ({ tests }: PanelProps) => (
Expand All @@ -287,7 +287,7 @@ const Panel = ({ tests }: PanelProps) => (
);

Panel.defaultProps = {
tests: null,
tests: undefined,
};

export default provideJestResult(Panel);
7 changes: 4 additions & 3 deletions code/addons/jest/src/components/Result.tsx
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
import React, { Fragment, useState } from 'react';
import { styled, themes, convert } from '@storybook/theming';
import { Icons } from '@storybook/components';
// eslint-disable-next-line import/no-named-as-default
import Message from './Message';

const Wrapper = styled.div<{ status: string }>(({ theme, status }) => ({
display: 'flex',
width: '100%',
borderTop: `1px solid ${theme.appBorderColor}`,
'&:hover': {
background: status === `failed` ? theme.background.hoverable : null,
background: status === `failed` ? theme.background.hoverable : undefined,
},
}));

Expand All @@ -18,7 +19,7 @@ const HeaderBar = styled.div<{ status: string }>(({ theme, status }) => ({
background: 'none',
color: 'inherit',
textAlign: 'left',
cursor: status === `failed` ? 'pointer' : null,
cursor: status === `failed` ? 'pointer' : undefined,
borderLeft: '3px solid transparent',
width: '100%',
display: 'flex',
Expand Down Expand Up @@ -72,7 +73,7 @@ export function Result(props: ResultProps) {
}}
/>
) : null}
<div>{capitalizeFirstLetter(fullName) || capitalizeFirstLetter(title)}</div>
<div>{capitalizeFirstLetter(fullName ?? '') || capitalizeFirstLetter(title ?? '')}</div>
</HeaderBar>
</Wrapper>
{isOpen ? (
Expand Down
4 changes: 2 additions & 2 deletions code/addons/jest/src/hoc/provideJestResult.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,9 @@ export const provideTests = (Component: ComponentType<InjectedProps>) =>
this.setState({ kind, storyName, tests });
};

mounted: boolean;
mounted!: boolean;

stopListeningOnStory: () => void;
stopListeningOnStory!: () => void;

render() {
const { active } = this.props;
Expand Down
5 changes: 4 additions & 1 deletion code/addons/jest/src/shared.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import invariant from 'tiny-invariant';
import type { StorybookInternalParameters } from '@storybook/types';

// addons, panels and events get unique names using a prefix
Expand All @@ -23,7 +24,9 @@ export function defineJestParameter(parameters: AddonParameters): string[] | nul
}

if (jest === undefined && typeof filePath === 'string') {
const fileName = filePath.split('/').pop().split('.')[0];
const lastPath = filePath.split('/').pop();
invariant(lastPath != null, 'split should always return at least one value');
const fileName = lastPath.split('.')[0];
return [fileName];
}

Expand Down
2 changes: 1 addition & 1 deletion code/addons/jest/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": "../../tsconfig.json",
"compilerOptions": {
"strict": false
"strict": true
},
"include": ["src/**/*"]
}
1 change: 1 addition & 0 deletions code/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -5492,6 +5492,7 @@ __metadata:
"@storybook/preview-api": 7.1.0-alpha.25
"@storybook/theming": 7.1.0-alpha.25
react-resize-detector: ^7.1.2
tiny-invariant: ^1.3.1
typescript: ~4.9.3
upath: ^1.2.0
peerDependencies:
Expand Down