94% groupdocs-annotation-for-dot-net-html5-document-annotation

Code Review | GroupDocs.Annotation for .NET | HTML5 Document Annotation

WordPress plugin GroupDocs.Annotation for .NET | HTML5 Document Annotation scored 94% from 54 tests.

About plugin

  • Plugin page: groupdocs-annotat...
  • Plugin version: 1.0.0
  • PHP version: 7.4.16
  • WordPress compatibility: 2.8-4.1
  • WordPress version: 5.9.2
  • First release: Dec 9, 2014
  • Latest release: Jan 16, 2015
  • Number of updates: 8
  • Update frequency: every 4.9 days
  • Top authors: groupdocs (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active / 825 total downloads

Benchmarks

Plugin footprint Passed 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
Installer ran successfully

Server metrics [RAM: ▼0.01MB] [CPU: ▼290.05ms] Passed 4 tests

This is a short check of server-side resources used by GroupDocs.Annotation for .NET | HTML5 Document Annotation
Server-side resource usage in normal parameters
PageMemory (MB)CPU Time (ms)
Home /3.54 ▲0.0253.43 ▼1.81
Dashboard /wp-admin3.43 ▲0.0134.11 ▲1.29
Posts /wp-admin/edit.php3.66 ▲0.0140.64 ▼2.81
Add New Post /wp-admin/post-new.php6.90 ▼0.0893.74 ▼1,156.88
Media Library /wp-admin/upload.php3.31 ▲0.0131.55 ▲6.14

Server storage [IO: ▲0.02MB] [DB: ▲0.00MB] Passed 3 tests

How much does this plugin use your filesystem and database?
This plugin installed successfully
Filesystem: 6 new files
Database: no new tables, no new options

Browser metrics Passed 4 tests

GroupDocs.Annotation for .NET | HTML5 Document Annotation: an overview of browser usage
Minimal impact on browser resources
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /3,763 ▲915.92 ▲0.295.70 ▼0.912.80 ▲0.07
Dashboard /wp-admin2,888 ▲276.15 ▲0.02115.34 ▼16.27156.72 ▼8.45
Posts /wp-admin/edit.php2,691 ▲343.23 ▼0.1470.06 ▲5.40158.40 ▲14.98
Add New Post /wp-admin/post-new.php1,749 ▼321.20 ▲0.30439.54 ▼21.01160.69 ▲0.76
Media Library /wp-admin/upload.php1,695 ▼35.53 ▲0.06142.40 ▼0.53188.66 ▼14.39

Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] Passed 4 tests

🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
Uninstall script ran successfully

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | Just a short smoke test targeting errors on the server (in the Apache logs)
Everything seems fine, however this is by no means an exhaustive test

SRP 50% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle applies for WordPress plugins as well - please make sure your PHP files perform no actions when accessed directly
Please take a closer look at the following
  • 3× PHP files trigger server-side errors or warnings when accessed directly:
    • > PHP Warning
      Use of undefined constant WP_PLUGIN_URL - assumed 'WP_PLUGIN_URL' (this will throw an Error in a future version of PHP) in wp-content/plugins/groupdocs-annotation-for-dot-net-html5-document-annotation/grpdocs-functions.php on line 3
    • > PHP Warning
      Use of undefined constant WP_PLUGIN_URL - assumed 'WP_PLUGIN_URL' (this will throw an Error in a future version of PHP) in wp-content/plugins/groupdocs-annotation-for-dot-net-html5-document-annotation/grpdocs-functions.php on line 3
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_shortcode() in wp-content/plugins/groupdocs-annotation-for-dot-net-html5-document-annotation/grpdocsdotnetannotation.php:33

User-side errors Passed 1 test

🔹 Test weight: 20 | This is just a short smoke test looking for browser issues
There were no browser issues found

Optimizations

Plugin configuration 93% from 29 tests

readme.txt Passed 16 tests

You should put a lot of thought into formatting readme.txt as it is used by WordPress.org to prepare the public listing of your plugin
5 plugin tags: groupdocs, groupdocsannotation, pdf annotation, image annotation, document annotation

groupdocs-annotation-for-dot-net-html5-document-annotation/grpdocsdotnetannotation.php 85% from 13 tests

The main file in "GroupDocs.Annotation for .NET | HTML5 Document Annotation" v. 1.0.0 serves as a complement to information provided in readme.txt and as the entry point to the plugin
Please take the time to fix the following:
  • Main file name: Even though not officially enforced, the main plugin file should be the same as the plugin slug ("groupdocs-annotation-for-dot-net-html5-document-annotation.php" instead of "grpdocsdotnetannotation.php")
  • Description: Keep the plugin description shorter than 140 characters (currently 191 characters long)

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | This is an overview of programming languages used in this plugin; dangerous file extensions are not allowed
Good job! No executable or dangerous file extensions detected107 lines of code in 4 files:
LanguageFilesBlank linesComment linesLines of code
JavaScript2151461
PHP2251646

PHP code Passed 2 tests

An short overview of logical lines of code, cyclomatic complexity, and other code metrics
This plugin has no cyclomatic complexity issues
Cyclomatic complexity
Average complexity per logical line of code0.37
Average class complexity0.00
▷ Minimum class complexity0.00
▷ Maximum class complexity0.00
Average method complexity0.00
▷ Minimum method complexity0.00
▷ Maximum method complexity0.00
Code structure
Namespaces0
Interfaces0
Traits0
Classes0
▷ Abstract classes00.00%
▷ Concrete classes00.00%
▷ Final classes00.00%
Methods0
▷ Static methods00.00%
▷ Public methods00.00%
▷ Protected methods00.00%
▷ Private methods00.00%
Functions6
▷ Named functions6100.00%
▷ Anonymous functions00.00%
Constants1
▷ Global constants1100.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

PNG files should be compressed to save space and minimize bandwidth usage
1 PNG file occupies 0.00MB with 0.00MB in potential savings
Potential savings
Compression of 1 random PNG file using pngquant
FileSize - originalSize - compressedSavings
images/grpdocs-annotation-dotnet-button.png3.50KB0.94KB▼ 73.27%