Skip to content

Add verification pass for unresolved React components #1289

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

Open
WilsonGramer wants to merge 1 commit into
base: dev
Choose a base branch
from
+31 −0
Open

Add verification pass for unresolved React components #1289

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
31 changes: 31 additions & 0 deletions src/parser/parser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,14 @@ import {
shouldWarnForDefaultSupabaseConfig,
} from '../utils/defaultStorageConfig';

const modules = import.meta.glob(
[
'../public/**/*.{mjs,js,mts,ts,jsx,tsx}',
'!../public/**/*.spec.{mjs,js,mts,ts,jsx,tsx}',
],
{ eager: false }, // the parser only checks if the path exists
);

const ajv1 = new Ajv({ allowUnionTypes: true });
ajv1.addSchema(globalSchema);
const globalValidate = ajv1.getSchema<GlobalConfig>('#/definitions/GlobalConfig')!;
Expand Down Expand Up @@ -311,6 +319,29 @@ function verifyStudyConfig(studyConfig: StudyConfig, importedLibrariesData: Reco
});
});

// Verify that paths to React components exist under the correct base directory
if (studyConfig.baseComponents != null) {

@JackWilb JackWilb Jul 13, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

baseComponents is optional, so this guard skips validation of the required components object whenever a study does not define any base components. A direct React component with a missing path therefore receives no error. Please remove the outer guard and always iterate both collections using studyConfig[key] ?? {}.

for (const key of ['baseComponents', 'components'] as const) {
for (const [name, component] of Object.entries(studyConfig[key] ?? {})) {
if (
'path' in component
&& component.path != null
&& component.type === 'react-component'

@JackWilb JackWilb Jul 13, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This checks the raw component rather than its resolved inherited shape. A child can inherit type: react-component from its base component while overriding path; because component.type is then undefined here, an unresolved override passes validation. Please merge the referenced base component with the child before checking the effective type and path, as the existing sidebar validation does.

&& !(`../public/${component.path}` in modules)
) {
errors.push({
message: 'Unresolved path',
instancePath: `/${key}/${name}/path`,
params: {
action: 'Make sure the React component is in `src/public/`, not `public/`',
},
category: 'undefined-component',
});
}
}
}
}

return { errors, warnings };
}

Expand Down