fix: typescript doc template add fn return type

ccontrols · May 17, 2021 · 145c52f · 145c52f
1 parent 72ab2fe
commit 145c52f
Show file tree

Hide file tree

Showing 33 changed files with 36 additions and 38 deletions.
diff --git a/examples/stories/src/stories/VariantButton/VariantButton.data.ts b/examples/stories/src/stories/VariantButton/VariantButton.data.ts
@@ -1,5 +1,4 @@
-import { VariantButtonProps } from './VariantButton';
-const data: Record<string, Record<string, VariantButtonProps>> = {
+export default {
   overview: {
     '1': {
       text: 'Cecelia Langosh',
@@ -39,4 +38,3 @@ const data: Record<string, Record<string, VariantButtonProps>> = {
     },
   },
 };
-export default data;
diff --git a/examples/stories/src/stories/VariantButton/VariantButton.test.ts b/examples/stories/src/stories/VariantButton/VariantButton.test.ts
@@ -23,7 +23,7 @@ describe('VariantButton', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/plugins/cc-cli/templates/document/loop/imports-enzyme-react-17.js b/plugins/cc-cli/templates/document/loop/imports-enzyme-react-17.js
@@ -2,7 +2,7 @@ const renderedExamples = renderDocument(examples, config{{? it.data }}, data{{?}
 renderedExamples.forEach(({ name, rendered {{? it.data }}, dataId, values{{?}}}) => {
   describe(name, () => {
     {{? it.data }}
-      const runTests = () => {
+      const runTests = (){{? it.format === 'ts' }}: void{{?}} => {
     {{?}}
       it('snapshot', () => {
         const component = mount(rendered);

diff --git a/plugins/cc-cli/templates/document/loop/imports-react-test-renderer.js b/plugins/cc-cli/templates/document/loop/imports-react-test-renderer.js
@@ -9,7 +9,7 @@ if (!renderedExamples.length) {
 renderedExamples.forEach(({ name, rendered{{? it.data }}, dataId, values{{?}}}) => {
   describe(name, () => {
     {{? it.data }}
-      const runTests = () => {
+      const runTests = (){{? it.format === 'ts' }}: void{{?}} => {
     {{?}}
 
       it('snapshot', () => {

diff --git a/plugins/cc-cli/templates/document/loop/imports-react-testing-library.js b/plugins/cc-cli/templates/document/loop/imports-react-testing-library.js
@@ -9,7 +9,7 @@ if (!renderedExamples) {
 renderedExamples.forEach(({ name, rendered{{? it.data }}, dataId, values{{?}}}) => {
   describe(name, () => {
     {{? it.data }}
-      const runTests = () => {
+      const runTests = (){{? it.format === 'ts' }}: void{{?}} => {
     {{?}}
 
       it('snapshot', () => {

diff --git a/plugins/cc-cli/test/__snapshots__/cli-document-data.test.ts.snap b/plugins/cc-cli/test/__snapshots__/cli-document-data.test.ts.snap
@@ -55,7 +55,7 @@ describe('Popover', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();
@@ -150,7 +150,7 @@ describe('VariantButton', () => {
   const renderedExamples = renderDocument(examples, config, data);
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const component = mount(rendered);
           expect(toJson(component, { mode: 'deep' })).toMatchSnapshot();
@@ -248,7 +248,7 @@ describe('VariantButton', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const component = renderer.create(rendered);
           if (!component) {
@@ -301,7 +301,7 @@ describe('VariantButton', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/plugins/cc-cli/test/__snapshots__/document-enzyme-ts-data.test.ts.snap b/plugins/cc-cli/test/__snapshots__/document-enzyme-ts-data.test.ts.snap
@@ -22,7 +22,7 @@ describe('VariantButton', () => {
   const renderedExamples = renderDocument(examples, config, data);
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const component = mount(rendered);
           expect(toJson(component, { mode: 'deep' })).toMatchSnapshot();

diff --git a/plugins/cc-cli/test/__snapshots__/document-rtl-ts-data.test.ts.snap b/plugins/cc-cli/test/__snapshots__/document-rtl-ts-data.test.ts.snap
@@ -26,7 +26,7 @@ describe('VariantButton', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/plugins/cc-cli/test/__snapshots__/document-rtr-ts-data.test.ts.snap b/plugins/cc-cli/test/__snapshots__/document-rtr-ts-data.test.ts.snap
@@ -26,7 +26,7 @@ describe('VariantButton', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const component = renderer.create(rendered);
           if (!component) {

diff --git a/ui/app/src/AppError/AppError.test.ts b/ui/app/src/AppError/AppError.test.ts
@@ -23,7 +23,7 @@ describe('AppError', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/blocks/src/ComponentCommits/ComponentCommits.test.ts b/ui/blocks/src/ComponentCommits/ComponentCommits.test.ts
@@ -23,7 +23,7 @@ describe('ComponentCommits', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/blocks/src/StoryData/StoryData.test.ts b/ui/blocks/src/StoryData/StoryData.test.ts
@@ -23,7 +23,7 @@ describe('StoryData', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/blocks/src/TestsCoverage/TestsCoverage.test.ts b/ui/blocks/src/TestsCoverage/TestsCoverage.test.ts
@@ -23,7 +23,7 @@ describe('TestsCoverage', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/blocks/src/TestsResults/TestsResults.test.ts b/ui/blocks/src/TestsResults/TestsResults.test.ts
@@ -23,7 +23,7 @@ describe('TestsResults', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/ActionBar/ActionBar.test.ts b/ui/components/src/ActionBar/ActionBar.test.ts
@@ -23,7 +23,7 @@ describe('ActionBar', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/BlockContainer/BlockContainer.test.ts b/ui/components/src/BlockContainer/BlockContainer.test.ts
@@ -23,7 +23,7 @@ describe('BlockContainer', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Collapsible/Collapsible.test.ts b/ui/components/src/Collapsible/Collapsible.test.ts
@@ -23,7 +23,7 @@ describe('Collapsible', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Donut/Donut.test.ts b/ui/components/src/Donut/Donut.test.ts
@@ -23,7 +23,7 @@ describe('Donut', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/ExternalLink/ExternalLink.test.ts b/ui/components/src/ExternalLink/ExternalLink.test.ts
@@ -23,7 +23,7 @@ describe('ExternalLink', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/GithubAvatar/GithubAvatar.test.ts b/ui/components/src/GithubAvatar/GithubAvatar.test.ts
@@ -23,7 +23,7 @@ describe('GithubAvatar', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/InfoTip/InfoTip.test.ts b/ui/components/src/InfoTip/InfoTip.test.ts
@@ -23,7 +23,7 @@ describe('InfoTip', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/LinkHeading/LinkHeading.test.ts b/ui/components/src/LinkHeading/LinkHeading.test.ts
@@ -23,7 +23,7 @@ describe('LinkHeading', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Popover/Popover.test.ts b/ui/components/src/Popover/Popover.test.ts
@@ -23,7 +23,7 @@ describe('Popover', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/ProgressIndicator/ProgressIndicator.test.ts b/ui/components/src/ProgressIndicator/ProgressIndicator.test.ts
@@ -23,7 +23,7 @@ describe('ProgressIndicator', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Shield/Shield.test.ts b/ui/components/src/Shield/Shield.test.ts
@@ -23,7 +23,7 @@ describe('Shield', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Sidebar/Sidebar.test.ts b/ui/components/src/Sidebar/Sidebar.test.ts
@@ -23,7 +23,7 @@ describe('Sidebar', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Source/Source.test.ts b/ui/components/src/Source/Source.test.ts
@@ -23,7 +23,7 @@ describe('Source', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Subtitle/Subtitle.test.ts b/ui/components/src/Subtitle/Subtitle.test.ts
@@ -23,7 +23,7 @@ describe('Subtitle', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/SyntaxHighlighter/SyntaxHighlighter.test.ts b/ui/components/src/SyntaxHighlighter/SyntaxHighlighter.test.ts
@@ -23,7 +23,7 @@ describe('SyntaxHighlighter', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Table/Table.test.ts b/ui/components/src/Table/Table.test.ts
@@ -23,7 +23,7 @@ describe('Table', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Tag/Tag.test.ts b/ui/components/src/Tag/Tag.test.ts
@@ -23,7 +23,7 @@ describe('Tag', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/TitledImage/TitledImage.test.ts b/ui/components/src/TitledImage/TitledImage.test.ts
@@ -23,7 +23,7 @@ describe('TitledImage', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();

diff --git a/ui/components/src/Value/Value.test.ts b/ui/components/src/Value/Value.test.ts
@@ -23,7 +23,7 @@ describe('Value', () => {
   }
   renderedExamples.forEach(({ name, rendered, dataId, values }) => {
     describe(name, () => {
-      const runTests = () => {
+      const runTests = (): void => {
         it('snapshot', () => {
           const { asFragment } = render(rendered);
           expect(asFragment()).toMatchSnapshot();