Skip to content

Core: Fix error thrown if docs.defaultName is unset #23893

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.

Sign up for GitHub

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

Merged
JReinhold merged 3 commits into from
Aug 21, 2023
Merged

Core: Fix error thrown if docs.defaultName is unset #23893

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85ed45f
Core: Fix regression caused by defaultName invariant
stilt0n Aug 19, 2023
344859c
Merge branch 'next' into fix-invariant-bug
stilt0n Aug 19, 2023
8cd2f0b
Merge branch 'next' into fix-invariant-bug
JReinhold Aug 21, 2023
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
9 changes: 3 additions & 6 deletions code/lib/core-server/src/utils/StoryIndexGenerator.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -338,8 +338,7 @@ export class StoryIndexGenerator {
autodocs === true || (autodocs === 'tag' && hasAutodocsTag) || isStoriesMdx;

if (createDocEntry) {
const name = this.options.docs.defaultName;
invariant(name, 'expected a defaultName property in options.docs');
const name = this.options.docs.defaultName ?? 'Docs';
const { metaId } = indexInputs[0];
const { title } = entries[0];
const tags = indexInputs[0].tags || [];
Expand Down Expand Up @@ -407,8 +406,7 @@ export class StoryIndexGenerator {
// a) it is a stories.mdx transpiled to CSF, OR
// b) we have docs page enabled for this file
if (componentTags.includes(STORIES_MDX_TAG) || autodocsOptedIn) {
const name = this.options.docs.defaultName;
invariant(name, 'expected a defaultName property in options.docs');
const name = this.options.docs.defaultName ?? 'Docs';
invariant(csf.meta.title, 'expected a title property in csf.meta');
const id = toId(csf.meta.id || csf.meta.title, name);
entries.unshift({
Expand Down Expand Up @@ -511,8 +509,7 @@ export class StoryIndexGenerator {
title,
"makeTitle created an undefined title. This happens when a specifier's doesn't have any matches in its fileName"
);
const { defaultName } = this.options.docs;
invariant(defaultName, 'expected a defaultName property in options.docs');
const defaultName = this.options.docs.defaultName ?? 'Docs';

const name =
result.name ||
Expand Down