Skip to content

Docs: the parent in the manifest must be only the next level slug #34

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
kraftbj merged 1 commit into from
Feb 20, 2025
Merged

Docs: the parent in the manifest must be only the next level slug #34

Show file tree
Hide file tree
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
66 changes: 53 additions & 13 deletions docs/bin/generate-manifest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
$root . '/bin/README.md',
);

// First pass: collect all slugs
foreach ( $paths as $path_pattern ) {
foreach ( glob( $path_pattern ) as $file ) {
// Skip specified README.md files and all META.md files.
Expand All @@ -34,8 +35,7 @@
}

$slug = basename( $file, '.md' );
// Get relative path from docs directory
$key = str_replace( array( $root . '/', '.md' ), '', $file );
$key = str_replace( array( $root . '/', '.md' ), '', $file );

// Special handling for tutorial files
if ( 'tutorial' === $slug ) {
Expand All @@ -49,11 +49,60 @@
$key = implode( '/', $bits ); // Remove /index from key
}

// Check for slug conflicts
if ( isset( $slug_map[ $slug ] ) ) {
printf( "\nError: Slug conflict detected!\n\n" );
printf( "Original entry:\n%s\n\n", json_encode( array( 'key' => $slug_map[ $slug ] ), JSON_PRETTY_PRINT ) );
printf( "Conflicting entry:\n%s\n\n", json_encode( array( 'key' => $key ), JSON_PRETTY_PRINT ) );
exit( 1 );
}
$slug_map[ $slug ] = $key;
}
}

// Second pass: build manifest with validated parents
foreach ( $paths as $path_pattern ) {
foreach ( glob( $path_pattern ) as $file ) {
if ( in_array( $file, $excludes, true ) || basename( $file ) === 'META.md' ) {
continue;
}

$slug = basename( $file, '.md' );
$key = str_replace( array( $root . '/', '.md' ), '', $file );

// Special handling for tutorial files
if ( 'tutorial' === $slug ) {
$bits = explode( '/', $key );
array_pop( $bits ); // Remove 'tutorial'
$slug = end( $bits ) . '-tutorial';
} elseif ( 'index' === $slug ) {
$bits = explode( '/', $key );
array_pop( $bits );
$slug = end( $bits );
$key = implode( '/', $bits );
}

// Get parent slug (not path)
$parent = null;
if ( stripos( $key, '/' ) ) {
$bits = explode( '/', $key );
array_pop( $bits );
$parent = implode( '/', $bits );
array_pop( $bits ); // Remove current item
$parent_key = implode( '/', $bits );

// Find the parent's slug
foreach ( $slug_map as $potential_parent_slug => $mapped_key ) {
if ( $mapped_key === $parent_key ) {
$parent = $potential_parent_slug;
break;
}
}

// Validate parent exists
if ( ! isset( $slug_map[ $parent ] ) ) {
// phpcs:ignore
printf( "\nError: Parent slug '%s' not found for '%s'\n", $parent, $key );
exit( 1 );
}
}

$manifest[ $key ] = array(
Expand All @@ -66,15 +115,6 @@
basename( $file ) === 'index.md' ? '/index.md' : '.md'
),
);

// Check for slug conflicts
if ( isset( $slug_map[ $slug ] ) ) {
printf( "\nError: Slug conflict detected!\n\n" );
printf( "Original entry:\n%s\n\n", json_encode( $manifest[ $slug_map[ $slug ] ], JSON_PRETTY_PRINT ) );
printf( "Conflicting entry:\n%s\n\n", json_encode( $manifest[ $key ], JSON_PRETTY_PRINT ) );
exit( 1 );
}
$slug_map[ $slug ] = $key;
}
}

