72% superdocs

Code Review | SuperDocs - The Ultimate Knowledge Base, Wiki And Documentation Builder

WordPress plugin SuperDocs - The Ultimate Knowledge Base, Wiki And Documentation Builder scored72%from 54 tests.

About plugin

  • Plugin page: superdocs
  • Plugin version: 1.0.3-beta1...
  • PHP compatiblity: 7.4+
  • PHP version: 7.4.16
  • WordPress compatibility: 6.0-6.2
  • WordPress version: 6.3.1
  • First release: Dec 28, 2022
  • Latest release: May 25, 2023
  • Number of updates: 13
  • Update frequency: every 11.5 days
  • Top authors: doatkolom (100%)

Code review

54 tests

User reviews

1 review

Install metrics

10+ active /667 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | Checking the installer triggered no errors
The plugin installed gracefully, with no errors

Server metrics [RAM: ▲0.34MB] [CPU: ▼1.83ms] Passed 4 tests

Server-side resources used by SuperDocs - The Ultimate Knowledge Base, Wiki And Documentation Builder
No issues were detected with server-side resource usage
PageMemory (MB)CPU Time (ms)
Home /3.79 ▲0.3344.16 ▲1.56
Dashboard /wp-admin3.68 ▲0.3450.14 ▼12.20
Posts /wp-admin/edit.php3.72 ▲0.3755.53 ▲12.23
Add New Post /wp-admin/post-new.php6.45 ▲0.5695.65 ▼4.12
Media Library /wp-admin/upload.php3.54 ▲0.3242.84 ▲7.44
All Docs /wp-admin/edit.php?post_type=superdocs3.7142.09
Templates /wp-admin/edit.php?post_type=superdocstemplate3.6646.18
Products /wp-admin/edit.php?product=true&post_type=superdocs3.6942.82
Categories /wp-admin/admin.php?page=superdocs-categories3.5640.95
Settings /wp-admin/admin.php?page=superdocs-settings3.5538.91

Server storage [IO: ▲0.58MB] [DB: ▲0.08MB] Passed 3 tests

Input-output and database impact of this plugin
This plugin was installed successfully
Filesystem: 109 new files
Database: no new tables, 6 new options
New WordPress options
widget_recent-posts
theysaidso_admin_options
can_compress_scripts
widget_recent-comments
db_upgraded
widget_theysaidso_widget

Browser metrics Passed 4 tests

SuperDocs - The Ultimate Knowledge Base, Wiki And Documentation Builder: an overview of browser usage
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,923 ▲15213.17 ▼1.111.51 ▼0.3543.99 ▲0.33
Dashboard /wp-admin2,326 ▲1466.02 ▲0.3489.93 ▲0.2737.20 ▼0.05
Posts /wp-admin/edit.php2,199 ▲1202.33 ▲0.2037.30 ▲2.2734.30 ▲3.51
Add New Post /wp-admin/post-new.php2,048 ▲52023.37 ▲0.36614.93 ▼17.8233.18 ▼22.61
Media Library /wp-admin/upload.php1,584 ▲1814.50 ▲0.24103.58 ▲5.5640.39 ▼5.33
All Docs /wp-admin/edit.php?post_type=superdocs1,2922.5440.2226.04
Templates /wp-admin/edit.php?post_type=superdocstemplate1,2782.3745.9432.19
Products /wp-admin/edit.php?product=true&post_type=superdocs1,2592.4848.8029.69
Categories /wp-admin/admin.php?page=superdocs-categories1,0102.6148.0334.88
Settings /wp-admin/admin.php?page=superdocs-settings1,2532.4950.5754.21

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

🔸 Tests weight: 35 | Checking the uninstaller removed all traces of the plugin
The following items require your attention
  • This plugin does not fully uninstall, leaving 6 options in the database
    • widget_recent-comments
    • db_upgraded
    • widget_recent-posts
    • theysaidso_admin_options
    • can_compress_scripts
    • widget_theysaidso_widget

Smoke tests 25% 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 0% from 2 tests

