Benchmarks
Plugin footprint 65% from 16 tests
Installer Passed 1 test
🔺 Critical test (weight: 50) | Checking the installer triggered no errors
This plugin's installer ran successfully
Server metrics [RAM: ▲0.14MB] [CPU: ▼5.69ms] Passed 4 tests
This is a short check of server-side resources used by Simple Documentation
This plugin does not affect your website's performance
| Page | Memory (MB) | CPU Time (ms) |
|---|---|---|
| Home / | 3.60 ▲0.13 | 36.96 ▼4.01 |
| Dashboard /wp-admin | 3.48 ▲0.17 | 52.54 ▲4.02 |
| Posts /wp-admin/edit.php | 3.54 ▲0.18 | 47.04 ▼6.85 |
| Add New Post /wp-admin/post-new.php | 6.01 ▲0.12 | 84.58 ▼15.44 |
| Media Library /wp-admin/upload.php | 3.35 ▲0.12 | 36.76 ▲3.53 |
| Documentation /wp-admin/admin.php?page=simpledocumentation | 3.39 | 38.10 |
| Import / Export /wp-admin/admin.php?page=simpledocumentation_import_export | 3.35 | 41.52 |
| Settings /wp-admin/admin.php?page=simpledocumentation_settings | 3.32 | 31.91 |
Server storage [IO: ▲0.57MB] [DB: ▲0.00MB] Passed 3 tests
A short overview of filesystem and database impact
There were no storage issued detected upon installing this plugin
Filesystem: 24 new files
Database: 1 new table, 6 new options
| New tables |
|---|
| wp_simpledocumentation |
| New WordPress options |
|---|
| widget_recent-comments |
| can_compress_scripts |
| widget_theysaidso_widget |
| theysaidso_admin_options |
| widget_recent-posts |
| db_upgraded |
Browser metrics Passed 4 tests
Simple Documentation: an overview of browser usage
Minimal impact on browser resources
| Page | Nodes | Memory (MB) | Script (ms) | Layout (ms) |
|---|---|---|---|---|
| Home / | 3,052 ▲317 | 14.75 ▲0.40 | 1.74 ▲0.05 | 30.82 ▼14.68 |
| Dashboard /wp-admin | 2,461 ▲270 | 6.46 ▲1.63 | 142.76 ▲32.14 | 47.30 ▲3.29 |
| Posts /wp-admin/edit.php | 2,124 ▲35 | 2.09 ▲0.03 | 40.68 ▲0.29 | 33.09 ▼5.40 |
| Add New Post /wp-admin/post-new.php | 1,543 ▲10 | 17.58 ▼5.56 | 668.30 ▲56.92 | 35.67 ▼26.42 |
| Media Library /wp-admin/upload.php | 1,423 ▲35 | 4.06 ▼0.19 | 83.87 ▼21.40 | 40.96 ▼3.91 |
| Documentation /wp-admin/admin.php?page=simpledocumentation | 1,647 | 6.35 | 124.75 | 31.52 |
| Import / Export /wp-admin/admin.php?page=simpledocumentation_import_export | 1,025 | 3.06 | 43.90 | 31.53 |
| Settings /wp-admin/admin.php?page=simpledocumentation_settings | 917 | 2.09 | 30.19 | 26.69 |
Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] 50% from 4 tests
🔸 Tests weight: 35 | It is important to correctly uninstall your plugin, without leaving any traces
Please fix the following items
- Uninstall procedure validation failed for this plugin
- > Deprecated in wp-includes/class-wp-hook.php+310
Non-static method simpleDocumentation::uninstall() should not be called statically
- Zombie WordPress options were found after uninstall: 6 options
- widget_recent-posts
- widget_theysaidso_widget
- theysaidso_admin_options
- widget_recent-comments
- db_upgraded
- can_compress_scripts
Smoke tests Passed 4 tests
Server-side errors Passed 1 test
🔹 Test weight: 20 | This is a short smoke test looking for server-side errors
Everything seems fine, however this is by no means an exhaustive test
SRP Passed 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
Congratulations! This plugin passed the SRP test
User-side errors Passed 1 test
🔹 Test weight: 20 | Just a short smoke test targeting errors on the browser (console and network errors and warnings)
Everything seems fine on the user side
Optimizations
Plugin configuration 97% from 29 tests
readme.txt 94% from 16 tests
The readme.txt file is important because it is parsed by WordPress.org for the public listing of your plugin
Attributes that need to be fixed:
- Tags: Too many tags (11 tag instead of maximum 10); only the first 5 tags are used in your directory listing
client-documentation/client-documentation.php Passed 13 tests
The main file in "Simple Documentation" v. 1.2.8 serves as a complement to information provided in readme.txt and as the entry point to the plugin
97 characters long description:
This plugin helps webmasters/developers to provide documentation through the wordpress dashboard.
Code Analysis Passed 3 tests
File types Passed 1 test
🔸 Test weight: 35 | An overview of files in this plugin; executable files are not allowed
Success! There were no dangerous files found in this plugin2,877 lines of code in 15 files:
| Language | Files | Blank lines | Comment lines | Lines of code |
|---|---|---|---|---|
| PO File | 6 | 427 | 555 | 987 |
| PHP | 5 | 258 | 151 | 876 |
| SVG | 1 | 0 | 0 | 414 |
| JavaScript | 1 | 114 | 18 | 335 |
| CSS | 2 | 26 | 11 | 265 |
PHP code Passed 2 tests
This is a very shot review of cyclomatic complexity and code structure
There were no cyclomatic complexity issued detected
| Cyclomatic complexity | |
|---|---|
| Average complexity per logical line of code | 0.45 |
| Average class complexity | 116.00 |
| ▷ Minimum class complexity | 116.00 |
| ▷ Maximum class complexity | 116.00 |
| Average method complexity | 6.00 |
| ▷ Minimum method complexity | 1.00 |
| ▷ Maximum method complexity | 66.00 |
| Code structure | ||
|---|---|---|
| Namespaces | 0 | |
| Interfaces | 0 | |
| Traits | 0 | |
| Classes | 1 | |
| ▷ Abstract classes | 0 | 0.00% |
| ▷ Concrete classes | 1 | 100.00% |
| ▷ Final classes | 0 | 0.00% |
| Methods | 23 | |
| ▷ Static methods | 0 | 0.00% |
| ▷ Public methods | 19 | 82.61% |
| ▷ Protected methods | 0 | 0.00% |
| ▷ Private methods | 4 | 17.39% |
| Functions | 0 | |
| ▷ Named functions | 0 | 0.00% |
| ▷ Anonymous functions | 0 | 0.00% |
| Constants | 1 | |
| ▷ Global constants | 0 | 0.00% |
| ▷ Class constants | 1 | 100.00% |
| ▷ Public constants | 1 | 100.00% |
Plugin size Passed 2 tests
Image compression Passed 2 tests
All PNG images should be compressed to minimize bandwidth usage for end users
There are no PNG files in this plugin