Skip to content

[Blueprints] Type nested Blueprint v2 inline directories - #3861

Merged
adamziel merged 1 commit into
trunkfrom
add/blueprint-v2-nested-inline-directories
Jul 2, 2026
Merged

[Blueprints] Type nested Blueprint v2 inline directories#3861
adamziel merged 1 commit into
trunkfrom
add/blueprint-v2-nested-inline-directories

Conversation

@adamziel

@adamziel adamziel commented Jul 2, 2026

Copy link
Copy Markdown
Collaborator

What?

Updates the Blueprint v2 inline directory types so only the top-level inline directory needs directoryName.

Nested directories now use a new NestedInlineDirectory type whose name comes from the parent files record key:

{
  directoryName: 'uploads',
  files: {
    '2026': {
      files: {
        'image.txt': 'image'
      }
    }
  }
}

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:typecheck
  • npm exec nx run playground-blueprints:lint
  • npm exec nx run playground-blueprints:test:vite -- --testFiles=packages/playground/blueprints/src/tests/v2/blueprint-v2-declaration.spec.ts
  • git diff --check

Part of #2592.

@adamziel
adamziel force-pushed the add/blueprint-v2-nested-inline-directories branch from 7bab99b to 520ed0a Compare July 2, 2026 09:34
@adamziel
adamziel marked this pull request as ready for review July 2, 2026 09:34
@adamziel
adamziel requested review from a team, bgrgicak and Copilot July 2, 2026 09:34

Copilot AI left a comment

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.

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 NestedInlineDirectory and updates InlineDirectory.files to use it for nested directories.
  • Adds declaration tests covering deep nested inline directories and rejecting directoryName on 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);
});
@adamziel
adamziel merged commit d345f24 into trunk Jul 2, 2026
104 of 105 checks passed
@adamziel
adamziel deleted the add/blueprint-v2-nested-inline-directories branch July 2, 2026 10:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment