@automattic/jetpack-cli 0.1.0-beta.2 → 1.0.0-beta1

package/README.md

@@ -0,0 +1,18 @@
+# Jetpack
+
+
+## How to install Jetpack plugin on your site
+### Installation From Git Repo
+
+## Contribute
+
+## Get Help
+
+## Security
+
+Need to report a security vulnerability? Go to [https://automattic.com/security/](https://automattic.com/security/) or directly to our security bug bounty site [https://hackerone.com/automattic](https://hackerone.com/automattic).
+
+## License
+
+Licensed under [GNU General Public License v2 (or later)](./LICENSE.txt).
+

package/bin/jp.js

@@ -1,12 +1,32 @@
 #!/usr/bin/env node
 
 import { spawnSync } from 'child_process';
-import fs from 'fs';
+import fs, { readFileSync } from 'fs';
 import { dirname, resolve } from 'path';
 import process from 'process';
+import { fileURLToPath } from 'url';
 import chalk from 'chalk';
 import dotenv from 'dotenv';
 import prompts from 'prompts';
+import updateNotifier from 'update-notifier';
+
+// Get package.json path relative to this file
+const __dirname = dirname( fileURLToPath( import.meta.url ) );
+const packageJson = JSON.parse( readFileSync( resolve( __dirname, '../package.json' ), 'utf8' ) );
+
+// Check for updates
+const notifier = updateNotifier( {
+	pkg: packageJson,
+	updateCheckInterval: 1000 * 60 * 60 * 24, // Check once per day
+} );
+
+// Show update notification
+notifier.notify( {
+	message:
+		'Update available for Jetpack CLI: {currentVersion} → {latestVersion}\n' +
+		'Run {updateCommand} to update',
+	isGlobal: true,
+} );
 
 /**
  * Check if a directory is the monorepo root.
@@ -30,10 +50,13 @@ const isMonorepoRoot = dir => {
  */
 const findMonorepoRoot = startDir => {
 	let dir = startDir;
-	while ( dir !== '/' ) {
+	let prevDir;
+	while ( dir !== prevDir ) {
+		// Keep going until dirname() stops changing the path
 		if ( isMonorepoRoot( dir ) ) {
 			return dir;
 		}
+		prevDir = dir;
 		dir = dirname( dir );
 	}
 	return null;
@@ -46,7 +69,6 @@ const findMonorepoRoot = startDir => {
  * @throws {Error} If clone fails
  */
 const cloneMonorepo = async targetDir => {
-	// eslint-disable-next-line no-console
 	console.log( chalk.blue( 'Cloning Jetpack monorepo...' ) );
 	const result = spawnSync(
 		'git',
@@ -84,15 +106,15 @@ const initJetpack = async () => {
 
 	try {
 		await cloneMonorepo( targetDir );
-		// eslint-disable-next-line no-console
+
 		console.log( chalk.green( '\nJetpack monorepo has been cloned successfully!' ) );
-		// eslint-disable-next-line no-console
+
 		console.log( '\nNext steps:' );
-		// eslint-disable-next-line no-console
+
 		console.log( '1. cd', response.directory );
-		// eslint-disable-next-line no-console
+
 		console.log( '2. jp docker up' );
-		// eslint-disable-next-line no-console
+
 		console.log( '3. jp docker install' );
 	} catch ( error ) {
 		throw new Error( `Failed to initialize Jetpack: ${ error.message }` );
@@ -104,6 +126,12 @@ const main = async () => {
 	try {
 		const args = process.argv.slice( 2 );
 
+		// Handle version flag
+		if ( args[ 0 ] === '--version' || args[ 0 ] === '-v' ) {
+			console.log( chalk.green( packageJson.version ) );
+			return;
+		}
+
 		// Handle 'init' command specially
 		if ( args[ 0 ] === 'init' ) {
 			await initJetpack();
@@ -114,144 +142,168 @@ const main = async () => {
 		const monorepoRoot = findMonorepoRoot( process.cwd() );
 
 		if ( ! monorepoRoot ) {
-			// eslint-disable-next-line no-console
 			console.error( chalk.red( 'Could not find Jetpack monorepo.' ) );
-			// eslint-disable-next-line no-console
+
 			console.log( '\nTo get started:' );
-			// eslint-disable-next-line no-console
+
 			console.log( '1. Run', chalk.blue( 'jp init' ), 'to clone the repository' );
-			// eslint-disable-next-line no-console
+
 			console.log( '   OR' );
-			// eslint-disable-next-line no-console
+
 			console.log( '2. Navigate to an existing Jetpack monorepo directory' );
 			throw new Error( 'Monorepo not found' );
 		}
 
-		// Handle docker commands on the host
+		// Handle docker commands that must run on the host machine
 		if ( args[ 0 ] === 'docker' ) {
-			// Commands that should run in the container
-			const containerCommands = [ 'build-image', 'install' ];
-			if ( containerCommands.includes( args[ 1 ] ) ) {
-				const result = spawnSync(
-					resolve( monorepoRoot, 'tools/docker/bin/monorepo' ),
-					[ 'pnpm', 'jetpack', ...args ],
-					{
-						stdio: 'inherit',
-						shell: true,
-						cwd: monorepoRoot,
-					}
-				);
+			const hostCommands = [ 'up', 'down', 'stop', 'clean' ];
+			if ( hostCommands.includes( args[ 1 ] ) ) {
+				// Handle command-specific setup/cleanup
+				if ( args[ 1 ] === 'up' ) {
+					// Create required directories
+					fs.mkdirSync( resolve( monorepoRoot, 'tools/docker/data/jetpack_dev_mysql' ), {
+						recursive: true,
+					} );
+					fs.mkdirSync( resolve( monorepoRoot, 'tools/docker/data/ssh.keys' ), {
+						recursive: true,
+					} );
+					fs.mkdirSync( resolve( monorepoRoot, 'tools/docker/wordpress' ), { recursive: true } );
 
-				if ( result.status !== 0 ) {
-					throw new Error( `Command failed with status ${ result.status }` );
-				}
-				return;
-			}
+					// Create empty .env file
+					fs.writeFileSync( resolve( monorepoRoot, 'tools/docker/.env' ), '' );
 
-			// Run config generation first if this is an 'up' command
-			if ( args[ 1 ] === 'up' ) {
-				// Create required directories
-				fs.mkdirSync( resolve( monorepoRoot, 'tools/docker/data/jetpack_dev_mysql' ), {
-					recursive: true,
-				} );
-				fs.mkdirSync( resolve( monorepoRoot, 'tools/docker/data/ssh.keys' ), { recursive: true } );
-				fs.mkdirSync( resolve( monorepoRoot, 'tools/docker/wordpress' ), { recursive: true } );
-
-				const images = [
-					{ name: 'mariadb:lts' },
-					{ name: 'automattic/jetpack-wordpress-dev:latest' },
-					{ name: 'phpmyadmin/phpmyadmin:latest', platform: 'linux/amd64' },
-					{ name: 'maildev/maildev', platform: 'linux/amd64' },
-					{ name: 'atmoz/sftp', platform: 'linux/amd64' },
-				];
-
-				for ( const image of images ) {
-					const inspect = spawnSync( 'docker', [ 'image', 'inspect', image.name ], {
-						stdio: 'ignore',
-					} );
-					if ( inspect.status !== 0 ) {
-						console.log( `Pulling ${ image.name }...` );
-						const args = [ 'pull', image.name ];
-						if ( image.platform ) {
-							args.splice( 1, 0, '--platform', image.platform );
-						}
-						const pull = spawnSync( 'docker', args, { stdio: 'inherit' } );
-						if ( pull.status !== 0 ) {
-							throw new Error( `Failed to pull ${ image.name }` );
+					const configResult = spawnSync(
+						resolve( monorepoRoot, 'tools/docker/bin/monorepo' ),
+						[ 'pnpm', 'jetpack', 'docker', 'config' ],
+						{
+							stdio: 'inherit',
+							shell: true,
+							cwd: monorepoRoot,
 						}
+					);
+
+					if ( configResult.status !== 0 ) {
+						throw new Error( 'Failed to generate Docker config' );
 					}
+				} else if ( args[ 1 ] === 'clean' ) {
+					// After docker-compose down -v, also remove local files
+					const projectName = args.includes( '--type=e2e' ) ? 'jetpack_e2e' : 'jetpack_dev';
+					const cleanupPaths = [
+						resolve( monorepoRoot, 'tools/docker/wordpress/' ),
+						resolve( monorepoRoot, 'tools/docker/wordpress-develop/*' ),
+						resolve( monorepoRoot, 'tools/docker/logs/', projectName ),
+						resolve( monorepoRoot, 'tools/docker/data/', `${ projectName }_mysql` ),
+					];
+
+					// Function to clean up after docker-compose down
+					const cleanupFiles = () => {
+						for ( const path of cleanupPaths ) {
+							try {
+								fs.rmSync( path, { recursive: true, force: true } );
+							} catch ( error ) {
+								console.warn(
+									chalk.yellow( `Warning: Could not remove ${ path }: ${ error.message }` )
+								);
+							}
+						}
+					};
+
+					// Add cleanup to process events to ensure it runs after docker-compose
+					process.once( 'beforeExit', cleanupFiles );
+
+					// Replace 'clean' with 'down -v' in the arguments
+					args.splice( 1, 1, 'down', '-v' );
 				}
 
-				const configResult = spawnSync(
-					resolve( monorepoRoot, 'tools/docker/bin/monorepo' ),
-					[ 'pnpm', 'jetpack', 'docker', 'config' ],
-					{
-						stdio: 'inherit',
-						shell: true,
-						cwd: monorepoRoot,
-					}
-				);
+				// Get project name (from docker.js)
+				const projectName = args.includes( '--type=e2e' ) ? 'jetpack_e2e' : 'jetpack_dev';
+
+				// Build environment variables (from docker.js)
+				const envVars = {
+					...process.env, // Start with process.env
+				};
 
-				if ( configResult.status !== 0 ) {
-					throw new Error( 'Failed to generate Docker config' );
+				// Add default env vars if they exist
+				if ( fs.existsSync( resolve( monorepoRoot, 'tools/docker/default.env' ) ) ) {
+					Object.assign(
+						envVars,
+						dotenv.parse( fs.readFileSync( resolve( monorepoRoot, 'tools/docker/default.env' ) ) )
+					);
 				}
-			}
 
-			// Get project name (from docker.js)
-			const projectName = args.includes( '--type=e2e' ) ? 'jetpack_e2e' : 'jetpack_dev';
-
-			// Load versions from .github/versions.sh
-			const versionsPath = resolve( monorepoRoot, '.github/versions.sh' );
-			const versions = fs.readFileSync( versionsPath, 'utf8' );
-			const versionVars = {};
-			versions.split( '\n' ).forEach( line => {
-				const match = line.match( /^([A-Z_]+)=(.+)$/ );
-				if ( match ) {
-					versionVars[ match[ 1 ] ] = match[ 2 ].replace( /['"]/g, '' );
+				// Add user overrides from .env if they exist
+				if ( fs.existsSync( resolve( monorepoRoot, 'tools/docker/.env' ) ) ) {
+					Object.assign(
+						envVars,
+						dotenv.parse( fs.readFileSync( resolve( monorepoRoot, 'tools/docker/.env' ) ) )
+					);
 				}
-			} );
-
-			// Build environment variables (from docker.js)
-			const envVars = {
-				...process.env,
-				// Load from default.env
-				...( fs.existsSync( resolve( monorepoRoot, 'tools/docker/default.env' ) )
-					? dotenv.parse( fs.readFileSync( resolve( monorepoRoot, 'tools/docker/default.env' ) ) )
-					: {} ),
-				// Load from .env if it exists
-				...( fs.existsSync( resolve( monorepoRoot, 'tools/docker/.env' ) )
-					? dotenv.parse( fs.readFileSync( resolve( monorepoRoot, 'tools/docker/.env' ) ) )
-					: {} ),
-				HOST_CWD: monorepoRoot,
-				PHP_VERSION: versionVars.PHP_VERSION,
-				COMPOSER_VERSION: versionVars.COMPOSER_VERSION,
-				NODE_VERSION: versionVars.NODE_VERSION,
-				PNPM_VERSION: versionVars.PNPM_VERSION,
-				COMPOSE_PROJECT_NAME: projectName,
-				PORT_WORDPRESS: args.includes( '--type=e2e' ) ? '8889' : '80',
-			};
-
-			// Build the list of compose files to use
-			const composeFiles = [
-				'-f',
-				resolve( monorepoRoot, 'tools/docker/docker-compose.yml' ),
-				'-f',
-				resolve( monorepoRoot, 'tools/docker/compose-mappings.built.yml' ),
-				'-f',
-				resolve( monorepoRoot, 'tools/docker/compose-extras.built.yml' ),
-			];
-
-			const result = spawnSync( 'docker', [ 'compose', ...composeFiles, ...args.slice( 1 ) ], {
-				stdio: 'inherit',
-				shell: true,
-				cwd: resolve( monorepoRoot, 'tools/docker' ),
-				env: envVars,
-			} );
 
-			if ( result.status !== 0 ) {
-				throw new Error( `Docker command failed with status ${ result.status }` );
+				// Only set these specific vars if they're not already set in .env
+				if ( ! envVars.COMPOSE_PROJECT_NAME ) {
+					envVars.COMPOSE_PROJECT_NAME = projectName;
+				}
+				if ( ! envVars.PORT_WORDPRESS ) {
+					envVars.PORT_WORDPRESS = args.includes( '--type=e2e' ) ? '8889' : '80';
+				}
+
+				// Load versions from .github/versions.sh if not already set
+				if (
+					! (
+						envVars.PHP_VERSION &&
+						envVars.COMPOSER_VERSION &&
+						envVars.NODE_VERSION &&
+						envVars.PNPM_VERSION
+					)
+				) {
+					const versionsPath = resolve( monorepoRoot, '.github/versions.sh' );
+					const versions = fs.readFileSync( versionsPath, 'utf8' );
+					const versionVars = {};
+					versions.split( '\n' ).forEach( line => {
+						const match = line.match( /^([A-Z_]+)=(.+)$/ );
+						if ( match ) {
+							versionVars[ match[ 1 ] ] = match[ 2 ].replace( /['"]/g, '' );
+						}
+					} );
+
+					// Only set version vars if they're not already set
+					if ( ! envVars.PHP_VERSION ) envVars.PHP_VERSION = versionVars.PHP_VERSION;
+					if ( ! envVars.COMPOSER_VERSION ) envVars.COMPOSER_VERSION = versionVars.COMPOSER_VERSION;
+					if ( ! envVars.NODE_VERSION ) envVars.NODE_VERSION = versionVars.NODE_VERSION;
+					if ( ! envVars.PNPM_VERSION ) envVars.PNPM_VERSION = versionVars.PNPM_VERSION;
+				}
+
+				// Always set HOST_CWD as it's required for Docker context
+				envVars.HOST_CWD = monorepoRoot;
+
+				// Build the list of compose files to use
+				const composeFiles =
+					args[ 0 ] === 'docker' && [ 'build-image', 'install' ].includes( args[ 1 ] )
+						? [ '-f', resolve( monorepoRoot, 'tools/docker/docker-compose-monorepo.yml' ) ]
+						: [
+								'-f',
+								resolve( monorepoRoot, 'tools/docker/docker-compose.yml' ),
+								'-f',
+								resolve( monorepoRoot, 'tools/docker/compose-mappings.built.yml' ),
+								'-f',
+								resolve( monorepoRoot, 'tools/docker/compose-extras.built.yml' ),
+						  ];
+
+				// Add dev profile for monorepo service
+				const composeArgs = [ 'compose', '--profile', 'dev', ...composeFiles, ...args.slice( 1 ) ];
+
+				const result = spawnSync( 'docker', composeArgs, {
+					stdio: 'inherit',
+					shell: true,
+					cwd: resolve( monorepoRoot, 'tools/docker' ),
+					env: envVars,
+				} );
+
+				if ( result.status !== 0 ) {
+					throw new Error( `Docker command failed with status ${ result.status }` );
+				}
+				return;
 			}
-			return;
 		}
 
 		// Run the monorepo script with the original arguments
@@ -269,7 +321,6 @@ const main = async () => {
 			throw new Error( `Command failed with status ${ result.status }` );
 		}
 	} catch ( error ) {
-		// eslint-disable-next-line no-console
 		console.error( chalk.red( error.message ) );
 		process.exitCode = 1;
 	}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@automattic/jetpack-cli",
-	"version": "0.1.0-beta.2",
+	"version": "1.0.0-beta1",
 	"description": "Docker-based CLI for Jetpack development",
 	"bin": {
 		"jp": "bin/jp.js"
@@ -10,9 +10,10 @@
 	],
 	"type": "module",
 	"dependencies": {
-		"chalk": "^4.1.2",
+		"chalk": "^5.4.1",
 		"dotenv": "^16.3.1",
-		"prompts": "^2.4.2"
+		"prompts": "^2.4.2",
+		"update-notifier": "^7.0.0"
 	},
 	"publishConfig": {
 		"access": "public"