How to automatically format PHP annotations in PHPStorm

Question

I'm working with a large number of files that have PHP block docs with Swagger PHP annotations on them, however they are not indented. Is there anyway to automatically format them with spaces?

Turning

/**
 * @SWG\Api(
 * path="/building/{buildingId}",
 * @SWG\Operation(
 * method="GET",
 * type="Building",
 * summary="Returns a Building object by ID",
 * nickname="building/getBuilding",
 * @SWG\Parameter(
 * name="buildingId",
 * description="ID of the building that needs to be fetched",
 * paramType="path",
 * required=false,
 * type="string",
 * defaultValue="1"
 * )
 * )
 * )
 */

Into

/**
 * @SWG\Api(
 *   path="/building/{buildingId}",
 *   @SWG\Operation(
 *     method="GET",
 *     type="Building",
 *     summary="Returns a Building object by ID",
 *     nickname="building/getBuilding",
 *     @SWG\Parameter(
 *       name="buildingId",
 *       description="ID of the building that needs to be fetched",
 *       paramType="path",
 *       required=false,
 *       type="string",
 *       defaultValue="1"
 *     )
 *   )
 * )
 */

AFAIK no because it was requested long time ago to not to touch such annotations at all, e.g. youtrack.jetbrains.com/issue/WI-10053 . But then -- I'm not suing such annotations myself and therefore could be wrong here. — LazyOne
– LazyOne, Commented Jun 11, 2015 at 17:53

Ed Knowles · Accepted Answer · 2015-06-13 15:30:50Z

6

Looking into this unfortunately there isn't anything built into PHPStorm to do this. I fixed this issue with a bit of node and have open sourced my work if anyone else needs it.

:)

https://github.com/eknowles/grunt-tidy-annotations

answered Jun 13, 2015 at 15:30

Ed Knowles

1,9251 gold badge16 silver badges24 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

chrisch Over a year ago

Is this solution still working? I've tried it but it doesn't format the Swagger annotations. Is there some native support in PHPStorm for formatting Swagger annotations by now?

Fabio William Conceição Over a year ago

Unfortunately wasn't working anymore, not for new versions of swagger and PHPStorm doesn't have a native support do Swagger annotations as far I know.

Denialos Over a year ago

This doesn't work anymore, sad that Jetbrains can't implement these simple formatting features.

Collectives™ on Stack Overflow

How to automatically format PHP annotations in PHPStorm

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related