@elementor/wp-lite-env 0.0.6

package/index.d.ts

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+export {};
+//# sourceMappingURL=index.d.ts.map

package/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":""}

package/index.js

@@ -0,0 +1,16 @@
+#!/usr/bin/env node
+import { cleanup, commandMap, generateFiles, getCliCommand, getConfigFilePath, getPort } from './src/run';
+const command = process.argv[2];
+if (!commandMap[command]) {
+    console.log(`Valid commands: ${Object.keys(commandMap).join(', ')}. You used ${command}`);
+}
+const port = getPort(process.argv);
+const configFilePath = getConfigFilePath(process.argv);
+const runPath = generateFiles(port, configFilePath);
+const cliCommand = getCliCommand(process.argv);
+try {
+    await commandMap[command](port, runPath, cliCommand);
+}
+finally {
+    cleanup(port, runPath);
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+    "name": "@elementor/wp-lite-env",
+    "version": "0.0.6",
+    "private": false,
+    "description": "A simple, lightweight, docker-based WordPress environment",
+    "main": "dist/index.js",
+    "type": "module",
+    "types": "dist/index.d.ts",
+    "bin": {
+        "wp-lite-env": "dist/index.js"
+    },
+    "scripts": {
+        "build": "tsc",
+        "lint": "eslint",
+        "release": "npm run build && changeset publish",
+        "test": "jest --coverage=true"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/elementor/wp-lite-env.git"
+    },
+    "publishConfig": {
+        "access": "public",
+        "directory": "dist"
+    },
+    "author": "Elementor Team",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/elementor/wp-lite-env/issues"
+    },
+    "homepage": "https://github.com/elementor/wp-lite-env#readme",
+    "dependencies": {
+        "docker-compose": "^1.1.0"
+    },
+    "devDependencies": {
+        "@changesets/cli": "^2.27.9",
+        "@eslint/js": "^9.15.0",
+        "@jest/globals": "^29.7.0",
+        "@types/eslint__js": "^8.42.3",
+        "@types/node": "^22.9.0",
+        "eslint": "~9.14.0",
+        "jest": "^29.7.0",
+        "ts-jest": "^29.2.5",
+        "typescript": "^5.6.3",
+        "typescript-eslint": "^8.14.0"
+    }
+}

package/src/config.d.ts

@@ -0,0 +1,16 @@
+export type Config = {
+    core?: string;
+    phpVersion?: string;
+    plugins?: {
+        [key: string]: string;
+    };
+    themes?: {
+        [key: string]: string;
+    };
+    mappings?: {
+        [key: string]: string;
+    };
+    config?: Record<string, string | boolean>;
+};
+export declare const getConfig: (configFilePath?: string) => Config;
+//# sourceMappingURL=config.d.ts.map

package/src/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/config.ts"],"names":[],"mappings":"AAEA,MAAM,MAAM,MAAM,GAAG;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACpC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACnC,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAC,OAAO,CAAC,CAAC;CACxC,CAAA;AAED,eAAO,MAAM,SAAS,oBAAsB,MAAM,KAAI,MAuBrD,CAAC"}

package/src/config.js

@@ -0,0 +1,23 @@
+import fs from 'fs';
+export const getConfig = (configFilePath) => {
+    let configFile = {};
+    if (configFilePath) {
+        configFile = JSON.parse(fs.readFileSync(configFilePath, 'utf8'));
+    }
+    const defaultConfig = {
+        core: '6.7',
+        phpVersion: '8.1',
+        plugins: {},
+        themes: {},
+        mappings: {},
+        config: {},
+    };
+    return {
+        core: configFile.core || defaultConfig.core,
+        phpVersion: configFile.phpVersion || defaultConfig.phpVersion,
+        plugins: configFile.plugins || defaultConfig.plugins,
+        themes: configFile.themes || defaultConfig.themes,
+        mappings: configFile.mappings || defaultConfig.mappings,
+        config: configFile.config || defaultConfig.config,
+    };
+};

package/src/run.d.ts

