Autogenerate JSON Schema and Documentation
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- php, typescript
- Domain
- documentation, tooling
Research direction
Start by comparing the TypeScript generator in packages/playground/blueprints/bin/generate-schema.js with the checked-in public/blueprint-schema.json linked in the issue, then inspect the PHP blueprint source and its step argument definitions. Define how PHP arguments should be represented before implementing generation; done means the PHP schema and documentation are generated from the code and remain up to date.
Written by the indexing model from the issue text.
Description
Typescript Blueprints shipped a JSON Schema and documentation generated from the TypeScript source:
The PHP version could do the same to ensure the schema and the documentation are always up to date with the code. This may require taking specific design choices, such as shipping steps arguments as classes:
class WriteFileStepArgs implements StepArgs {
public $file;
public string $toPath;
/**
* @param $file
* @param string $toPath
*/
public function __construct( $file, string $toPath ) {
$this->file = $file;
$this->toPath = $toPath;
}
}
- Dominant language
- PHP
- Stars
- 61
- Forks
- 21
- Avg merge
- 19h 34m
- Merged PRs (30d)
- 7
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from WordPress/php-toolkit
-
Difficulty 5/5 Over a week Newbie friendliness 35/100
WordPress/php-toolkit#313 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 58/100
WordPress/php-toolkit#306 ·
-
WPCS compliance Open
Difficulty 4/5 3-5 days Newbie friendliness 35/100
WordPress/php-toolkit#157 · 1 reaction ·
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
WordPress/php-toolkit#138 · 7 comments · 2 reactions ·
-
Blueprints enhancement
WordPress/php-toolkit#132 · 4 comments · 1 assignee ·
All issues in WordPress/php-toolkit
Similar issues
-
status/awaiting_triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
WordPress/plugin-check#1486 ·
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
az-digital/az_quickstart#6019 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
grokability/snipe-it#19688 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 85/100