Skip to content

Commit 86b7a22

Browse files
committed
build: add description for the generate-docs script.
1 parent 1dd016c commit 86b7a22

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

composer.json

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,9 +55,7 @@
5555
],
5656
"list-tokens": "@php ./vendor/bin/phpcs --standard=PHPCSDebug ./test_utils/TestFile.php",
5757
"check-completeness": "@php ./vendor/bin/phpcs-check-feature-completeness ./yCodeTech",
58-
"generate-docs": [
59-
"@php ./vendor/bin/phpcs --sniffs=yCodeTech.Commenting.DocblockFormat,yCodeTech.Commenting.FunctionComment,yCodeTech.Types.DisallowTypeLongNames --generator=markdown > docs.md"
60-
]
58+
"generate-docs": "@php ./vendor/bin/phpcs --sniffs=yCodeTech.Commenting.DocblockFormat,yCodeTech.Commenting.FunctionComment,yCodeTech.Types.DisallowTypeLongNames --generator=markdown > docs.md"
6159
},
6260
"scripts-descriptions": {
6361
"lint": "Run PHP Parallel Lint to check for syntax errors in PHP files.",
@@ -70,6 +68,7 @@
7068
"cs-tests": "Run PHPCS on all sniff unit tests.",
7169
"test-all": "Run @cs-test-file, @cs-tests, and @test in sequence.",
7270
"list-tokens": "List all tokens used in the test file.",
73-
"check-completeness": "Check the completeness of the PHPCS standard."
71+
"check-completeness": "Check the completeness of the PHPCS standard.",
72+
"generate-docs": "Generate markdown documentation for the PHPCS standard."
7473
}
7574
}

0 commit comments

Comments
 (0)