fail when an example doesn't set doc-scrape-examples (#12964)

mockersf · web-flow · commit 62f2a73cac70 · 2024-04-14T20:07:55.000Z
# Objective

- Ensure that all examples are scrapped for doc

## Solution

- Panic in the example tool when an example doesn't specify
`doc-scrape-examples`
- If an example must not be scrapped, it can set the value to false
diff --git a/tools/build-templated-pages/src/examples.rs b/tools/build-templated-pages/src/examples.rs
@@ -58,6 +58,9 @@ fn parse_examples(panic_on_missing: bool) -> Vec<Example> {
             if panic_on_missing && metadatas.get(&technical_name).is_none() {
                 panic!("Missing metadata for example {technical_name}");
             }
+            if panic_on_missing && val.get("doc-scrape-examples").is_none() {
+                panic!("Example {technical_name} is missing doc-scrape-examples");
+            }
 
             if metadatas
                 .get(&technical_name)

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,9 @@ fn parse_examples(panic_on_missing: bool) -> Vec<Example> {`
`58`	`58`	`if panic_on_missing && metadatas.get(&technical_name).is_none() {`
`59`	`59`	`panic!("Missing metadata for example {technical_name}");`
`60`	`60`	`}`
	`61`	`+ if panic_on_missing && val.get("doc-scrape-examples").is_none() {`
	`62`	`+ panic!("Example {technical_name} is missing doc-scrape-examples");`
	`63`	`+ }`
`61`	`64`
`62`	`65`	`if metadatas`
`63`	`66`	`.get(&technical_name)`