diff --git a/.betterer.results b/.betterer.results index edea426c911..7a540911772 100644 --- a/.betterer.results +++ b/.betterer.results @@ -4459,110 +4459,3 @@ exports[`better eslint`] = { ] }` }; - -exports[`no undocumented stories`] = { - value: `{ - "packages/grafana-ui/src/components/ButtonCascader/ButtonCascader.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/CallToActionCard/CallToActionCard.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/ColorPicker/ColorPickerInput.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/ColorPicker/SeriesColorPicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/DateTimePickers/RelativeTimeRangePicker/RelativeTimeRangePicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/DateTimePickers/TimeOfDayPicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/DateTimePickers/TimeRangePicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/DateTimePickers/TimeZonePicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/DateTimePickers/WeekStartPicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/Dropdown/ButtonSelect.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/FormField/FormField.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/InfoTooltip/InfoTooltip.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/List/List.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/PageLayout/PageToolbar.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/QueryField/QueryField.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/SecretFormField/SecretFormField.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/SecretTextArea/SecretTextArea.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/Segment/Segment.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/Segment/SegmentAsync.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/Segment/SegmentInput.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/Select/SelectPerf.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/Slider/RangeSlider.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/Slider/Slider.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/StatsPicker/StatsPicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/TableInputCSV/TableInputCSV.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/ThemeDemos/BorderRadius.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/ThemeDemos/EmotionPerfTest.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/ThemeDemos/ThemeDemo.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/ThemeDemos/Typography.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/UnitPicker/UnitPicker.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/VizLayout/VizLayout.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/VizLegend/VizLegend.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/components/VizTooltip/SeriesTable.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ], - "packages/grafana-ui/src/utils/useDelayedSwitch.story.tsx:5381": [ - [0, 0, 0, "No undocumented stories are allowed, please add an .mdx file with some documentation", "5381"] - ] - }` -}; diff --git a/.betterer.ts b/.betterer.ts index 0e3521e9c97..c57c9cec6f9 100644 --- a/.betterer.ts +++ b/.betterer.ts @@ -1,6 +1,5 @@ import { BettererFileTest } from '@betterer/betterer'; import { ESLint } from 'eslint'; -import { promises as fs } from 'fs'; // Why are we ignoring these? // They're all deprecated/being removed so doesn't make sense to fix types @@ -17,34 +16,8 @@ export default { countEslintErrors() .include('**/*.{ts,tsx}') .exclude(new RegExp(eslintPathsToIgnore.join('|'))), - 'no undocumented stories': () => countUndocumentedStories().include('**/*.story.tsx'), }; -function countUndocumentedStories() { - return new BettererFileTest(async (filePaths, fileTestResult) => { - await Promise.all( - filePaths.map(async (filePath) => { - // look for .mdx import in the story file - const mdxImportRegex = new RegExp("^import.*\\.mdx';$", 'gm'); - // Looks for the "autodocs" string in the file - const autodocsStringRegex = /autodocs/; - - const fileText = await fs.readFile(filePath, 'utf8'); - - const hasMdxImport = mdxImportRegex.test(fileText); - const hasAutodocsString = autodocsStringRegex.test(fileText); - // If both .mdx import and autodocs string are missing, add an issue - if (!hasMdxImport && !hasAutodocsString) { - // In this case the file contents don't matter: - const file = fileTestResult.addFile(filePath, ''); - // Add the issue to the first character of the file: - file.addIssue(0, 0, 'No undocumented stories are allowed, please add an .mdx file with some documentation'); - } - }) - ); - }); -} - function countEslintErrors() { return new BettererFileTest(async (filePaths, fileTestResult) => { // Just bail early if there's no files to test. Prevents trying to get the base config from failing diff --git a/packages/grafana-ui/src/components/Card/Card.story.tsx b/packages/grafana-ui/src/components/Card/Card.story.tsx index df9f978c531..b1b4807f92d 100644 --- a/packages/grafana-ui/src/components/Card/Card.story.tsx +++ b/packages/grafana-ui/src/components/Card/Card.story.tsx @@ -12,7 +12,6 @@ const logo = 'https://grafana.com/static/assets/img/apple-touch-icon.png'; const meta: Meta = { title: 'Layout/Card', component: Card, - tags: ['autodocs'], parameters: { controls: { exclude: ['onClick', 'href', 'heading', 'description', 'className', 'noMargin'],