-
Notifications
You must be signed in to change notification settings - Fork 430
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(docs): add validation of xrefs to docfx command #6658
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
e36f250
feat(docs): add validation of xrefs to docfx command
bshaffer 7678de5
add allowFailures for obscure phpdoc errors
bshaffer 3ebc035
readability / comments
bshaffer d0d125f
cleaner comments
bshaffer 54b11b6
more tiny style changes
bshaffer e3b304f
Merge branch 'main' into add-docs-ref-validation
bshaffer d92f8fb
fix bug
bshaffer File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,114 @@ | ||
| <?php | ||
| /** | ||
| * Copyright 2024 Google Inc. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| namespace Google\Cloud\Dev\DocFx; | ||
|
|
||
| use Google\Cloud\Core\Logger\AppEngineFlexFormatter; | ||
| use Google\Cloud\Core\Logger\AppEngineFlexFormatterV2; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| trait XrefValidationTrait | ||
| { | ||
| /** | ||
| * Verifies that all class references and @see tags are properly formatted | ||
| * with either an FQSEN (Fully Qualified Structural Element Name), or a URL. | ||
| */ | ||
| private function getInvalidXrefs(string $description): array | ||
| { | ||
| $invalidRefs = []; | ||
| preg_replace_callback( | ||
| '/<xref uid="([^ ]*)"/', | ||
| function ($matches) use (&$invalidRefs) { | ||
| // Valid external reference | ||
| if (0 === strpos($matches[1], 'http')) { | ||
| return; | ||
| } | ||
| // Invalid reference format (not an FQSEN) | ||
| if ('\\' !== $matches[1][0]) { | ||
| $invalidRefs[] = $matches[1]; | ||
| return; | ||
| } | ||
| // Invalid FQSEN (If it contains "\Google\" more than once, it wasn't properly imported) | ||
| if (substr_count($matches[1], '\Google\\') > 1) { | ||
| $invalidRefs[] = $matches[1]; | ||
| return; | ||
| } | ||
| }, | ||
| $description | ||
| ); | ||
|
|
||
| return $invalidRefs; | ||
| } | ||
|
|
||
| /** | ||
| * Verifies that all class references and @see tags contain references to classes, methods, and | ||
| * constants which actually exist. | ||
| */ | ||
| private function getBrokenXrefs(string $description): array | ||
| { | ||
| $brokenRefs = []; | ||
| preg_replace_callback( | ||
| '/<xref uid="([^ ]*)"/', | ||
| function ($matches) use (&$brokenRefs) { | ||
| // Valid external reference | ||
| if (0 === strpos($matches[1], 'http')) { | ||
| return; | ||
| } | ||
| // We cannot run "class_exists" on these classes because they will throw a fatal error. | ||
| if (in_array( | ||
| $matches[1], | ||
| ['\\' . AppEngineFlexFormatter::class, '\\' . AppEngineFlexFormatterV2::class] | ||
| )) { | ||
| return; | ||
| } | ||
| // Valid class reference | ||
| if (class_exists($matches[1]) || interface_exists($matches[1] || trait_exists($matches[1]))) { | ||
| return; | ||
| } | ||
| // Valid method, magic method, andd constant references | ||
| if (false !== strpos($matches[1], '::')) { | ||
| if (false !== strpos($matches[1], '()')) { | ||
| list($class, $method) = explode('::', str_replace('()', '', $matches[1])); | ||
| // Valid method reference | ||
| if (method_exists($class, $method)) { | ||
| return; | ||
| } | ||
| // Assume it's a magic Async method | ||
| if ('Async' === substr($method, -5)) { | ||
| return; | ||
| } | ||
| } elseif (defined($matches[1])) { | ||
| // Valid constant reference | ||
| return; | ||
| } | ||
| } | ||
| // Invalid reference! | ||
| if ($matches[1] === '\\\\') { | ||
| // empty hrefs show up as "\\" | ||
| $brokenRefs[] = null; | ||
| } else { | ||
| $brokenRefs[] = $matches[1]; | ||
| } | ||
| }, | ||
| $description | ||
| ); | ||
|
|
||
| return $brokenRefs; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's create a ticket for this one.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's a tricky situation because the issue (I think) is in phpdoc itself... but there's no indication AFAIK for why this would happen (they look identical to the other xrefs). It's absolutely baffling.
Before I can file an issue with
phpdoc, I need to do more investigation to see if I can find out what could be causing it. Because I truly have no clue.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Filed an issue in #7377