Skip to content

Commit b583fe3

Browse files
committed
Updated readme and cleaned up old TODO markers.
1 parent 840da78 commit b583fe3

2 files changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This collection of scripts is intended to provide consistency and shortcuts for
88
* The 2.x branch is meant for projects that use composer (although submodules are still supported).
99
* Most scripts listed below can take a `-h` option as their first argument to output usage information.
1010
* Most are designed to run with few or no arguments; they try to guess sensible defaults whenever possible.
11+
* Most are designed to fail gracefully. For example, if `pear` is available and your project defines a pear config file, then those dependencies will be installed by `deps-install`, otherwise pear will be silently ignored. This provides maximum flexibility without having to customize the scripts per-project.
1112

1213

1314
## Requirements ##
@@ -29,8 +30,8 @@ Additionally, some scripts expect additional tools that should be automatically
2930

3031
* `bin/phpcs`
3132
* `bin/phpunit`
32-
* `bin/phpdoc.php`
33-
* `bin/cake` (composer installed **by target project**)
33+
* `bin/phpdoc`
34+
* `bin/cake` (composer-installed **by target project**)
3435

3536
If these items are not available, some scripts may not function as expected.
3637

@@ -46,7 +47,7 @@ Your project's own `composer.json` file should look something like this:
4647
```json
4748
{
4849
"require": {
49-
"loadsys/cakephp-shell-scripts": "*"
50+
"loadsys/cakephp-shell-scripts": "2.0.*"
5051
},
5152
"config": {
5253
"bin-dir": "bin"

run-codesniffer

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,13 @@ else
6161
COVERAGE="--report-full --report-summary"
6262
fi
6363

64-
# @TODO: Detect which to use. Ours should be a dependency of the shell-scripts so it's always available though.
65-
CODE_STANDARD=CakePHP
64+
# Should always be available, since it is a sub-dependency of the
65+
# loadsys/cakephp-shell-scripts composer package itself.
6666
CODE_STANDARD=Vendor/loadsys/loadsys_codesniffer/Loadsys
67+
6768
$PHPCS -p --extensions=php --standard="$CODE_STANDARD" ${COVERAGE} ${SNIFF_FOLDERS[@]}
6869

6970
if [ $SAVE_REPORTS ] && [ $? -eq 0 ]; then
7071
echo "## Full report created at: ${FULL_REPORT_FILE}"
7172
echo "## Summary report created at: ${SUMMARY_REPORT_FILE}"
7273
fi
73-
74-
75-
#@TODO: Make use of new Loadsys code standard.
76-
# Ref: https://github.com/loadsys/loadsys_codesniffer
77-
# Example usage:
78-
# bin/phpcs --standard=Vendor/loadsys/loadsys_codesniffer/Loadsys --report-summary -p --extensions=php Controller/ Model/ View/ Lib/

0 commit comments

Comments
 (0)