You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+21-25Lines changed: 21 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,61 +1,63 @@
1
1
# PHP Compatibility Checker
2
2
3
-
The WP Engine PHP Compatibility Checker can be used by any WordPress website on any web host to check PHP version compatibility.
3
+
An easy way to check your site for PHP Compatibility.
4
4
5
5
## Setup Development Environment
6
6
7
7
Before starting your workstation will need the following:
8
8
9
9
*[Docker](https://www.docker.com/)
10
-
*[Lando](https://lando.dev/)
11
10
12
11
1. Clone the repository
13
12
14
-
`git@github.com:wpengine/wpe-php-compat.git`
13
+
`git@github.com:wpengine/phpcompat.git`
15
14
16
-
2.Start Lando
15
+
2.Setup WP-Env
17
16
18
17
```bash
19
-
cd wpe-php-compat
20
-
make start
18
+
make setup && make start
21
19
```
22
20
23
-
When finished, Lando will give you the local URL of your site. You can finish the WordPress setup there. WooCommerce will be configured with enough sample data to get you started.
21
+
When finished, a local WordPress will be configured at http://localhost:8888/wp-admin.
Xdebug 3 released a [number of changes](https://xdebug.org/docs/upgrade_guide) that affect the way Xdebug works. Namely, it no longer listens on every request and requires a "trigger" to enable the connection. Use one of the following plugins to enable the trigger on your machine:
36
-
37
-
38
-
*[Xdebug Helper for Firefox](https://addons.mozilla.org/en-GB/firefox/addon/xdebug-helper-for-firefox/) ([source](https://github.com/BrianGilbert/xdebug-helper-for-firefox)).
39
-
*[Xdebug Helper for Chrome](https://chrome.google.com/extensions/detail/eadndfjplgieldjbigjakmdgkmoaaaoc) ([source](https://github.com/mac-cain13/xdebug-helper-for-chrome)).
40
-
*[XDebugToggle for Safari](https://apps.apple.com/app/safari-xdebug-toggle/id1437227804?mt=12) ([source](https://github.com/kampfq/SafariXDebugToggle)).
31
+
After you have logged in, go to http://localhost:8888/wp-admin/admin.php?page=fakerpress and generate some dummy content for the block to render.
41
32
33
+
If anything goes wrong and you suspect your local is frozen, you can always `make choose-violence` to rebuild the local environment and containers. Hopefully you never have to choose violence. :)
42
34
43
35
## Build and Testing
44
36
45
-
The only current build asset is the .pot file for internationalization. Build it with the following:
46
-
47
37
```bash
48
38
make build
49
39
```
50
40
51
41
Note, assets will also build during the install phase.
52
42
43
+
You can run all testing (all lints and unit tests) together with the following:
44
+
45
+
```bash
46
+
make test
47
+
```
48
+
53
49
The project uses the [Brain Monkey](https://brain-wp.github.io/BrainMonkey/) library for unit testing. Once setup run the following for unit tests:
54
50
55
51
```bash
56
52
make test-unit
57
53
```
58
54
55
+
The project uses the WordPress e2e tests. Run the following for e2e tests:
56
+
57
+
```bash
58
+
make test-e2e
59
+
```
60
+
59
61
We also use [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) with [WordPress Coding Standards](https://github.com/WordPress/WordPress-Coding-Standards) and [JSHint](http://jshint.com/) with [WordPress' JS Standards](https://make.wordpress.org/core/handbook/best-practices/coding-standards/javascript/#installing-and-running-jshint). Linting will automagically be setup for you if you use [Visual Studio Code](https://code.visualstudio.com/). If you want to run it manually use the following:
60
62
61
63
```bash
@@ -72,12 +74,6 @@ make test-lint-php
72
74
make test-lint-javascript
73
75
```
74
76
75
-
You can run all testing (all lints and unit tests) together with the following:
76
-
77
-
```bash
78
-
make test
79
-
```
80
-
81
77
Screw something up? You can reset your environment with the following. It will stop the environment and cleanup and the build files as well as anything downloaded.
0 commit comments