Expand Down
96 changes: 48 additions & 48 deletions docs/bin/manifest.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,242 +71,242 @@
},
"features/fields/accordion": {
"slug": "accordion",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/accordion/index.md"
},
"features/fields/accordion/tutorial": {
"slug": "accordion-tutorial",
"parent": "features/fields/accordion",
"parent": "accordion",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/accordion/tutorial.md"
},
"features/fields/button-group": {
"slug": "button-group",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/button-group/index.md"
},
"features/fields/button-group/tutorial": {
"slug": "button-group-tutorial",
"parent": "features/fields/button-group",
"parent": "button-group",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/button-group/tutorial.md"
},
"features/fields/checkbox": {
"slug": "checkbox",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/checkbox/index.md"
},
"features/fields/checkbox/tutorial": {
"slug": "checkbox-tutorial",
"parent": "features/fields/checkbox",
"parent": "checkbox",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/checkbox/tutorial.md"
},
"features/fields/clone": {
"slug": "clone",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/clone/index.md"
},
"features/fields/clone/tutorial": {
"slug": "clone-tutorial",
"parent": "features/fields/clone",
"parent": "clone",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/clone/tutorial.md"
},
"features/fields/color-picker": {
"slug": "color-picker",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/color-picker/index.md"
},
"features/fields/color-picker/tutorial": {
"slug": "color-picker-tutorial",
"parent": "features/fields/color-picker",
"parent": "color-picker",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/color-picker/tutorial.md"
},
"features/fields/date-picker": {
"slug": "date-picker",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-picker/index.md"
},
"features/fields/date-picker/tutorial": {
"slug": "date-picker-tutorial",
"parent": "features/fields/date-picker",
"parent": "date-picker",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-picker/tutorial.md"
},
"features/fields/date-time-picker": {
"slug": "date-time-picker",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-time-picker/index.md"
},
"features/fields/date-time-picker/tutorial": {
"slug": "date-time-picker-tutorial",
"parent": "features/fields/date-time-picker",
"parent": "date-time-picker",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/date-time-picker/tutorial.md"
},
"features/fields/email": {
"slug": "email",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/email/index.md"
},
"features/fields/email/tutorial": {
"slug": "email-tutorial",
"parent": "features/fields/email",
"parent": "email",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/email/tutorial.md"
},
"features/fields/file": {
"slug": "file",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/file/index.md"
},
"features/fields/file/tutorial": {
"slug": "file-tutorial",
"parent": "features/fields/file",
"parent": "file",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/file/tutorial.md"
},
"features/fields/flexible-content": {
"slug": "flexible-content",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/flexible-content/index.md"
},
"features/fields/flexible-content/tutorial": {
"slug": "flexible-content-tutorial",
"parent": "features/fields/flexible-content",
"parent": "flexible-content",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/flexible-content/tutorial.md"
},
"features/fields/gallery": {
"slug": "gallery",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/gallery/index.md"
},
"features/fields/gallery/tutorial": {
"slug": "gallery-tutorial",
"parent": "features/fields/gallery",
"parent": "gallery",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/gallery/tutorial.md"
},
"features/fields/google-map": {
"slug": "google-map",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/google-map/index.md"
},
"features/fields/google-map/tutorial": {
"slug": "google-map-tutorial",
"parent": "features/fields/google-map",
"parent": "google-map",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/google-map/tutorial.md"
},
"features/fields/group": {
"slug": "group",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/group/index.md"
},
"features/fields/group/tutorial": {
"slug": "group-tutorial",
"parent": "features/fields/group",
"parent": "group",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/group/tutorial.md"
},
"features/fields/icon-picker": {
"slug": "icon-picker",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/icon-picker/index.md"
},
"features/fields/icon-picker/tutorial": {
"slug": "icon-picker-tutorial",
"parent": "features/fields/icon-picker",
"parent": "icon-picker",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/icon-picker/tutorial.md"
},
"features/fields/image": {
"slug": "image",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/image/index.md"
},
"features/fields/image/tutorial": {
"slug": "image-tutorial",
"parent": "features/fields/image",
"parent": "image",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/image/tutorial.md"
},
"features/fields/link": {
"slug": "link",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/link/index.md"
},
"features/fields/link/tutorial": {
"slug": "link-tutorial",
"parent": "features/fields/link",
"parent": "link",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/link/tutorial.md"
},
"features/fields/message": {
"slug": "message",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/message/index.md"
},
"features/fields/message/tutorial": {
"slug": "message-tutorial",
"parent": "features/fields/message",
"parent": "message",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/message/tutorial.md"
},
"features/fields/number": {
"slug": "number",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/number/index.md"
},
"features/fields/number/tutorial": {
"slug": "number-tutorial",
"parent": "features/fields/number",
"parent": "number",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/number/tutorial.md"
},
"features/fields/oembed": {
"slug": "oembed",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/oembed/index.md"
},
"features/fields/oembed/tutorial": {
"slug": "oembed-tutorial",
"parent": "features/fields/oembed",
"parent": "oembed",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/oembed/tutorial.md"
},
"features/fields/page-link": {
"slug": "page-link",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/page-link/index.md"
},
"features/fields/page-link/tutorial": {
"slug": "page-link-tutorial",
"parent": "features/fields/page-link",
"parent": "page-link",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/page-link/tutorial.md"
},
"features/fields/password": {
"slug": "password",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/password/index.md"
},
"features/fields/password/tutorial": {
"slug": "password-tutorial",
"parent": "features/fields/password",
"parent": "password",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/password/tutorial.md"
},
"features/fields/post-object": {
"slug": "post-object",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/post-object/index.md"
},
"features/fields/post-object/tutorial": {
"slug": "post-object-tutorial",
"parent": "features/fields/post-object",
"parent": "post-object",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/post-object/tutorial.md"
},
"features/fields/radio": {
"slug": "radio",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/radio/index.md"
},
"features/fields/radio/tutorial": {
"slug": "radio-tutorial",
"parent": "features/fields/radio",
"parent": "radio",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/radio/tutorial.md"
},
"features/fields/range": {
"slug": "range",
"parent": "features/fields",
"parent": "fields",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/range/index.md"
},
"features/fields/range/tutorial": {
"slug": "range-tutorial",
"parent": "features/fields/range",
"parent": "range",
"markdown_source": "https://github.com/wordpress/secure-custom-fields/blob/trunk/docs/features/fields/range/tutorial.md"
}
}