@@ -0,0 +1,11 @@
+export declare const start: (port: string, runPath: string) => Promise<void>;
+export declare const stop: (port: string, runPath: string) => Promise<void>;
+export declare const commandMap: {
+    [key: string]: ((port: string) => Promise<void>) | ((port: string, runPath: string, command: string) => Promise<void>);
+};
+export declare const generateFiles: (port: string, configFilePath: string) => string;
+export declare const getConfigFilePath: (processArgs: string[]) => string;
+export declare const getCliCommand: (processArgs: string[]) => string;
+export declare const getPort: (processArgs: string[]) => string;
+export declare const cleanup: (port: string, runPath: string) => void;
+//# sourceMappingURL=run.d.ts.map

package/src/run.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"run.d.ts","sourceRoot":"","sources":["../../src/run.ts"],"names":[],"mappings":"AAgCA,eAAO,MAAM,KAAK,SAAiB,MAAM,WAAW,MAAM,kBASzD,CAAC;AAEF,eAAO,MAAM,IAAI,SAAiB,MAAM,WAAW,MAAM,kBAOxD,CAAC;AAWF,eAAO,MAAM,UAAU,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,CAAE,CAAE,IAAI,EAAE,MAAM,KAAM,OAAO,CAAC,IAAI,CAAC,CAAE,GAAG,CAAE,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,KAAM,OAAO,CAAC,IAAI,CAAC,CAAE,CAAA;CAIxJ,CAAC;AAIF,eAAO,MAAM,aAAa,SAAW,MAAM,kBAAkB,MAAM,WA4BlE,CAAC;AAYF,eAAO,MAAM,iBAAiB,gBAAkB,MAAM,EAAE,WAEvD,CAAC;AAEF,eAAO,MAAM,aAAa,gBAAkB,MAAM,EAAE,WAEnD,CAAC;AAEF,eAAO,MAAM,OAAO,gBAAkB,MAAM,EAAE,WAE7C,CAAC;AAEF,eAAO,MAAM,OAAO,SAAW,MAAM,WAAW,MAAM,SAGrD,CAAA"}

package/src/run.js

