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

Migrate @storybook/web-components to strict TS #22399

Merged
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/renderers/web-components/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
"@storybook/manager-api": "7.1.0-alpha.26",
"@storybook/preview-api": "7.1.0-alpha.26",
"@storybook/types": "7.1.0-alpha.26",
"tiny-invariant": "^1.3.1",
"ts-dedent": "^2.0.0"
},
"devDependencies": {
Expand Down
5 changes: 3 additions & 2 deletions code/renderers/web-components/src/docs/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,11 @@ import type { Addon_DecoratorFunction, ArgTypesEnhancer } from '@storybook/types
import { SourceType, enhanceArgTypes } from '@storybook/docs-tools';
import { extractArgTypes, extractComponentDescription } from './custom-elements';
import { sourceDecorator } from './sourceDecorator';
import type { StoryFnHtmlReturnType } from '../types';

export const decorators: Addon_DecoratorFunction<unknown>[] = [sourceDecorator];
export const decorators: Addon_DecoratorFunction<StoryFnHtmlReturnType>[] = [sourceDecorator];

export const parameters: {} = {
export const parameters: object = {
docs: {
extractArgTypes,
extractComponentDescription,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
/* eslint-disable no-underscore-dangle */
import { global } from '@storybook/global';

import { extractArgTypes } from './custom-elements';
import customElementsManifest from './__testfixtures__/custom-elements.json';

Expand All @@ -17,19 +16,19 @@ describe('extractArgTypes', () => {

describe('events', () => {
it('should map to an action event handler', () => {
const { onSbHeaderCreateAccount } = extractArgTypes('sb-header');
const extractedArgType = extractArgTypes('sb-header');

expect(onSbHeaderCreateAccount).toEqual({
expect(extractedArgType?.onSbHeaderCreateAccount).toEqual({
name: 'onSbHeaderCreateAccount',
action: { name: 'sb-header:createAccount' },
table: { disable: true },
});
});

it('should map to a regular item', () => {
const { 'sb-header:createAccount': item } = extractArgTypes('sb-header');
const extractedArgType = extractArgTypes('sb-header');

expect(item).toEqual({
expect(extractedArgType?.['sb-header:createAccount']).toEqual({
name: 'sb-header:createAccount',
required: false,
description: 'Event send when user clicks on create account button',
Expand Down
16 changes: 9 additions & 7 deletions code/renderers/web-components/src/docs/custom-elements.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import invariant from 'tiny-invariant';
import type { InputType, ArgTypes } from '@storybook/types';
import { logger } from '@storybook/client-logger';
import { getCustomElements, isValidComponent, isValidMetaData } from '..';
Expand Down Expand Up @@ -80,6 +81,7 @@ function mapData(data: TagItem[], category: string) {
switch (category) {
case 'events':
mapEvent(item).forEach((argType) => {
invariant(argType.name, `${argType} should have a name property.`);
acc[argType.name] = argType;
});
break;
Expand Down Expand Up @@ -137,13 +139,13 @@ export const extractArgTypesFromElements = (tagName: string, customElements: Cus
const metaData = getMetaData(tagName, customElements);
return (
metaData && {
...mapData(metaData.attributes, 'attributes'),
...mapData(metaData.members, 'properties'),
...mapData(metaData.properties, 'properties'),
...mapData(metaData.events, 'events'),
...mapData(metaData.slots, 'slots'),
...mapData(metaData.cssProperties, 'css custom properties'),
...mapData(metaData.cssParts, 'css shadow parts'),
...mapData(metaData.attributes ?? [], 'attributes'),
...mapData(metaData.members ?? [], 'properties'),
...mapData(metaData.properties ?? [], 'properties'),
...mapData(metaData.events ?? [], 'events'),
...mapData(metaData.slots ?? [], 'slots'),
...mapData(metaData.cssProperties ?? [], 'css custom properties'),
...mapData(metaData.cssParts ?? [], 'css shadow parts'),
}
);
};
Expand Down
2 changes: 1 addition & 1 deletion code/renderers/web-components/src/render.ts
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export function renderToCanvas(
if (forceRemount || !canvasElement.querySelector('[id="root-inner"]')) {
canvasElement.innerHTML = '<div id="root-inner"></div>';
}
const renderTo = canvasElement.querySelector<HTMLElement>('[id="root-inner"]');
const renderTo = canvasElement.querySelector<HTMLElement>('[id="root-inner"]') as HTMLElement;

litRender(element, renderTo);
simulatePageLoad(canvasElement);
Expand Down
2 changes: 1 addition & 1 deletion code/renderers/web-components/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"extends": "../../tsconfig.json",
"compilerOptions": {
"resolveJsonModule": true,
"strict": false
"strict": true
},
"include": ["src/**/*", "template/**/*"]
}
1 change: 1 addition & 0 deletions code/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -7876,6 +7876,7 @@ __metadata:
"@types/node": ^16.0.0
cross-spawn: ^7.0.3
lit: 2.3.1
tiny-invariant: ^1.3.1
ts-dedent: ^2.0.0
typescript: ~4.9.3
web-component-analyzer: ^1.1.6
Expand Down