84% easy-documentation

Code Review | Easy-Documentation

WordPress plugin Easy-Documentation scored84%from 54 tests.

About plugin

  • Plugin page: easy-documentation
  • Plugin version: 0.1
  • PHP version: 7.4.16
  • WordPress compatibility: 4.1-4.2.2
  • WordPress version: 6.3.1
  • First release: Apr 23, 2015
  • Latest release: May 25, 2015
  • Number of updates: 11
  • Update frequency: every 2.9 days
  • Top authors: kubadrex (100%)

Code review

54 tests

User reviews

3 reviews

Install metrics

10+ active /979 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | The install procedure must perform silently
The plugin installed successfully, without throwing any errors or notices

Server metrics [RAM: ▲0.03MB] [CPU: ▼5.89ms] Passed 4 tests

Analyzing server-side resources used by Easy-Documentation
Normal server usage
PageMemory (MB)CPU Time (ms)
Home /3.48 ▲0.0239.15 ▼0.00
Dashboard /wp-admin3.33 ▲0.0350.42 ▼2.79
Posts /wp-admin/edit.php3.38 ▲0.0349.14 ▼8.57
Add New Post /wp-admin/post-new.php5.93 ▲0.0588.53 ▼12.19
Media Library /wp-admin/upload.php3.26 ▲0.0340.16 ▲4.83
Documentation /wp-admin/admin.php?page=wpg-docs3.2232.16
Settings /wp-admin/admin.php?page=wpg-docs-settings3.2841.01

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

A short overview of filesystem and database impact
This plugin was installed successfully
Filesystem: 20 new files
Database: no new tables, 6 new options
New WordPress options
widget_recent-comments
widget_recent-posts
can_compress_scripts
widget_theysaidso_widget
theysaidso_admin_options
db_upgraded

Browser metrics Passed 4 tests

This is an overview of browser requirements for Easy-Documentation
This plugin renders optimally with no browser resource issues detected
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,829 ▲6813.75 ▼0.621.92 ▲0.0441.51 ▲0.05
Dashboard /wp-admin2,232 ▲555.22 ▼0.4294.01 ▼4.5841.21 ▼0.39
Posts /wp-admin/edit.php2,140 ▲402.18 ▲0.1644.79 ▲6.4832.87 ▼5.27
Add New Post /wp-admin/post-new.php1,571 ▲2223.25 ▲5.06650.05 ▼7.7538.28 ▼22.27
Media Library /wp-admin/upload.php1,502 ▲994.66 ▲0.39115.48 ▲15.3747.58 ▲3.43
Documentation /wp-admin/admin.php?page=wpg-docs8282.1228.7723.06
Settings /wp-admin/admin.php?page=wpg-docs-settings1,5977.05137.63138.15

Uninstaller [IO: ▲0.00MB] [DB: ▲0.00MB] 75% from 4 tests

🔸 Tests weight: 35 | Verifying that this plugin uninstalls completely without leaving any traces
These items require your attention
  • Zombie WordPress options were found after uninstall: 6 options
    • widget_theysaidso_widget
    • can_compress_scripts
    • db_upgraded
    • widget_recent-comments
    • theysaidso_admin_options
    • widget_recent-posts

Smoke tests 75% from 4 tests

Server-side errors Passed 1 test

🔹 Test weight: 20 | A smoke test targeting server-side errors
Everything seems fine, however this is by no means an exhaustive test

SRP 50% from 2 tests

🔹 Tests weight: 20 | The single-responsibility principle: PHP files have to remain inert when accessed directly, throwing no errors and performing no actions
Please take a closer look at the following
  • 1× PHP files perform the task of outputting text when accessed with GET requests:
    • > /wp-content/plugins/easy-documentation/easy-docs.php

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)
No browser errors were detected

Optimizations

Plugin configuration 93% from 29 tests

readme.txt 94% from 16 tests

Perhaps the most important file in your plugin readme.txt gets parsed in order to generate the public listing of your plugin
These attributes need to be fixed:
  • Screenshots: These screenshots do not have images: #1 ('/assets/Screenshot1.jpg'), #2 ('/assets/Screenshot2.jpg'), #3 ('/assets/Screenshot3.jpg')
Please take inspiration from this readme.txt

easy-documentation/easy-docs.php 92% from 13 tests

The primary PHP file in "Easy-Documentation" version 0.1 is used by WordPress to initiate all plugin functionality
It is important to fix the following:
  • Main file name: It is recommended to name the main PHP file as the plugin slug ("easy-documentation.php" instead of "easy-docs.php")

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | A short check of programming languages and file extensions; no executable files are allowed
No dangerous file extensions were detected2,254 lines of code in 11 files:
LanguageFilesBlank linesComment linesLines of code
JavaScript81053121,855
CSS2281267
PHP13213132

PHP code Passed 2 tests

This plugin's cyclomatic complexity and code structure detailed below
There were no cyclomatic complexity issued detected
Cyclomatic complexity
Average complexity per logical line of code0.07
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%
Functions9
▷ Named functions9100.00%
▷ Anonymous functions00.00%
Constants0
▷ Global constants00.00%
▷ Class constants00.00%
▷ Public constants00.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Often times overlooked, PNG files can occupy unnecessary space in your plugin
PNG images were not found in this plugin