I ran into some issues using PhpStorm to review Drupal code today and I was able to track it down to improperly commented code found in Drupal. In every code block where we refer to an object we need to start the PSR-0 syntax with at "\".

CommentFileSizeAuthor
#1 2100329-1.patch190.01 KBcosmicdreams
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

cosmicdreams’s picture

cosmicdreams CreditAttribution: cosmicdreams commented
Status: Active » Needs review
FileSize
2100329-1.patch190.01 KB

Here's a patch that shows what I'm saying

Les Lim’s picture

Les Lim
he/they
Primary language English
CreditAttribution: Les Lim commented

Coming from the discussion here:

#1487760: [policy, no patch] Decide on documentation standards for namespaced items

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
CreditAttribution: tim.plunkett commented
Status: Needs review » Reviewed & tested by the community

a) This is correct
b) We just did #2053489: Standardize on \Drupal throughout core

RTBC if green.

cosmicdreams’s picture

cosmicdreams CreditAttribution: cosmicdreams commented
Status: Reviewed & tested by the community » Needs work

Need to convert params, new patch coming soon.

cosmicdreams’s picture

cosmicdreams CreditAttribution: cosmicdreams commented
Status: Needs work » Reviewed & tested by the community

nope I got the params, nevermind.

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner commented

+1

slashrsm’s picture

slashrsm CreditAttribution: slashrsm commented

+1

dawehner’s picture

dawehner
Primary language German
CreditAttribution: dawehner commented
Title: Use \Drupal instead of Drupal to make PhpStorm happy » Use \Drupal instead of Drupal to make IDEs and static code analyse tools happy

.

mtift’s picture

mtift
he/him
Primary language English
Location Minnesota, USA
CreditAttribution: mtift commented

+1

andypost’s picture

andypost
he/him
Primary language Russian
CreditAttribution: andypost commented

this need avoid commit conflicts tag
Also there could be a new hunks introduced with latest commits

cosmicdreams’s picture

cosmicdreams CreditAttribution: cosmicdreams commented
Issue tags: +Avoid commit conflicts

Let's see if this needs a reroll

cosmicdreams’s picture

cosmicdreams CreditAttribution: cosmicdreams commented

#1: 2100329-1.patch queued for re-testing.

andypost’s picture

andypost
he/him
Primary language Russian
CreditAttribution: andypost commented

@cosmicdreams is there a pattern to quickly grep for? to make sure all places are fixed

cosmicdreams’s picture

cosmicdreams CreditAttribution: cosmicdreams commented

Yea, the patterns are :
replace all "@return Drupal\" with @return \Drupal\
replace all "@see Drupal\" with @see \Drupal\
replace all "@param Drupal\" with @param \Drupal\

Les Lim’s picture

Les Lim
he/they
Primary language English
CreditAttribution: Les Lim commented

Also these:
replace all "@var Drupal\" with @var \Drupal\
replace all "@throws Drupal\" with @throws \Drupal\

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Status: Reviewed & tested by the community » Fixed

Getting this in whilst it still applies - we can pick up any stragglers in a followup.

Committed 3cee107 and pushed to 8.x. Thanks!

Automatically closed -- issue fixed for 2 weeks with no activity.