🔹 Tests weight: 20 | SRP (Single-Responsibility Principle) - PHP files must act as libraries and never output text or perform any action when accessed directly in a browser
The following issues need your attention
  • 2× PHP files perform the task of outputting text when accessed with GET requests:
    • > /wp-content/plugins/superdocs/resources/views/admin/pages/docs/cpt-filter.php
    • > /wp-content/plugins/superdocs/resources/views/admin/pages/products/footer.php
  • 54× GET requests to PHP files have triggered server-side errors or warnings (only 10 are shown):
    • > PHP Fatal error
      Uncaught Error: Class 'Elementor\\Widget_Base' not found in wp-content/plugins/superdocs/app/Widgets/NavCategories.php:11
    • > PHP Fatal error
      Uncaught Error: Class 'WpCommander\\Route\\RegisterRoute' not found in wp-content/plugins/superdocs/bootstrap/RegisterRoute.php:7
    • > PHP Fatal error
      Uncaught Error: Class 'Elementor\\Widget_Base' not found in wp-content/plugins/superdocs/app/Widgets/TableOfContent.php:10
    • > PHP Fatal error
      Uncaught Error: Class 'WpCommander\\View\\View' not found in wp-content/plugins/superdocs/bootstrap/View.php:7
    • > PHP Fatal error
      Uncaught Error: Class 'Elementor\\Widget_Base' not found in wp-content/plugins/superdocs/app/Widgets/NextPrev.php:13
    • > PHP Fatal error
      Uncaught Error: Class 'SuperDocs\\Bootstrap\\Route' not found in wp-content/plugins/superdocs/routes/api.php:11
    • > PHP Fatal error
      Uncaught Error: Class 'DoatKolom\\Ui\\Utils\\Common' not found in wp-content/plugins/superdocs/resources/views/admin/pages/category/create.php:6
    • > PHP Fatal error
      Uncaught Error: Class 'DoatKolom\\Ui\\Components\\Tab' not found in wp-content/plugins/superdocs/resources/views/admin/pages/settings/index.php:18
    • > PHP Fatal error
      Uncaught Error: Class 'Elementor\\Widget_Base' not found in wp-content/plugins/superdocs/app/Widgets/ContentArea.php:7
    • > PHP Fatal error
      Uncaught Error: Class 'WpCommander\\Contracts\\ServiceProvider' not found in wp-content/plugins/superdocs/app/Providers/TemplateServiceProvider.php:11

User-side errors 0% from 1 test

🔹 Test weight: 20 | This is a smoke test targeting browser errors/issues
Please fix the following browser errors
    • > GET request to /wp-admin/admin.php?page=superdocs-categories
    • > Javascript (severe) in unknown
    /wp-content/plugins/superdocs/vendor/doatkolom/ui/assets/js/doatkolom-ui.js?ver=1.0.3-beta1 0:3493 Uncaught TypeError: Cannot read properties of undefined (reading 'content_api')

Optimizations

Plugin configuration 93% from 29 tests

readme.txt Passed 16 tests

It's important to format your readme.txt file correctly as it is parsed for the public listing of your plugin
7 plugin tags: docs, wiki, wiki builder, documentation, documentation builder...

superdocs/superdocs.php 85% from 13 tests

The main PHP script in "SuperDocs - The Ultimate Knowledge Base, Wiki And Documentation Builder" version 1.0.3-beta1... is automatically included on every request by WordPress
You should first fix the following items:
  • Description: Please keep the plugin description shorter than 140 characters (currently 246 characters long)
  • Version: Use periods and digits only for your plugin's version number (ex. "1.0.3" instead of "1.0.3-beta1...")

Code Analysis Passed 3 tests

File types Passed 1 test

🔸 Test weight: 35 | A short review of files and their extensions; it is not recommended to include executable files
Success! There were no dangerous files found in this plugin7,112 lines of code in 100 files:
LanguageFilesBlank linesComment linesLines of code
PHP868945937,005
JSON20092
JavaScript82910
CSS4005

PHP code Passed 2 tests

Analyzing cyclomatic complexity and code structure
This plugin has no cyclomatic complexity issues
Cyclomatic complexity
Average complexity per logical line of code0.28
Average class complexity6.21
▷ Minimum class complexity1.00
▷ Maximum class complexity47.00
Average method complexity2.15
▷ Minimum method complexity1.00
▷ Maximum method complexity24.00
Code structure
Namespaces20
Interfaces1
Traits1
Classes51
▷ Abstract classes917.65%
▷ Concrete classes4282.35%
▷ Final classes24.76%
Methods246
▷ Static methods5221.14%
▷ Public methods21286.18%
▷ Protected methods2710.98%
▷ Private methods72.85%
Functions29
▷ Named functions1551.72%
▷ Anonymous functions1448.28%
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
No PNG images were found in this plugin