@bostonuniversity/buwp-local 0.1.0 → 0.3.0

package/.eslintrc.json

@@ -0,0 +1,15 @@
+{
+  "env": {
+    "es2022": true,
+    "node": true
+  },
+  "extends": "eslint:recommended",
+  "parserOptions": {
+    "ecmaVersion": "latest",
+    "sourceType": "module"
+  },
+  "rules": {
+    "no-unused-vars": ["error", { "argsIgnorePattern": "^_" }],
+    "no-console": "off"
+  }
+}

package/USAGE.md

@@ -5,7 +5,7 @@
 ### 1. Install in your project
 
 ```bash
-npm install --save-dev buwp-local
+npm install --save-dev @bostonuniversity/buwp-local
 ```
 
 ### 2. Initialize configuration
@@ -14,6 +14,12 @@ npm install --save-dev buwp-local
 npx buwp-local config --init
 ```
 
+```bash
+buwp-local config --init --plugin      # For plugins
+buwp-local config --init --mu-plugin   # For mu-plugins
+buwp-local config --init --theme       # For themes
+```
+
 This creates `.buwp-local.json` in your project directory.
 
 ### 3. Edit configuration
@@ -250,6 +256,14 @@ See the resolved configuration (with masked secrets):
 npx buwp-local config --show
 ```
 
+## WP-CLI Command
+```bash
+buwp-local wp user list
+buwp-local wp post list --format=json
+buwp-local wp plugin activate akismet
+```
+
+
 ## Next Steps
 
 - [ ] Phase 2: WP-CLI proxy command

package/bin/buwp-local.js

@@ -5,16 +5,29 @@
  * Main entry point for the BU WordPress Local development environment tool
  */
 
-const { Command } = require('commander');
-const chalk = require('chalk');
-const packageJson = require('../package.json');
+import { Command } from 'commander';
+import chalk from 'chalk';
+import { readFileSync } from 'fs';
+import { fileURLToPath } from 'url';
+import { dirname, join } from 'path';
+
+// Get __dirname equivalent in ESM
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Load package.json
+const packageJson = JSON.parse(
+  readFileSync(join(__dirname, '../package.json'), 'utf8')
+);
 
 // Import commands
-const startCommand = require('../lib/commands/start');
-const stopCommand = require('../lib/commands/stop');
-const destroyCommand = require('../lib/commands/destroy');
-const logsCommand = require('../lib/commands/logs');
-const configCommand = require('../lib/commands/config');
+import startCommand from '../lib/commands/start.js';
+import stopCommand from '../lib/commands/stop.js';
+import destroyCommand from '../lib/commands/destroy.js';
+import logsCommand from '../lib/commands/logs.js';
+import wpCommand from '../lib/commands/wp.js';
+import shellCommand from '../lib/commands/shell.js';
+import configCommand from '../lib/commands/config.js';
 
 const program = new Command();
 
@@ -70,10 +83,13 @@ program
   .command('wp <args...>')
   .description('Run WP-CLI commands in the WordPress container')
   .allowUnknownOption()
-  .action((args) => {
-    console.log(chalk.yellow('WP-CLI proxy not yet implemented'));
-    console.log('Would run:', args.join(' '));
-  });
+  .action(wpCommand);
+
+// Shell command
+program
+  .command('shell')
+  .description('Open an interactive bash shell in the WordPress container')
+  .action(shellCommand);
 
 // Error handling
 program.exitOverride();

package/lib/commands/config.js

@@ -2,8 +2,9 @@
  * Config command - Configuration management
  */
 
