[Blueprints] Type nested Blueprint v2 inline directories - #3861
Merged
Conversation
adamziel
force-pushed
the
add/blueprint-v2-nested-inline-directories
branch
from
July 2, 2026 09:34
7bab99b to
520ed0a
Compare
adamziel
marked this pull request as ready for review
July 2, 2026 09:34
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
Updates Blueprint v2 inline-directory TypeScript types so nested directories derive their name from the parent files key (instead of repeating directoryName), aligning the declaration with the documented data shape.
Changes:
- Introduces
NestedInlineDirectoryand updatesInlineDirectory.filesto use it for nested directories. - Adds declaration tests covering deep nested inline directories and rejecting
directoryNameon nested directories.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| packages/playground/blueprints/src/lib/v2/wep-1-blueprint-v2-schema/appendix-B-data-sources.ts | Refines inline directory typing by splitting top-level vs nested directory shapes. |
| packages/playground/blueprints/src/tests/v2/blueprint-v2-declaration.spec.ts | Adds type-level coverage for nested inline directory acceptance and nested directoryName rejection. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
75
to
87
| export type InlineDirectory = { | ||
| directoryName: string; | ||
| files: Record<string, InlineFileContent | InlineDirectory>; | ||
| files: Record<string, InlineFileContent | NestedInlineDirectory>; | ||
| }; | ||
|
|
||
| /** | ||
| * A child directory inside an inline directory. | ||
| * | ||
| * Its directory name comes from the parent `files` record key. | ||
| */ | ||
| export type NestedInlineDirectory = { | ||
| files: Record<string, InlineFileContent | NestedInlineDirectory>; | ||
| }; |
| export type InlineDirectory = { | ||
| directoryName: string; | ||
| files: Record<string, InlineFileContent | InlineDirectory>; | ||
| files: Record<string, InlineFileContent | NestedInlineDirectory>; |
| * Its directory name comes from the parent `files` record key. | ||
| */ | ||
| export type NestedInlineDirectory = { | ||
| files: Record<string, InlineFileContent | NestedInlineDirectory>; |
Comment on lines
+57
to
+84
| it('accepts inline directories with nested child directories', () => { | ||
| const blueprint = { | ||
| version: 2, | ||
| additionalStepsAfterExecution: [ | ||
| { | ||
| step: 'writeFiles', | ||
| files: { | ||
| '/wordpress/wp-content/uploads': { | ||
| directoryName: 'uploads', | ||
| files: { | ||
| '2026': { | ||
| files: { | ||
| '07': { | ||
| files: { | ||
| 'image.txt': 'image', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| ], | ||
| } satisfies BlueprintV2Declaration; | ||
|
|
||
| expect(blueprint.version).toBe(2); | ||
| }); |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Updates the Blueprint v2 inline directory types so only the top-level inline directory needs
directoryName.Nested directories now use a new
NestedInlineDirectorytype whose name comes from the parentfilesrecord key:Why?
The existing type required nested directories to repeat
directoryName, even though the inline-directory example already models child directory names as object keys. This makes the TypeScript declaration match the documented shape.This is type-only. It does not change runtime behavior.
Testing
npm exec nx run playground-blueprints:typechecknpm exec nx run playground-blueprints:lintnpm exec nx run playground-blueprints:test:vite -- --testFiles=packages/playground/blueprints/src/tests/v2/blueprint-v2-declaration.spec.tsgit diff --checkPart of #2592.