@@ -0,0 +1,105 @@
+import { downAll, run, upAll } from "docker-compose";
+import path from "path";
+import { getConfig } from "./config";
+import fs from "fs";
+import { generateCliDockerfileTemplate, generateConfiguration, generateDockerComposeYmlTemplate, generateWordPressDockerfileTemplate } from "./templates";
+import { createHash } from "crypto";
+import os from "node:os";
+const waitForServer = async (url, timeoutMs) => {
+    const startTime = Date.now();
+    const sleep = (ms) => new Promise((r) => setTimeout(r, ms));
+    while (startTime + timeoutMs > Date.now()) {
+        try {
+            const response = await fetch(url);
+            if (response.ok && (200 === response.status || 302 === response.status)) {
+                return true;
+            }
+        }
+        catch (e) { // eslint-disable-line @typescript-eslint/no-unused-vars
+            // Ignore
+        }
+        finally {
+            await sleep(100);
+        }
+    }
+    return false;
+};
+export const start = async (port, runPath) => {
+    await upAll({
+        commandOptions: ['--build'],
+        composeOptions: ['-p', `port${port}`],
+        cwd: runPath,
+        log: true,
+    });
+    await waitForServer(`http://localhost:${port}`, 10000);
+    await cli(port, runPath, 'bash wp-config/configure-wp.sh');
+};
+export const stop = async (port, runPath) => {
+    await downAll({
+        cwd: runPath,
+        commandOptions: ['--volumes', '--remove-orphans'],
+        composeOptions: ['-p', `port${port}`],
+        log: true,
+    });
+};
+const cli = async (port, runPath, command) => {
+    await run('cli', command, {
+        cwd: runPath,
+        commandOptions: ['--rm'],
+        composeOptions: ['-p', `port${port}`],
+        log: true,
+    });
+};
+export const commandMap = {
+    start,
+    stop,
+    cli,
+};
+const getWpConfigPath = (port) => path.resolve(process.cwd(), port);
+export const generateFiles = (port, configFilePath) => {
+    const config = getConfig(configFilePath);
+    // Using a local path since Docker Compose cannot access /tmp
+    // See: https://github.com/docker/compose/issues/1153
+    const wpConfigPath = getWpConfigPath(port);
+    if (!fs.existsSync(wpConfigPath)) {
+        fs.mkdirSync(wpConfigPath, { recursive: true });
+    }
+    const wpConfig = generateConfiguration(config, port);
+    fs.writeFileSync(path.resolve(wpConfigPath, 'configure-wp.sh'), wpConfig);
+    const dockerComposeYmlTemplate = generateDockerComposeYmlTemplate(config, process.cwd(), port, wpConfigPath);
+    const wordPressDockerfileTemplate = generateWordPressDockerfileTemplate(config);
+    const cliDockerfileTemplate = generateCliDockerfileTemplate(config);
+    const hash = createHash('sha256');
+    hash.update(dockerComposeYmlTemplate + wordPressDockerfileTemplate + cliDockerfileTemplate + port);
+    const runPath = path.resolve(os.tmpdir(), `${hash.digest('hex')}`);
+    if (!fs.existsSync(runPath)) {
+        fs.mkdirSync(runPath);
+    }
+    console.log(`writing files to run path: ${runPath}`);
+    fs.writeFileSync(path.resolve(runPath, 'docker-compose.yml'), dockerComposeYmlTemplate);
+    fs.writeFileSync(path.resolve(runPath, 'WordPress.Dockerfile'), wordPressDockerfileTemplate);
+    fs.writeFileSync(path.resolve(runPath, 'CLI.Dockerfile'), cliDockerfileTemplate);
+    return runPath;
+};
+const getArgument = (argumentKey, processArgs) => {
+    for (let i = 3; i < processArgs.length; i++) {
+        const argument = processArgs[i];
+        if (argument.startsWith(`${argumentKey}=`)) {
+            return argument.substring(argumentKey.length + 1);
+        }
+    }
+    return undefined;
+};
+export const getConfigFilePath = (processArgs) => {
+    return path.resolve(getArgument('config', processArgs));
+};
+export const getCliCommand = (processArgs) => {
+    return getArgument('command', processArgs);
+};
+export const getPort = (processArgs) => {
+    return getArgument('port', processArgs) || '8888';
+};
+export const cleanup = (port, runPath) => {
+    fs.rmSync(getWpConfigPath(port), { recursive: true, force: true });
+    fs.rmSync(runPath, { recursive: true, force: true });
+};

package/src/templates.d.ts

@@ -0,0 +1,6 @@
+import { Config } from './config';
+export declare const generateDockerComposeYmlTemplate: (config: Config, basePath: string, port: string, configPath: string) => string;
+export declare const generateWordPressDockerfileTemplate: (config: Config) => string;
+export declare const generateCliDockerfileTemplate: (config: Config) => string;
+export declare const generateConfiguration: (config: Config, port: string) => string;
+//# sourceMappingURL=templates.d.ts.map

package/src/templates.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templates.d.ts","sourceRoot":"","sources":["../../src/templates.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAGlC,eAAO,MAAM,gCAAgC,WAAa,MAAM,YAAY,MAAM,QAAQ,MAAM,cAAc,MAAM,WA0EnH,CAAC;AAEF,eAAO,MAAM,mCAAmC,WAAa,MAAM,WASlE,CAAC;AAEF,eAAO,MAAM,6BAA6B,WAAa,MAAM,WAa5D,CAAC;AAEF,eAAO,MAAM,qBAAqB,WAAa,MAAM,QAAQ,MAAM,WAWlE,CAAC"}

package/src/templates.js

