Skip to content
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.

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

Update writeFiles documentation #2134

Open
bph opened this issue Jan 29, 2025 · 0 comments
Open

Update writeFiles documentation #2134

bph opened this issue Jan 29, 2025 · 0 comments
Assignees
Labels
[Type] Documentation Improvements or additions to documentation

Comments

@bph
Copy link
Collaborator

bph commented Jan 29, 2025

the step is listened under Blueprints > Steps > WriteFiles

https://wordpress.github.io/wordpress-playground/blueprints/steps#WriteFilesStep

filesTree (DirectoryResource) – The data to write
writeToPath (string) – The path of the file to write to

"resource" for filesTree with possible values 'literal:directoryorgit:directory`
"name" - the name of the root directory
"files" - an object where:
Keys are filenames/paths
Values are either: String: content for files
Nested objects for subdirectories

I would also add a representation of the directory structure

my-plugin/
├ index.php
├ public
├─ style.css

@bph bph added the [Type] Documentation Improvements or additions to documentation label Jan 29, 2025
@bph bph self-assigned this Jan 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Documentation Improvements or additions to documentation
Projects
Status: Inbox
Development

No branches or pull requests

1 participant