Merge pull request #733 from trus-dev/added-phpcs-phpcbf

README.md

@@ -250,6 +250,9 @@ It is recommended to keep your root docker config files in one repository, and y
 - `bin/n98-magerun2`: Access the [n98-magerun2](https://github.com/netz98/n98-magerun2) CLI. Ex: `bin/n98-magerun2 dev:console`
 - `bin/node`: Run the node binary. Ex. `bin/node --version`
 - `bin/npm`: Run the npm binary. Ex. `bin/npm install`
+- `bin/phpcbf`: Auto-fix PHP_CodeSniffer errors with Magento2 options. Ex. `bin/phpcbf <path-to-extension>`
+- `bin/phpcs`: Run PHP_CodeSniffer with Magento2 options. Ex. `bin/phpcs <path-to-extension>`
+- `bin/phpcs-json-report`: Run PHP_CodeSniffer with Magento2 options and save to `report.json` file. Ex. `bin/phpcs-json-report <path-to-extension>`
 - `bin/pwa-studio`: (BETA) Start the PWA Studio server. Note that Chrome will throw SSL cert errors and not allow you to view the site, but Firefox will.
 - `bin/redis`: Run a command from the redis container. Ex. `bin/redis redis-cli monitor`
 - `bin/remove`: Remove all containers.

compose/bin/cli

@@ -1,3 +1,3 @@
 #!/bin/bash
 [ -z "$1" ] && echo "Please specify a CLI command (ex. ls)" && exit
-docker-compose exec phpfpm "$@"
+docker compose exec phpfpm "$@"

compose/bin/clinotty

@@ -1,4 +1,4 @@
 #!/bin/bash
 [ -z "$1" ] && echo "Please specify a CLI command (ex. ls)" && exit
 # -T: Disable pseudo-tty allocation
-docker-compose exec -T phpfpm "$@"
+docker compose exec -T phpfpm "$@"

compose/bin/copyfromcontainer

@@ -3,13 +3,13 @@
 
 REAL_SRC=$(cd -P "src" && pwd)
 if [ "$1" == "--all" ]; then
-  docker cp "$(docker-compose ps -q phpfpm|awk '{print $1}')":/var/www/html/./ "$REAL_SRC/"
+  docker cp "$(docker compose ps -q phpfpm|awk '{print $1}')":/var/www/html/./ "$REAL_SRC/"
   echo "Completed copying all files from container to host"
 else
   if [ -f "$1" ] ; then
-    docker cp "$(docker-compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$1" "$REAL_SRC/$1"
+    docker cp "$(docker compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$1" "$REAL_SRC/$1"
   else
-    docker cp "$(docker-compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$1" "$REAL_SRC/$(dirname "$1")"
+    docker cp "$(docker compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$1" "$REAL_SRC/$(dirname "$1")"
   fi
   echo "Completed copying $1 from container to host"
 fi

compose/bin/copytocontainer

@@ -3,15 +3,15 @@
 
 REAL_SRC=$(cd -P "src" && pwd)
 if [ "$1" == "--all" ]; then
-  docker cp "$REAL_SRC/./" "$(docker-compose ps -q phpfpm|awk '{print $1}')":/var/www/html/
+  docker cp "$REAL_SRC/./" "$(docker compose ps -q phpfpm|awk '{print $1}')":/var/www/html/
   echo "Completed copying all files from host to container"
   bin/fixowns
   bin/fixperms
 else
   if [ -f "$REAL_SRC/$1" ]; then
-    docker cp "$REAL_SRC/${1}" "$(docker-compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$1"
+    docker cp "$REAL_SRC/${1}" "$(docker compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$1"
   else
-    docker cp "$REAL_SRC/${1}" "$(docker-compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$(dirname "$1")"
+    docker cp "$REAL_SRC/${1}" "$(docker compose ps -q phpfpm|awk '{print $1}')":/var/www/html/"$(dirname "$1")"
   fi
   echo "Completed copying $1 from host to container"
   bin/fixowns "$1"

compose/bin/download

@@ -14,9 +14,13 @@ else
   sed -i -e 's/7.4\-fpm\-15/8.1\-fpm\-1/g' docker-compose.yml
 fi
 
-docker-compose -f docker-compose.yml up -d
+docker compose -f docker-compose.yml up -d
 [ $? != 0 ] && echo "Failed to start Docker services" && exit
 
 bin/setup-composer-auth
 
+bin/fixowns
+
 bin/clinotty composer create-project --repository=https://repo.magento.com/ magento/project-"${EDITION}"-edition="${VERSION}" .
+
+bin/clinotty [ ! -f "./var/composer_home/auth.json" ] && bin/clinotty mkdir -p ./var/composer_home && bin/clinotty cp /var/www/.composer/auth.json ./var/composer_home/auth.json

compose/bin/phpcbf

@@ -0,0 +1,2 @@
+#!/bin/bash
+bin/clinotty vendor/bin/phpcbf --standard=Magento2 --extensions=php,phtml --error-severity=10 --ignore-annotations "$@"

compose/bin/phpcs

@@ -0,0 +1,2 @@
+#!/bin/bash
+bin/clinotty vendor/bin/phpcs --standard=Magento2 --extensions=php,phtml --error-severity=10 --ignore-annotations "$@"

compose/bin/phpcs-json-report

@@ -0,0 +1,2 @@
+#!/bin/bash
+bin/clinotty vendor/bin/phpcs --standard=Magento2 --extensions=php,phtml --error-severity=10 --ignore-annotations --report=json "$@" > report.json

compose/bin/redis

@@ -1,2 +1,2 @@
 #!/bin/bash
-docker-compose exec redis "$@"
+docker compose exec redis "$@"

compose/bin/remove

@@ -1,2 +1,2 @@
 #!/bin/bash
-docker-compose -f docker-compose.yml -f docker-compose.dev.yml rm
+docker compose -f docker-compose.yml -f docker-compose.dev.yml rm

compose/bin/root

@@ -1,3 +1,3 @@
 #!/bin/bash
 [ -z "$1" ] && echo "Please specify a CLI command (ex. ls)" && exit
-docker-compose exec -u root phpfpm "$@"
+docker compose exec -u root phpfpm "$@"

compose/bin/rootnotty

@@ -1,3 +1,3 @@
 #!/bin/bash
 [ -z "$1" ] && echo "Please specify a CLI command (ex. ls)" && exit
-docker-compose exec -u root -T phpfpm "$@"
+docker compose exec -u root -T phpfpm "$@"

compose/bin/setup

@@ -18,7 +18,7 @@ DOMAIN=${1:-magento.test}
 
 bin/stop
 
-docker-compose -f docker-compose.yml up -d
+docker compose -f docker-compose.yml up -d
 [ $? != 0 ] && echo "Failed to start Docker services" && exit
 
 bin/clinotty chmod u+x bin/magento
@@ -90,6 +90,10 @@ bin/clinotty bin/magento indexer:reindex
 echo "Setting basic URL and generating SSL certificate..."
 bin/setup-domain "${DOMAIN}"
 
+echo "Fixing owner and permissions..."
+bin/fixowns
+bin/fixperms
+
 echo "Clearing the cache to apply updates..."
 bin/clinotty bin/magento cache:flush
 
@@ -99,7 +103,7 @@ bin/clinotty bin/magento cron:install
 echo "Turning on developer mode..."
 bin/clinotty bin/magento deploy:mode:set developer
 
-mv .vscode src/
+cp -r .vscode src/
 
 echo "Docker development environment setup complete."
 echo "You may now access your Magento instance at https://${DOMAIN}/"

compose/bin/setup-ssl

@@ -2,15 +2,15 @@
 [ -z "$1" ] && echo "Please specify a domain (ex. mydomain.test)" && exit
 
 # Generate certificate authority if not already setup
-if ! docker-compose exec -T -u root app cat /root/.local/share/mkcert/rootCA.pem | grep -q 'BEGIN CERTIFICATE'; then
+if ! docker compose exec -T -u root app cat /root/.local/share/mkcert/rootCA.pem | grep -q 'BEGIN CERTIFICATE'; then
   bin/setup-ssl-ca
 fi
 
 # Generate the certificate for the specified domain
-docker-compose exec -T -u root app mkcert -key-file nginx.key -cert-file nginx.crt "$@"
+docker compose exec -T -u root app mkcert -key-file nginx.key -cert-file nginx.crt "$@"
 echo "Moving key and cert to /etc/nginx/certs/..."
-docker-compose exec -T -u root app chown app:app nginx.key nginx.crt
-docker-compose exec -T -u root app mv nginx.key nginx.crt /etc/nginx/certs/
+docker compose exec -T -u root app chown app:app nginx.key nginx.crt
+docker compose exec -T -u root app mv nginx.key nginx.crt /etc/nginx/certs/
 
 # Restart nginx to apply the updates
 echo "Restarting containers to apply updates..."

compose/bin/setup-ssl-ca

@@ -1,9 +1,9 @@
 #!/bin/bash
 set -o errexit
 # Generate a new local CA "/root/.local/share/mkcert"
-docker-compose exec -T -u root app mkcert -install
+docker compose exec -T -u root app mkcert -install
 
-docker cp "$(docker-compose ps -q app|awk '{print $1}')":/root/.local/share/mkcert/rootCA.pem .
+docker cp "$(docker compose ps -q app|awk '{print $1}')":/root/.local/share/mkcert/rootCA.pem .
 echo "System password requested to install certificate authority on host..."
 
 if [ "$(uname)" == "Darwin" ]; then

compose/bin/start

@@ -52,7 +52,7 @@ done
 # Wait to exit until all missing files have been outputted to the user
 [ $IS_VALID = false ] && echo "Failed to start docker for missing volume files" && exit
 
-docker-compose -f docker-compose.yml -f docker-compose.dev.yml up -d --remove-orphans "$@"
+docker compose -f docker-compose.yml -f docker-compose.dev.yml up -d --remove-orphans "$@"
 
 ## Blackfire support
 ## ------------------

compose/bin/status

@@ -1,2 +1,2 @@
 #!/bin/bash
-docker-compose -f docker-compose.yml -f docker-compose.dev.yml ps
+docker compose -f docker-compose.yml -f docker-compose.dev.yml ps

compose/bin/stop

@@ -1,2 +1,2 @@
 #!/bin/bash
-docker-compose -f docker-compose.yml -f docker-compose.dev.yml stop "$@"
+docker compose -f docker-compose.yml -f docker-compose.dev.yml stop "$@"