@wporg/plugin-check 0.1.0

package/bin/plugin-check.mjs

@@ -0,0 +1,231 @@
+#!/usr/bin/env node
+
+import { execFileSync } from 'node:child_process';
+import { createWriteStream } from 'node:fs';
+import {
+	mkdir,
+	mkdtemp,
+	readFile,
+	rm,
+	stat,
+	writeFile,
+} from 'node:fs/promises';
+import { tmpdir } from 'node:os';
+import { basename, join, resolve } from 'node:path';
+import { pipeline } from 'node:stream/promises';
+import { fileURLToPath } from 'node:url';
+
+export const PCP_CHECK_PHP = `<?php
+ob_start();
+try {
+	WP_CLI::run_command(
+		array( 'plugin', 'check', PLUGIN_SLUG ),
+		array(
+			'categories'                  => 'plugin_repo',
+			'format'                      => 'json',
+			'error-severity'              => '7',
+			'warning-severity'            => '6',
+			'include-low-severity-errors' => true,
+			'exclude-checks'              => 'prefixing',
+		)
+	);
+} catch ( Exception $e ) {}
+$output = ob_get_clean();
+$output = preg_replace( '/<br\\s*\\/?>\\s*<b>Warning<\\/b>.*?<\\/b><br\\s*\\/?>\\s*/s', '', $output );
+file_put_contents( '/output/results.txt', trim( $output ) );
+`;
+
+export function buildBlueprint( slug ) {
+	const steps = [];
+
+	// Skip installing PCP separately when checking PCP itself — it's already mounted.
+	if ( slug !== 'plugin-check' ) {
+		steps.push( {
+			step: 'installPlugin',
+			pluginData: {
+				resource: 'wordpress.org/plugins',
+				slug: 'plugin-check',
+			},
+		} );
+	}
+
+	steps.push(
+		{ step: 'wp-cli', command: 'wp plugin activate plugin-check' },
+		{ step: 'wp-cli', command: 'wp eval-file /pcp-check.php' }
+	);
+
+	return { steps };
+}
+
+export function getSlugFromZip( zipPath ) {
+	const output = execFileSync( 'unzip', [ '-l', zipPath ], {
+		encoding: 'utf8',
+	} );
+	for ( const line of output.split( '\n' ) ) {
+		const match = line.match( /\s+(\S+)\/$/ );
+		if ( match && ! match[ 1 ].includes( '/' ) ) {
+			return match[ 1 ];
+		}
+	}
+	throw new Error( `Could not determine plugin slug from zip: ${ zipPath }` );
+}
+
+function extractZip( zipPath, destDir ) {
+	execFileSync( 'unzip', [ '-o', '-q', zipPath, '-d', destDir ] );
+}
+
+export function detectInputType( input ) {
+	if ( input.startsWith( 'http://' ) || input.startsWith( 'https://' ) ) {
+		return 'remote-zip';
+	}
+	if ( input.toLowerCase().endsWith( '.zip' ) ) {
+		return 'local-zip';
+	}
+	return 'directory';
+}
+
+async function downloadFile( url, destPath ) {
+	const response = await fetch( url );
+	if ( ! response.ok ) {
+		throw new Error(
+			`Failed to download ${ url }: ${ response.status } ${ response.statusText }`
+		);
+	}
+	await pipeline( response.body, createWriteStream( destPath ) );
+}
+
+function resolvePlaygroundBin() {
+	const __dirname = fileURLToPath( new URL( '.', import.meta.url ) );
+	const localBin = join(
+		__dirname,
+		'..',
+		'node_modules',
+		'.bin',
+		'wp-playground-cli'
+	);
+
+	try {
+		execFileSync( localBin, [ '--version' ], { stdio: 'ignore' } );
+		return localBin;
+	} catch {
+		// Fall back to npx when the local bin isn't available (e.g. global install).
+		return 'wp-playground-cli';
+	}
+}
+
+async function main() {
+	const input = process.argv[ 2 ];
+
+	if ( ! input || input === '--help' || input === '-h' ) {
+		console.log( `Usage: plugin-check <plugin-path|plugin.zip|url>
+
+Run WordPress Plugin Check against a plugin.
+
+Arguments:
+  plugin-path   Path to a local plugin directory
+  plugin.zip    Path to a local plugin zip file
+  url           URL to a remote plugin zip file
+
+Examples:
+  plugin-check ./my-plugin
+  plugin-check ./my-plugin.zip
+  plugin-check https://example.com/my-plugin.zip` );
+		process.exit( 0 );
+	}
+
+	const inputType = detectInputType( input );
+	const tmpDir = await mkdtemp( join( tmpdir(), 'pcp-' ) );
+
+	try {
+		let pluginPath, slug;
+
+		if ( inputType === 'directory' ) {
+			pluginPath = resolve( input );
+			const stats = await stat( pluginPath );
+			if ( ! stats.isDirectory() ) {
+				console.error( `Error: ${ pluginPath } is not a directory.` );
+				process.exit( 1 );
+			}
+			slug = basename( pluginPath );
+		} else {
+			let zipPath;
+			if ( inputType === 'local-zip' ) {
+				zipPath = resolve( input );
+				await stat( zipPath ); // Throws if missing.
+			} else {
+				console.error( `Downloading ${ input }...` );
+				zipPath = join( tmpDir, 'plugin.zip' );
+				await downloadFile( input, zipPath );
+			}
+			slug = getSlugFromZip( zipPath );
+			const extractDir = join( tmpDir, 'plugin' );
+			extractZip( zipPath, extractDir );
+			pluginPath = join( extractDir, slug );
+		}
+
+		// Write temp files.
+		await writeFile(
+			join( tmpDir, 'blueprint.json' ),
+			JSON.stringify( buildBlueprint( slug ) )
+		);
+		await writeFile( join( tmpDir, 'pcp-check.php' ), PCP_CHECK_PHP );
+		await mkdir( join( tmpDir, 'output' ), { recursive: true } );
+
+		// Build Playground CLI args.
+		const args = [
+			'run-blueprint',
+			'--define',
+			'PLUGIN_SLUG',
+			slug,
+			'--mount',
+			`${ pluginPath }:/wordpress/wp-content/plugins/${ slug }`,
+			'--mount',
+			`${ tmpDir }/pcp-check.php:/pcp-check.php`,
+			'--mount',
+			`${ tmpDir }/output:/output`,
+			'--blueprint',
+			`${ tmpDir }/blueprint.json`,
+			'--quiet',
+		];
+
+		// Run Playground CLI.
+		execFileSync( resolvePlaygroundBin(), args, {
+			stdio: [ 'ignore', 'inherit', 'inherit' ],
+		} );
+
+		// Read results.
+		let results = '';
+		try {
+			results = await readFile(
+				join( tmpDir, 'output', 'results.txt' ),
+				'utf8'
+			);
+		} catch {
+			// No results file = plugin passed or PCP crashed.
+		}
+
+		if ( ! results.trim() ) {
+			console.log( 'Plugin Check passed — no issues found.' );
+			process.exit( 0 );
+		}
+
+		process.stdout.write( results + '\n' );
+
+		const hasErrors =
+			results.includes( '"type":"ERROR"' ) ||
+			results.includes( '"type": "ERROR"' );
+		process.exit( hasErrors ? 1 : 0 );
+	} finally {
+		await rm( tmpDir, { recursive: true, force: true } );
+	}
+}
+
+// Only run when executed directly, not when imported for testing.
+const isDirectRun =
+	process.argv[ 1 ] &&
+	resolve( process.argv[ 1 ] ) ===
+		resolve( fileURLToPath( import.meta.url ) );
+
+if ( isDirectRun ) {
+	main();
+}

package/package.json

@@ -0,0 +1,33 @@
+{
+	"name": "@wporg/plugin-check",
+	"version": "0.1.0",
+	"description": "Run WordPress Plugin Check locally via Playground CLI.",
+	"type": "module",
+	"license": "GPL-2.0-or-later",
+	"bin": {
+		"plugin-check": "bin/plugin-check.mjs"
+	},
+	"files": [
+		"bin/plugin-check.mjs"
+	],
+	"scripts": {
+		"test": "node --test test/*.test.mjs"
+	},
+	"keywords": [
+		"wordpress",
+		"plugin-check",
+		"playground",
+		"wp-cli",
+		"linter",
+		"static-analysis"
+	],
+	"engines": {
+		"node": ">=20"
+	},
+	"dependencies": {
+		"@wp-playground/cli": "^3.1.13"
+	},
+	"devDependencies": {
+		"@wordpress/scripts": "^31.7.0"
+	}
+}