Skip to content

feat: Add SVN checker #1437

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ernilambar wants to merge 1 commit into
base: trunk
Choose a base branch
from
Draft

feat: Add SVN checker #1437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions assets/css/plugin-check-svn-checker.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
.plugin-check-svn-checker-wrap {
max-width: 1200px;
}
.plugin-check-svn-checker-wrap .plugin-check-svn-checker-inner {
margin-top: 10px;
}

/* ---------- Search form ---------- */
.plugin-check-svn-checker-form {
margin-bottom: 20px;
}
.plugin-check-svn-checker-search-row {
display: flex;
gap: 8px;
align-items: center;
}
.plugin-check-svn-checker-search-row .spinner {
float: none;
margin: 0;
}
.plugin-check-svn-checker-slug-input {
flex: 1;
max-width: 400px;
}

/* ---------- Plugin name ---------- */
.plugin-check-svn-checker-plugin-name {
font-size: 16px;
font-weight: 600;
margin-bottom: 16px;
}

/* ---------- SVN external link in section heading ---------- */
.plugin-check-svn-checker-svn-link {
vertical-align: middle;
text-decoration: none;
}
.plugin-check-svn-checker-svn-link .dashicons {
font-size: 20px;
width: 20px;
height: 20px;
}

/* ---------- Inline checks (root section) ---------- */
.plugin-check-svn-checker-inline-checks {
display: flex;
flex-wrap: wrap;
gap: 16px;
margin-bottom: 20px;
}

/* ---------- Checks table ---------- */
.plugin-check-svn-checker-col-status {
width: 90px;
}
.plugin-check-svn-checker-col-check {
width: 40%;
}

.plugin-check-svn-checker-row-warn td {
background: #fffcf0 !important;
}
.plugin-check-svn-checker-row-fail td {
background: #fff5f5 !important;
}

/* ---------- Status badge ---------- */
.plugin-check-svn-checker-badge-pass {
color: #00a32a;
}
.plugin-check-svn-checker-badge-warn {
color: #c07a00;
}
.plugin-check-svn-checker-badge-fail {
color: #d63638;
}
.plugin-check-svn-checker-badge-info {
color: #2271b1;
}

/* ---------- Detail text ---------- */
.plugin-check-svn-checker-detail-text {
font-size: 13px;
font-family: monospace;
}

@media (max-width: 782px) {
.plugin-check-svn-checker-col-detail {
display: none;
}
}
171 changes: 171 additions & 0 deletions assets/js/plugin-check-svn-checker.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,171 @@
/* global pluginCheckSvnChecker */
( function () {
'use strict';

const form = document.getElementById( 'plugin-check-svn-checker-form' );
const result = document.getElementById( 'plugin-check-svn-checker-result' );

if ( ! form || ! result ) {
return;
}

const spinner = document.getElementById(
'plugin-check-svn-checker-spinner'
);
const { i18n } = pluginCheckSvnChecker;

form.addEventListener( 'submit', async ( e ) => {
e.preventDefault();

const slug = document
.getElementById( 'plugin-check-svn-checker-slug-input' )
.value.trim();

result.innerHTML = '';
spinner.classList.add( 'is-active' );

try {
const params = new URLSearchParams();
params.set( 'action', pluginCheckSvnChecker.action );
params.set( 'nonce', pluginCheckSvnChecker.nonce );
params.set( 'slug', slug );

const res = await fetch( pluginCheckSvnChecker.ajaxUrl, {
method: 'POST',
headers: {
'Content-Type': 'application/x-www-form-urlencoded',
},
body: params,
} );

const { success, data } = await res.json();

if ( ! success ) {
result.innerHTML = `<div class="notice notice-error inline"><p>${ esc(
( data && data.message ) || i18n.error
) }</p></div>`;
return;
}

result.innerHTML = renderReport( data );
} catch {
result.innerHTML = `<div class="notice notice-error inline"><p>${ esc(
i18n.requestFailed
) }</p></div>`;
} finally {
spinner.classList.remove( 'is-active' );
}
} );

function renderReport( data ) {
const { meta, sections } = data;
let html = '';

if ( meta.plugin_name ) {
html += `<p class="plugin-check-svn-checker-plugin-name">${ esc(
meta.plugin_name
) }</p><hr>`;
}

// Sections.
for ( const section of sections ) {
if ( ! section.checks.length ) {
continue;
}

const svnLink =
section.id === 'root' && meta.svn_url
? ` <a href="${ esc(
meta.svn_url
) }" target="_blank" rel="noopener" class="plugin-check-svn-checker-svn-link" title="${ esc(
i18n.viewInSvn
) }"><span class="dashicons dashicons-external"></span></a>`
: '';
html += `<h2>${ esc( section.label ) }${ svnLink }</h2>`;

if ( section.id === 'root' ) {
html += '<div class="plugin-check-svn-checker-inline-checks">';
for ( const check of section.checks ) {
html += `<span class="plugin-check-svn-checker-inline-check" title="${ esc(
check.detail
) }">${ badge( check.status ) } ${ esc(
check.label
) }</span>`;
}
html += '</div>';
} else {
html +=
'<table class="wp-list-table widefat striped plugin-check-svn-checker-checks-table">' +
'<thead><tr>' +
`<th class="plugin-check-svn-checker-col-status">${ esc(
i18n.colStatus
) }</th>` +
`<th class="plugin-check-svn-checker-col-check">${ esc(
i18n.colCheck
) }</th>` +
`<th class="plugin-check-svn-checker-col-detail">${ esc(
i18n.colDetail
) }</th>` +
'</tr></thead><tbody>';

for ( const check of section.checks ) {
html += `<tr class="plugin-check-svn-checker-check-row plugin-check-svn-checker-row-${ esc(
check.status
) }">`;
html += `<td class="plugin-check-svn-checker-col-status">${ badge(
check.status
) }</td>`;
html += `<td class="plugin-check-svn-checker-col-check">${ esc(
check.label
) }</td>`;
html += `<td class="plugin-check-svn-checker-col-detail"><span class="plugin-check-svn-checker-detail-text">${ esc(
check.detail
) }</span></td>`;
html += '</tr>';
}

html += '</tbody></table>';
}
}

return html;
}

function badge( status ) {
const map = {
pass: [
'dashicons-yes-alt',
i18n.pass,
'plugin-check-svn-checker-badge-pass',
],
warn: [
'dashicons-info',
i18n.warning,
'plugin-check-svn-checker-badge-warn',
],
fail: [
'dashicons-dismiss',
i18n.fail,
'plugin-check-svn-checker-badge-fail',
],
info: [
'dashicons-info',
i18n.info,
'plugin-check-svn-checker-badge-info',
],
};
const [ icon, label, cls ] = map[ status ] || map.warn;
return `<span class="plugin-check-svn-checker-status-badge ${ cls }"><span class="dashicons ${ icon }"></span> ${ esc(
label
) }</span>`;
}

function esc( str ) {
return String( str ?? '' )
.replace( /&/g, '&amp;' )
.replace( /</g, '&lt;' )
.replace( />/g, '&gt;' )
.replace( /"/g, '&quot;' )
.replace( /'/g, '&#039;' );
}
} )();
Loading
Loading