|
7 | 7 |
|
8 | 8 | Stable tag: 0.3.2 |
9 | 9 | Requires at least: 6.2 |
10 | | -Tested up to: 6.4 |
| 10 | +Tested up to: 6.6 |
11 | 11 | Requires PHP: 8.1 |
12 | 12 |
|
13 | | -WordPress Feature flags plugin allow developers to configure features in plugins/themes behind the feature flags on both the server (PHP) and client (JS/TS) side. |
| 13 | +WordPress Feature flags plugin allow developers to configure features in plugins/themes behind the feature flags on both |
| 14 | +the server (PHP) and client (JS/TS) side. |
14 | 15 |
|
15 | 16 | ## Installation |
16 | 17 |
|
@@ -61,60 +62,63 @@ To build the plugin |
61 | 62 |
|
62 | 63 | PHP setup |
63 | 64 |
|
64 | | -- `composer install` |
| 65 | +- `composer install` |
65 | 66 |
|
66 | 67 | JS setup |
67 | 68 |
|
68 | | -- `yarn install` |
69 | | -- `yarn build` to create the build |
70 | | -- `yarn start` to start the watch mode |
| 69 | +- `yarn install` |
| 70 | +- `yarn build` to create the build |
| 71 | +- `yarn start` to start the watch mode |
71 | 72 |
|
72 | 73 | ### wp-env |
73 | 74 |
|
74 | 75 | This plugin uses `wp-env` setup to for local environment. |
75 | 76 |
|
76 | | -- `wp-env start` to start the containers |
77 | | -- `wp-env stop` to stop the containers |
| 77 | +- `wp-env start` to start the containers |
| 78 | +- `wp-env stop` to stop the containers |
78 | 79 |
|
79 | | -More details on how to access local environment can be found [here](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#quick-tldr-instructions). |
| 80 | +More details on how to access local environment can be |
| 81 | +found [here](https://developer.wordpress.org/block-editor/reference-guides/packages/packages-env/#quick-tldr-instructions). |
80 | 82 |
|
81 | 83 | ## Linting and formatting |
82 | 84 |
|
83 | 85 | PHP |
84 | 86 |
|
85 | | -- `composer lint` |
86 | | -- `composer lint:fix` to auto fix PHP linting errors. |
| 87 | +- `composer lint` |
| 88 | +- `composer lint:fix` to auto fix PHP linting errors. |
87 | 89 |
|
88 | 90 | JS |
89 | 91 |
|
90 | | -- `yarn lint:js` |
91 | | -- `yarn lint:js:fix` to auto fix JS linting errors. |
| 92 | +- `yarn lint:js` |
| 93 | +- `yarn lint:js:fix` to auto fix JS linting errors. |
92 | 94 |
|
93 | 95 | CSS |
94 | 96 |
|
95 | | -- `yarn lint:css` |
96 | | -- `yarn lint:css:fix` to auto fix CSS linting errors. |
| 97 | +- `yarn lint:css` |
| 98 | +- `yarn lint:css:fix` to auto fix CSS linting errors. |
97 | 99 |
|
98 | 100 | ## Testing |
99 | 101 |
|
100 | 102 | ### PHP |
101 | 103 |
|
102 | | -The WordPress unit and integration tests depends on `wp-env` setup. Ensure you run `yarn wp-env:coverage` before running the tests. |
| 104 | +The WordPress unit and integration tests depends on `wp-env` setup. Ensure you run `yarn wp-env:coverage` before running |
| 105 | +the tests. |
103 | 106 |
|
104 | | -- To run unit tests `yarn php:unit` |
105 | | -- To run integrations tests `yarn php:integration` |
106 | | -- To run integrations tests as multisite `yarn php:multisite` |
| 107 | +- To run unit tests `yarn php:unit` |
| 108 | +- To run integrations tests `yarn php:integration` |
| 109 | +- To run integrations tests as multisite `yarn php:multisite` |
107 | 110 |
|
108 | 111 | ### JS |
109 | 112 |
|
110 | | -- Run `yarn test:js` to run all Jest and React Testing Library tests |
| 113 | +- Run `yarn test:js` to run all Jest and React Testing Library tests |
111 | 114 |
|
112 | 115 | ### E2E |
113 | 116 |
|
114 | 117 | The E2E tests depends on `wp-env` setup. Ensure you run `wp-env start` before running the tests. |
115 | 118 |
|
116 | | -- Run `yarn test:e2e` to run all Playwright e2e tests. |
| 119 | +- Run `yarn test:e2e` to run all Playwright e2e tests. |
117 | 120 |
|
118 | 121 | ## Contributing |
119 | 122 |
|
120 | | -Code contributions, feedback, issue reporting and feature suggestions are welcome. See [CONTRIBUTING.md](https://github.com/codebtech/wp-feature-flags/blob/main/CONTRIBUTING.md) for more details. |
| 123 | +Code contributions, feedback, issue reporting and feature suggestions are welcome. |
| 124 | +See [CONTRIBUTING.md](https://github.com/codebtech/wp-feature-flags/blob/main/CONTRIBUTING.md) for more details. |
0 commit comments