Skip to content

build: throw error if example is missing a title #15430

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
mmalerba merged 1 commit into from
Mar 11, 2019
Merged

build: throw error if example is missing a title #15430

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
8 changes: 8 additions & 0 deletions tools/example-module/generate-example-module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,11 @@ function collectExampleMetadata(sourceFiles: string[], baseFile: string): Exampl
const exampleMetadata: ExampleMetadata[] = [];

for (const sourceFile of sourceFiles) {
// Avoid parsing non-example files.
if (!path.basename(sourceFile, path.extname(sourceFile)).endsWith('-example')) {
continue;
}

const sourceContent = fs.readFileSync(sourceFile, 'utf-8');
const {primaryComponent, secondaryComponents} = parseExampleFile(sourceFile, sourceContent);

Expand Down Expand Up @@ -96,6 +101,9 @@ function collectExampleMetadata(sourceFiles: string[], baseFile: string): Exampl
}

exampleMetadata.push(example);
} else {
throw Error(`Could not find a primary example component in ${sourceFile}. ` +
`Ensure that there's a component with an @title annotation.`);
}
}

Expand Down