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

[TASK] [BACKPORT] Create full command-json list using dependency #4772

Merged
merged 4 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
*.bak
*.idea
.Build/*
config/
*.project
*.swp
*NOT_VERSIONED*
Expand Down
7 changes: 3 additions & 4 deletions Documentation/ApiOverview/CommandControllers/ListCommands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@
List of TYPO3 console commands
==============================

.. todo: List all common commands once https://forge.typo3.org/issues/103858 is resolved

By default TYPO3 ships the listed console commands, depending
on which system extensions are installed.

Expand All @@ -28,7 +26,8 @@ on legacy installations:
List all TYPO3 console commands
===============================

.. console:command:: list
.. console:command-list::
:caption: vendor/bin/typo3 <command> | typo3/sysext/core/bin/typo3 <command> | ddev typo3 <command>
:json: commands.json
:script: vendor/bin/typo3
:exclude-option: help, quiet, verbose, version, ansi, no-ansi, no-interaction
:exclude-namespace: clinspector, codesnippet, examples, styleguide
4,644 changes: 4,643 additions & 1 deletion Documentation/ApiOverview/CommandControllers/commands.json

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,20 @@ test-docs: ## Test the documentation rendering
docker run --rm --pull always -v "$(shell pwd)":/project -t ghcr.io/typo3-documentation/render-guides:latest --config=Documentation --no-progress --fail-on-log

.PHONY: generate
generate: codesnippets command-json ## Regenerate automatic code documentation
generate: setup-typo3 codesnippets command-json ## Regenerate automatic code documentation

.PHONY: codesnippets
codesnippets: ## Regenerate code snippets
ddev exec .Build/bin/typo3 codesnippet:create Documentation/

.PHONY: setup-typo3
setup-typo3: ## Setup TYPO3 stub
ddev exec '.Build/bin/typo3 setup --driver=sqlite --username=db --password=db --admin-username=john-doe --admin-user-password="John-Doe-1701D." --admin-email="[email protected]" --project-name="TYPO3 Docs" --no-interaction --server-type=apache --force'

.PHONY: command-json
command-json: ## Regenerate JSON file containing all console commands
ddev exec .Build/bin/typo3 list --format=json > Documentation/ApiOverview/CommandControllers/commands.json
ddev exec .Build/bin/typo3 clinspector:gadget > Documentation/ApiOverview/CommandControllers/commands.json
echo "" >> Documentation/ApiOverview/CommandControllers/commands.json

.PHONY: test-lint
test-lint: ## Regenerate code snippets
Expand Down
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
"require-dev": {
"ergebnis/composer-normalize": "~2.41.0",
"friendsofphp/php-cs-fixer": "^3.51",
"garvinhicking/clinspector-gadget": "^0.1.2",
"symfony/yaml": "^6.4",
"t3docs/blog-example": "^12.0",
"t3docs/codesnippet": "dev-main",
Expand Down
Loading