fix: windows compatibility issues

.gitattributes

@@ -0,0 +1,22 @@
+# https://www.git-scm.com/docs/gitattributes
+
+# Set default behavior to automatically normalize line endings.
+* text=auto
+
+# Force bash scripts to always use LF line endings so that if a repo is accessed
+# in Unix via a file share from Windows, the scripts will work.
+*.sh text eol=lf
+
+# Set specific extensions manually as binary.
+# https://www.git-scm.com/docs/gitattributes#_marking_files_as_binary
+*.data -diff
+
+# Configure non-standard file extensions. Set as text to allow for line ending
+# conversion to LF, diff type for Git, and syntax highlighting language for GitHub.
+# https://github.com/github-linguist/linguist/blob/master/docs/overrides.md
+*.module text diff=php linguist-language=php
+*.rs.example text diff=rust linguist-language=rust
+
+# Windows-specific extensions that require CRLF line endings
+*.{cmd,[cC][mM][dD]} text eol=crlf
+*.{bat,[bB][aA][tT]} text eol=crlf

CONTRIBUTING.md

@@ -16,7 +16,6 @@ Here's a few things you should know before you submit your PR:
 - Ensure tests pass: `npm test`
 - Make changes and then make sure the linters and tests still pass
 - Push your branch/fork and [submit a PR][pr]
-- Assign a [sparkboxer][contributors] to review your PR
 
 ## Commit Style
 
@@ -44,5 +43,4 @@ feature: add new linting rule for ...
 
 [issues]: ./issues
 [pr]: ./compare
-[contributors]: ./graphs/contributors
 [conventional commits]: https://www.conventionalcommits.org/en/v1.0.0/

Dockerfile

@@ -14,6 +14,7 @@ RUN docker-php-ext-install gd mysqli pdo_mysql zip
 RUN a2enmod rewrite headers xml2enc proxy proxy_fcgi
 
 COPY ./composer.json /var/www/html/composer.json
+COPY ./composer.lock /var/www/html/composer.lock
 COPY --from=composer:latest /usr/bin/composer /usr/local/bin/composer
 RUN composer install
 
@@ -36,6 +37,7 @@ RUN find /var/www/ -type f -exec chmod 644 {} \;
 
 # make the linters executable so we can run them from containers
 RUN chmod +x vendor/bin/phpcs
+RUN chmod +x vendor/bin/phpcbf
 RUN chmod +x vendor/bin/twigcs
 
 FROM dev as prod

docker-compose.yml

@@ -18,6 +18,10 @@ services:
       - ./wp-configs/php.ini:/var/www/html/php.ini
       - ./.env:/var/www/html/.env
       - ./wp-configs/.htaccess:/var/www/html/.htaccess
+      - ./wp-configs/phpcs-rules-standard.xml:/var/www/html/wp-configs/phpcs-rules-standard.xml
+      - ./src:/var/www/html/src
+      - ./composer.json:/var/www/html/composer.json
+      - ./composer.lock:/var/www/html/composer.lock
   db:
     image: mysql:8.1
     container_name: sparkpress_db

package.json

@@ -30,6 +30,7 @@
     "lint:scss": "stylelint \"src/**/*.scss\" --color --formatter verbose",
     "lint:twig": "./scripts/run.sh vendor/bin/twigcs src/php/views",
     "lint": "run-s lint:*",
+    "map-vendor-files": "mkdir -p vendor && docker compose cp web:/var/www/html/vendor .",
     "php:run": "./scripts/run.sh",
     "export": "run-s \"export:* {1}\" --",
     "backup": "run-s \"backup:* {1}\" --",

scripts/export-db.sh

@@ -23,7 +23,7 @@ fi
 mkdir -p $path
 
 # generate SQL dump
-docker exec -i sparkpress_db mysqldump --user=root --password=$MYSQL_ROOT_PASSWORD $MYSQL_DATABASE > $path/$prefix-raw.sql
+docker compose exec -i db mysqldump --user=root --password=$MYSQL_ROOT_PASSWORD $MYSQL_DATABASE > $path/$prefix-raw.sql
 
 # replace localhost URLs with target environment URL
 sed "s/http:\/\/localhost:8000/$SITE_URL/g" $path/$prefix-raw.sql > $filename

scripts/import-db.sh

@@ -17,9 +17,9 @@ gunzip sync/sql/db-import-raw.sql.gz
 sed "s/$SITE_URL/http:\/\/localhost:8000/g" sync/sql/db-import-raw.sql > sync/sql/db-import.sql
 
 # drop existing database, create a new one, and load it up with data
-docker exec -i sparkpress_db mysql --user=$MYSQL_USER --password=$MYSQL_PASSWORD -e "drop database if exists $MYSQL_DATABASE"
-docker exec -i sparkpress_db mysql --user=$MYSQL_USER --password=$MYSQL_PASSWORD -e "create database $MYSQL_DATABASE"
-docker exec -i sparkpress_db mysql --user=$MYSQL_USER --password=$MYSQL_PASSWORD $MYSQL_DATABASE < sync/sql/db-import.sql
+docker compose exec -i db mysql --user=$MYSQL_USER --password=$MYSQL_PASSWORD -e "drop database if exists $MYSQL_DATABASE"
+docker compose exec -i db mysql --user=$MYSQL_USER --password=$MYSQL_PASSWORD -e "create database $MYSQL_DATABASE"
+docker compose exec -iT db mysql --user=$MYSQL_USER --password=$MYSQL_PASSWORD $MYSQL_DATABASE < sync/sql/db-import.sql
 
 # clean up files that aren't useful after import
 rm sync/sql/db-import*

scripts/run.sh

@@ -12,5 +12,6 @@ if [ "$CI" == "true" ]; then
   exec "$@"
 else
   # Run the command inside the Docker container
-  docker run --rm -v .:/tmp -w=/tmp sparkpress-wordpress-starter-web "$@"
+  # use exec if the container's already running, or spin up a temporary container to run it
+  docker compose exec -it web "$@" || docker compose run --rm --no-deps --remove-orphans web "$@"
 fi

wp-configs/phpcs-rules-standard.xml

@@ -7,6 +7,7 @@
         <exclude name="WordPress.Arrays.MultipleStatementAlignment.DoubleArrowNotAligned" />
         <exclude name="Generic.Arrays.DisallowShortArraySyntax.Found" />
         <exclude name="Squiz.Commenting.InlineComment.InvalidEndChar" />
+        <exclude name="Generic.Files.LineEndings.InvalidEOLChar" />
         <!-- exclude other stuff as you wish -->
     </rule>
 </ruleset>