Skip to content

Commit 021e90b

Browse files
committed
Document PHP Beautify install and Roller format command
1 parent faf48d9 commit 021e90b

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

docs/pages/guides/plugin-upgrade.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Here are the steps to upgrade an existing plugin to the common setup used by all
1212
- Upgrade Framework
1313
- Upgrade Build Pipeline
1414
- Upgrade Assets Bundler
15-
- Code formatter using Roller (CSS, Sass, JavaScript, TypeScript) and [PHP Beautify](https://github.com/TangibleInc/php-beautify)
15+
- Code formatter using Roller (CSS, Sass, JavaScript, TypeScript) and PHP Beautify
1616

1717
## Git repository
1818

@@ -348,3 +348,17 @@ The section [Comparison with Tangible Builder](/modules/roller/#comparison-with-
348348
Read the documentation for Roller's [Format command](/modules/roller/#format).
349349

350350
In the build configuration file `tangible.config.js`, the `format` property defines file patterns to be formatted. Update to match the existing folder structure.
351+
352+
Install [PHP Beautify](https://github.com/TangibleInc/php-beautify). This is used by Roller to lint and format PHP files.
353+
354+
```sh
355+
npm install --save @tangible/php-beautify
356+
```
357+
358+
Run the formatter. This could change many files, so commit any unrelated changes beforehand.
359+
360+
```sh
361+
npm run format
362+
```
363+
364+
Or directly with `npx roll format`.

0 commit comments

Comments
 (0)