84% wp-readme-parser

Code Review | Plugin README Parser

WordPress plugin Plugin README Parser scored84%from 54 tests.

About plugin

  • Plugin page: wp-readme-parser
  • Plugin version: 1.3.8
  • PHP compatiblity: 7.4+
  • PHP version: 7.4.16
  • WordPress compatibility: 4.6-6.4
  • WordPress version: 6.3.1
  • First release: Oct 20, 2010
  • Latest release: Nov 24, 2023
  • Number of updates: 279
  • Update frequency: every 17.2 days
  • Top authors: dartiss (94.98%)codedart (5.38%)

Code review

54 tests

User reviews

2 reviews

Install metrics

20+ active /4,253 total downloads

Benchmarks

Plugin footprint 83% from 16 tests

Installer Passed 1 test

🔺 Critical test (weight: 50) | The install procedure must perform silently
Install script ran successfully

Server metrics [RAM: ▲0.43MB] [CPU: ▼2.31ms] Passed 4 tests

Server-side resources used by Plugin README Parser
This plugin has minimal impact on server resources
PageMemory (MB)CPU Time (ms)
Home /3.93 ▲0.4640.58 ▲2.22
Dashboard /wp-admin3.78 ▲0.4357.52 ▼4.59
Posts /wp-admin/edit.php3.83 ▲0.4750.78 ▲4.23
Add New Post /wp-admin/post-new.php6.30 ▲0.4186.32 ▼11.08
Media Library /wp-admin/upload.php3.64 ▲0.4141.97 ▲9.06

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

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

Browser metrics Passed 4 tests

Checking browser requirements for Plugin README Parser
There were no issues detected in relation to browser resource usage
PageNodesMemory (MB)Script (ms)Layout (ms)
Home /2,790 ▲4314.23 ▼0.451.74 ▲0.1636.04 ▼8.02
Dashboard /wp-admin2,198 ▲215.64 ▲0.0994.95 ▼6.3842.03 ▲1.13
Posts /wp-admin/edit.php2,097 ▼61.96 ▼0.0639.08 ▼3.1436.78 ▼0.71
Add New Post /wp-admin/post-new.php1,526 ▼1023.06 ▼0.06677.02 ▲65.9259.50 ▼2.19
Media Library /wp-admin/upload.php1,400 ▼34.18 ▼0.03115.32 ▲17.6548.43 ▲8.18

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

🔸 Tests weight: 35 | All plugins must uninstall correctly, removing their source code and extra database tables they might have created
Please fix the following items
  • This plugin does not fully uninstall, leaving 6 options in the database
    • can_compress_scripts
    • widget_theysaidso_widget
    • widget_recent-posts
    • widget_recent-comments
    • theysaidso_admin_options
    • db_upgraded

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 | A shallow check of the single-responsibility principle; PHP files should perform no action - including output of placeholder text - and trigger no errors when accessed directly
Please take a closer look at the following
  • 5× GET requests to PHP files trigger server-side errors or Error 500 responses:
    • > PHP Fatal error
      Uncaught Error: Class 'Michelf\\Markdown' not found in wp-content/plugins/wp-readme-parser/includes/Michelf/MarkdownExtra.php:20
    • > PHP Fatal error
      Uncaught Error: Call to undefined function plugin_dir_path() in wp-content/plugins/wp-readme-parser/wp-readme-parser.php:30
    • > PHP Fatal error
      Uncaught Error: Interface 'Michelf\\MarkdownInterface' not found in wp-content/plugins/wp-readme-parser/includes/Michelf/Markdown.php:20
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_shortcode() in wp-content/plugins/wp-readme-parser/includes/generate-output.php:424
    • > PHP Fatal error
      Uncaught Error: Call to undefined function add_filter() in wp-content/plugins/wp-readme-parser/includes/admin-config.php:29

User-side errors Passed 1 test

🔹 Test weight: 20 | This is a shallow check for browser errors
No browser issues were found

Optimizations

Plugin configuration Passed 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
6 plugin tags: adopt-me, readme, plugin, embed, parser...

wp-readme-parser/wp-readme-parser.php Passed 13 tests

This is the main PHP file of "Plugin README Parser" version 1.3.8, providing information about the plugin in the header fields and serving as the principal entry point to the plugin's functions
90 characters long description:
Display a WordPress plugin's README file in XHTML format, for embedding on a post or page.

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
No dangerous file extensions were detected2,566 lines of code in 11 files:
LanguageFilesBlank linesComment linesLines of code
PHP107201,1272,536
Markdown16030

PHP code Passed 2 tests

A short review of cyclomatic complexity and code structure
There were no cyclomatic complexity issued detected
Cyclomatic complexity
Average complexity per logical line of code0.32
Average class complexity63.33
▷ Minimum class complexity1.00
▷ Maximum class complexity112.00
Average method complexity2.95
▷ Minimum method complexity1.00
▷ Maximum method complexity24.00
Code structure
Namespaces1
Interfaces1
Traits0
Classes2
▷ Abstract classes00.00%
▷ Concrete classes2100.00%
▷ Final classes00.00%
Methods98
▷ Static methods22.04%
▷ Public methods66.12%
▷ Protected methods9293.88%
▷ Private methods00.00%
Functions14
▷ Named functions14100.00%
▷ Anonymous functions00.00%
Constants2
▷ Global constants150.00%
▷ Class constants150.00%
▷ Public constants1100.00%

Plugin size Passed 2 tests

Image compression Passed 2 tests

Using a strong compression for your PNG files is a great way to speed-up your plugin
PNG images were not found in this plugin