-const chalk = require('chalk');
-const { loadConfig, validateConfig, initConfig, CONFIG_FILE_NAME } = require('../config');
+import chalk from 'chalk';
+import path from 'path';
+import { loadConfig, validateConfig, initConfig, CONFIG_FILE_NAME } from '../config.js';
 
 async function configCommand(options) {
   try {
@@ -31,7 +32,6 @@ async function configCommand(options) {
         console.log(chalk.green(`✅ Created configuration file: ${configPath}\n`));
         
         if (initOptions.plugin || initOptions.muPlugin || initOptions.theme) {
-          const path = require('path');
           const projectName = path.basename(projectPath);
           const type = initOptions.plugin ? 'plugin' : initOptions.muPlugin ? 'mu-plugin' : 'theme';
           console.log(chalk.cyan(`Auto-configured mapping for ${type}: ${projectName}`));
@@ -128,4 +128,4 @@ function maskSensitiveData(config) {
   return masked;
 }
 
-module.exports = configCommand;
+export default configCommand;

package/lib/commands/destroy.js

@@ -2,12 +2,12 @@
  * Destroy command - Destroys the local WordPress environment (including volumes)
  */
 
-const chalk = require('chalk');
-const { execSync } = require('child_process');
-const path = require('path');
-const fs = require('fs');
-const readline = require('readline');
-const { loadConfig } = require('../config');
+import chalk from 'chalk';
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import readline from 'readline';
+import { loadConfig } from '../config.js';
 
 async function destroyCommand(options) {
   console.log(chalk.red('⚠️  DESTROY BU WordPress local environment\n'));
@@ -48,6 +48,7 @@ async function destroyCommand(options) {
     const composeDir = path.dirname(composePath);
     
     try {
+      // This is the actual docker compose down command that removes everything
       execSync(
         `docker compose -p ${projectName} -f ${composePath} down -v`,
         { 
@@ -93,4 +94,4 @@ function confirmDestroy(projectName) {
   });
 }
 
-module.exports = destroyCommand;
+export default destroyCommand;

package/lib/commands/logs.js

@@ -2,11 +2,11 @@
  * Logs command - View logs from the WordPress environment
  */
 
-const chalk = require('chalk');
-const { execSync } = require('child_process');
-const path = require('path');
-const fs = require('fs');
-const { loadConfig } = require('../config');
+import chalk from 'chalk';
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import { loadConfig } from '../config.js';
 
 async function logsCommand(options) {
   console.log(chalk.blue('📋 Viewing logs...\n'));
@@ -63,4 +63,4 @@ async function logsCommand(options) {
   }
 }
 
-module.exports = logsCommand;
+export default logsCommand;

package/lib/commands/shell.js

@@ -0,0 +1,71 @@
+/**
+ * Shell command - Open an interactive bash shell in the WordPress container
+ */
+
+import chalk from 'chalk';
+import { spawnSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import { loadConfig } from '../config.js';
+
+async function shellCommand(_options) {
+  console.log(chalk.blue('🐚 Opening interactive shell...\n'));
+
+  try {
+    const projectPath = process.cwd();
+    const composePath = path.join(projectPath, '.buwp-local', 'docker-compose.yml');
+
+    // Check if docker-compose.yml exists
+    if (!fs.existsSync(composePath)) {
+      console.log(chalk.yellow('⚠️  No running environment found.'));
+      console.log(chalk.gray('Run "buwp-local start" to create an environment.\n'));
+      return;
+    }
+
+    // Load config to get project name
+    const config = loadConfig(projectPath);
+    const projectName = config.projectName || 'buwp-local';
+
+    // Check if Docker is running
+    try {
+      spawnSync('docker', ['info'], { stdio: 'ignore' });
+    } catch (err) {
+      console.error(chalk.red('❌ Docker is not running.'));
+      process.exit(1);
+    }
+
+    // Build docker compose exec command for interactive shell
+    const composeDir = path.dirname(composePath);
+    
+    // Use spawnSync instead of execSync for proper TTY handling
+    const result = spawnSync(
+      'docker',
+      [
+        'compose',
+        '-p', projectName,
+        '-f', composePath,
+        'exec',
+        'wordpress',
+        '/bin/bash'
+      ],
+      {
+        cwd: composeDir,
+        stdio: 'inherit',
+        shell: false
+      }
+    );
+
+    // Only show exit message if shell exited with error
+    if (result.status !== 0 && result.status !== null) {
+      console.log(chalk.yellow(`\n⚠️  Shell exited with code ${result.status}\n`));
+    } else {
+      console.log(chalk.gray('\n👋 Shell closed.\n'));
+    }
+
+  } catch (err) {
+    console.error(chalk.red('\n❌ Error:'), err.message);
+    process.exit(1);
+  }
+}
+
+export default shellCommand;

package/lib/commands/start.js

@@ -2,11 +2,11 @@
  * Start command - Starts the local WordPress environment
  */
 
-const chalk = require('chalk');
-const { execSync } = require('child_process');
-const path = require('path');
-const { loadConfig, validateConfig } = require('../config');
-const { generateComposeFile } = require('../compose-generator');
+import chalk from 'chalk';
+import { execSync } from 'child_process';
+import path from 'path';
+import { loadConfig, validateConfig } from '../config.js';
+import { generateComposeFile } from '../compose-generator.js';
 
 async function startCommand(options) {
   console.log(chalk.blue('🚀 Starting BU WordPress local environment...\n'));
@@ -95,4 +95,4 @@ async function startCommand(options) {
   }
 }
 
-module.exports = startCommand;
+export default startCommand;

package/lib/commands/stop.js

@@ -2,11 +2,11 @@
  * Stop command - Stops the local WordPress environment
  */
 
-const chalk = require('chalk');
-const { execSync } = require('child_process');
-const path = require('path');
-const fs = require('fs');
-const { loadConfig } = require('../config');
+import chalk from 'chalk';
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import { loadConfig } from '../config.js';
 
 async function stopCommand() {
   console.log(chalk.blue('🛑 Stopping BU WordPress local environment...\n'));
@@ -59,4 +59,4 @@ async function stopCommand() {
   }
 }
 
-module.exports = stopCommand;
+export default stopCommand;

package/lib/commands/wp.js

@@ -0,0 +1,57 @@
+/**
+ * WP-CLI proxy command - Execute WP-CLI commands in the WordPress container
+ */
+
+import chalk from 'chalk';
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import { loadConfig } from '../config.js';
+
+async function wpCommand(args, _options) {
+  try {
+    const projectPath = process.cwd();
+    const composePath = path.join(projectPath, '.buwp-local', 'docker-compose.yml');
+
+    // Check if docker-compose.yml exists
+    if (!fs.existsSync(composePath)) {
+      console.log(chalk.yellow('⚠️  No running environment found.'));
+      console.log(chalk.gray('Run "buwp-local start" to create an environment.\n'));
+      return;
+    }
+
+    // Load config to get project name
+    const config = loadConfig(projectPath);
+    const projectName = config.projectName || 'buwp-local';
+
+    // Check if Docker is running
+    try {
+      execSync('docker info', { stdio: 'ignore' });
+    } catch (err) {
+      console.error(chalk.red('❌ Docker is not running.'));
+      process.exit(1);
+    }
+
+    // Build docker compose exec command for WP-CLI
+    const composeDir = path.dirname(composePath);
+    const wpArgs = args.join(' ');
+    const command = `docker compose -p ${projectName} -f ${composePath} exec wordpress wp ${wpArgs}`;
+
+    // Execute WP-CLI command
+    try {
+      execSync(command, { 
+        cwd: composeDir,
+        stdio: 'inherit'
+      });
+    } catch (err) {
+      // WP-CLI may exit with error codes (e.g., failed import), don't exit harshly
+      // The error output is already shown via stdio: 'inherit'
+    }
+
+  } catch (err) {
+    console.error(chalk.red('\n❌ Error:'), err.message);
+    process.exit(1);
+  }
+}
+
+export default wpCommand;

package/lib/compose-generator.js

@@ -3,10 +3,9 @@
  * Generates docker-compose.yml from configuration using js-yaml
  */
 
-const yaml = require('js-yaml');
-const fs = require('fs');
-const path = require('path');
-const os = require('os');
+import yaml from 'js-yaml';
+import fs from 'fs';
+import path from 'path';
 
 /**
  * Generate docker-compose configuration from buwp-local config
@@ -272,7 +271,7 @@ function generateComposeFile(config, projectPath = process.cwd()) {
   return writeComposeFile(composeConfig, composePath);
 }
 
-module.exports = {
+export {
   generateComposeConfig,
   generateComposeFile,
   writeComposeFile

package/lib/config.js

@@ -3,9 +3,10 @@
  * Handles loading, validating, and merging configuration from various sources
  */
 
-const fs = require('fs');
-const path = require('path');
-const chalk = require('chalk');
+import fs from 'fs';
+import path from 'path';
+import chalk from 'chalk';
+import dotenv from 'dotenv';
 
 const CONFIG_FILE_NAME = '.buwp-local.json';
 const ENV_FILE_NAME = '.env.local';
@@ -58,7 +59,7 @@ function loadConfig(projectPath = process.cwd()) {
   // Load .env.local if it exists
   if (fs.existsSync(envPath)) {
     try {
-      require('dotenv').config({ path: envPath });
+      dotenv.config({ path: envPath });
       envVars = extractEnvVars();
     } catch (err) {
       console.warn(chalk.yellow(`Warning: Failed to load ${ENV_FILE_NAME}: ${err.message}`));
@@ -282,7 +283,7 @@ function sanitizeProjectName(name) {
     .replace(/^-+|-+$/g, ''); // Remove leading/trailing dashes
 }
 
-module.exports = {
+export {
   loadConfig,
   validateConfig,
   initConfig,

package/lib/index.js

@@ -3,21 +3,14 @@
  * Main library exports
  */
 
-const config = require('./config');
-const composeGenerator = require('./compose-generator');
+import * as config from './config.js';
+import * as composeGenerator from './compose-generator.js';
 
-module.exports = {
-  // Configuration
-  loadConfig: config.loadConfig,
-  validateConfig: config.validateConfig,
-  initConfig: config.initConfig,
-  
-  // Docker Compose generation
-  generateComposeConfig: composeGenerator.generateComposeConfig,
-  generateComposeFile: composeGenerator.generateComposeFile,
-  
-  // Constants
-  CONFIG_FILE_NAME: config.CONFIG_FILE_NAME,
-  ENV_FILE_NAME: config.ENV_FILE_NAME,
-  DEFAULT_CONFIG: config.DEFAULT_CONFIG
-};
+export const loadConfig = config.loadConfig;
+export const validateConfig = config.validateConfig;
+export const initConfig = config.initConfig;
+export const generateComposeConfig = composeGenerator.generateComposeConfig;
+export const generateComposeFile = composeGenerator.generateComposeFile;
+export const CONFIG_FILE_NAME = config.CONFIG_FILE_NAME;
+export const ENV_FILE_NAME = config.ENV_FILE_NAME;
+export const DEFAULT_CONFIG = config.DEFAULT_CONFIG;

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "@bostonuniversity/buwp-local",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Local WordPress development environment for Boston University projects",
+  "type": "module",
   "main": "lib/index.js",
   "bin": {
     "buwp-local": "./bin/buwp-local.js"
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "dev": "node bin/buwp-local.js",
+    "buwp-local": "node bin/buwp-local.js config --init --mu-plugin",
     "lint": "eslint ."
   },
   "keywords": [
@@ -21,7 +22,7 @@
   "author": "Boston University",
   "license": "ISC",
   "engines": {
-    "node": ">=16.0.0"
+    "node": ">=18.0.0"
   },
   "dependencies": {
     "js-yaml": "^4.1.0",

package/.buwp-local.json

@@ -1,27 +0,0 @@
-{
-  "image": "ghcr.io/bu-ist/bu-wp-docker-mod_shib:arm64-latest",
-  "hostname": "jaydub.local",
-  "multisite": true,
-  "services": {
-    "redis": true,
-    "s3proxy": true,
-    "shibboleth": true
-  },
-  "ports": {
-    "http": 80,
-    "https": 443,
-    "db": 3306,
-    "redis": 6379
-  },
-  "mappings": [
-    {
-      "local": "./",
-      "container": "/var/www/html/wp-content/plugins/my-plugin",
-      "comment": "Map current directory to a plugin location"
-    }
-  ],
-  "env": {
-    "WP_DEBUG": false,
-    "XDEBUG": true
-  }
-}