@@ -0,0 +1,111 @@
+import path from 'path';
+export const generateDockerComposeYmlTemplate = (config, basePath, port, configPath) => {
+    const mappingsStringArray = Object.keys(config.mappings).map((key) => {
+        const value = config.mappings[key];
+        return `      - >-
+        ${path.resolve(basePath, value)}:/var/www/html/${key}\n`;
+    });
+    const pluginsStringArray = Object.keys(config.plugins).map((key) => {
+        const value = config.plugins[key];
+        return `      - >-
+        ${path.resolve(basePath, value)}:/var/www/html/wp-content/plugins/${key}\n`;
+    });
+    const themesStringArray = Object.keys(config.themes).map((key) => {
+        const value = config.themes[key];
+        return `      - >-
+        ${path.resolve(basePath, value)}:/var/www/html/wp-content/themes/${key}\n`;
+    });
+    const wpContent = `      - >-
+        wpcontent:/var/www/html\n`;
+    const wpConfig = `      - >-
+        ${configPath}:/var/www/html/wp-config\n`;
+    const volumes = mappingsStringArray.concat(pluginsStringArray).concat(themesStringArray).concat([wpContent, wpConfig]).join('');
+    return `services:
+  mysql:
+    image: 'mariadb:lts'
+    ports:
+      - '\${WP_ENV_MYSQL_PORT:-}:3306'
+    environment:
+      MYSQL_ROOT_HOST: '%'
+      MYSQL_ROOT_PASSWORD: password
+      MYSQL_DATABASE: wordpress
+    volumes:
+      - 'mysql:/var/lib/mysql'
+  wordpress:
+    depends_on:
+      - mysql
+    build:
+      context: .
+      dockerfile: WordPress.Dockerfile
+      no_cache: true
+      args: &ref_0
+        HOST_USERNAME: yotams
+        HOST_UID: '502'
+        HOST_GID: '20'
+    ports:
+      - '\${WP_ENV_PORT:-${port}}:80'
+    environment:
+      APACHE_RUN_USER: '#502'
+      APACHE_RUN_GROUP: '#20'
+      WORDPRESS_DB_USER: root
+      WORDPRESS_DB_PASSWORD: password
+      WORDPRESS_DB_NAME: wordpress
+    volumes: &ref_1
+${volumes}
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'
+  cli:
+    depends_on:
+      - wordpress
+    build:
+      context: .
+      dockerfile: CLI.Dockerfile
+      args: *ref_0
+    volumes: *ref_1
+    user: '502:20'
+    environment:
+      WORDPRESS_DB_USER: root
+      WORDPRESS_DB_PASSWORD: password
+      WORDPRESS_DB_NAME: wordpress
+    extra_hosts:
+      - 'host.docker.internal:host-gateway'
+volumes:
+  mysql: {}
+  wpcontent: {}
+`;
+};
+export const generateWordPressDockerfileTemplate = (config) => {
+    return `FROM wordpress:${config.core}-php${config.phpVersion}
+ARG HOST_USERNAME
+ARG HOST_UID
+ARG HOST_GID
+# When the IDs are already in use we can still safely move on.
+RUN groupadd -o -g $HOST_GID $HOST_USERNAME || true
+RUN useradd -mlo -u $HOST_UID -g $HOST_GID $HOST_USERNAME || true
+`;
+};
+export const generateCliDockerfileTemplate = (config) => {
+    return `FROM wordpress:cli-php${config.phpVersion}
+ARG HOST_USERNAME
+ARG HOST_UID
+ARG HOST_GID
+# When the IDs are already in use we can still safely move on.
+RUN addgroup -g $HOST_GID $HOST_USERNAME || true
+RUN useradd -mlo -u $HOST_UID -g $HOST_GID $HOST_USERNAME || true
+# RUN adduser -h /home/$HOST_USERNAME -G $( getent group $HOST_GID | cut -d: -f1 ) -u $HOST_UID $HOST_USERNAME || true
+
+# Have the container sleep infinitely to keep it alive for us to run commands on it.
+CMD [ "/bin/sh", "-c", "while true; do sleep 2073600; done" ]
+`;
+};
+export const generateConfiguration = (config, port) => {
+    const header = `#!/bin/bash
+set -eox pipefail
+`;
+    const configStringArray = Object.keys(config.config).map((key) => {
+        const value = config.config[key];
+        return `wp config set ${key} ${value} --raw`;
+    });
+    const wpCoreInstall = `wp core install --url="http://localhost:${port}" --title="test" --admin_user=admin --admin_password=password --admin_email=wordpress@example.com --skip-email`;
+    return [header, wpCoreInstall].concat(configStringArray).join('\n');
+};