@wp-tester/config 0.0.4 → 0.1.0

package/dist/wp-tester-config.d.ts

@@ -28,6 +28,19 @@ export type Blueprint = BlueprintV1Declaration | string;
  * @see https://wordpress.github.io/wordpress-playground/developers/local-development/wp-playground-cli#mounting-a-plugin-programmatically
  */
 export interface Mount extends PlaygroundMount {
+    /**
+     * Absolute or relative path on the host filesystem to mount.
+     * Relative paths are resolved from projectHostPath.
+     * @example "vendor/bin/phpunit"
+     * @example "/absolute/path/to/project"
+     */
+    hostPath: string;
+    /**
+     * Virtual filesystem path where the host path should be mounted.
+     * @example "/wordpress/wp-content/plugins/my-plugin"
+     * @example "/project"
+     */
+    vfsPath: string;
     /**
      * Whether to mount before WordPress installation.
      * When true, the mount happens before WordPress is installed.
@@ -95,14 +108,61 @@ export interface Tests {
     /**
      * PHPUnit test configuration.
      * When provided, runs PHPUnit tests with the specified paths.
-     * When undefined, PHPUnit tests are disabled.
+     * When undefined, PHPUnit tests are not run.
      */
     phpunit?: PHPUnitConfig;
+    /**
+     * Watch mode configuration.
+     * Controls which files are watched when using --watch flag.
+     */
+    watch?: WatchConfig;
+    /**
+     * Allow the test suite to pass when no tests are executed.
+     * By default, wp-tester exits with code 1 when no tests are found.
+     * Set to true to exit with code 0 instead (similar to Jest's --passWithNoTests).
+     * @default false
+     */
+    passWithNoTests?: boolean;
 }
+/**
+ * Base reporter options for filtering test results by status.
+ * All options default to false - only explicitly enabled statuses are shown.
+ */
+export interface BaseReporterOptions {
+    /**
+     * Show passed tests in output
+     * @default false
+     */
+    passed?: boolean;
+    /**
+     * Show failed tests in output
+     * @default false
+     */
+    failed?: boolean;
+    /**
+     * Show skipped tests in output
+     * @default false
+     */
+    skipped?: boolean;
+    /**
+     * Show pending tests in output
+     * @default false
+     */
+    pending?: boolean;
+    /**
+     * Show other test statuses in output
+     * @default false
+     */
+    other?: boolean;
+}
+/**
+ * Default reporter configuration options
+ */
+export type DefaultReporterOptions = BaseReporterOptions;
 /**
  * JSON reporter configuration options
  */
-export interface JsonReporterOptions {
+export interface JsonReporterOptions extends BaseReporterOptions {
     /**
      * Path where the JSON report file should be written
      * @example "test-results.json"
@@ -111,14 +171,31 @@ export interface JsonReporterOptions {
     outputFile: string;
 }
 /**
- * Reporter configuration.
- * Can be a simple string for reporters without options,
- * or a tuple of [reporter name, options] for configurable reporters.
+ * Reporter configuration object.
+ * Each key is a reporter name, and the value is its options.
  *
- * @example "default"
- * @example ["json", { "outputFile": "results.json" }]
+ * @example {}
+ * @example { "default": { "failed": true, "passed": true } }
+ * @example { "json": { "outputFile": "results.json", "failed": true } }
+ */
+export interface Reporters {
+    /**
+     * Default console reporter options.
+     * Use `true` to enable with defaults, or an object for custom options.
+     */
+    default?: boolean | DefaultReporterOptions;
+    /**
+     * JSON file reporter options
+     */
+    json?: JsonReporterOptions;
+}
+/**
+ * Environment variables for WordPress Playground.
+ * Key-value pairs of environment variable names and values.
+ * @example { "WP_DEBUG": "1", "WP_DEBUG_LOG": "1" }
+ * @default {}
  */
-export type Reporter = "default" | ["json", JsonReporterOptions];
+export type EnvironmentVariables = Record<string, string>;
 /**
  * Test environment configuration.
  * Defines a WordPress environment with specific versions and setup.
@@ -130,16 +207,64 @@ export interface Environment {
      * @example "WooCommerce Environment"
      */
     name?: string;
+    /**
+     * PHP version(s) for this environment.
+     * Can be a single version string or an array of versions for matrix testing.
+     * When an array is provided, tests will run for each PHP version combined with each WP version.
+     * If blueprint.preferredVersions.php is also set, the blueprint value takes precedence
+     * and only that single version will be used.
+     * @example "8.2"
+     * @example ["8.1", "8.2", "8.3"]
+     */
+    php?: NonNullable<BlueprintV1Declaration["preferredVersions"]>["php"][];
+    /**
+     * WordPress version(s) for this environment.
+     * Can be a single version string or an array of versions for matrix testing.
+     * When an array is provided, tests will run for each WP version combined with each PHP version.
+     * If blueprint.preferredVersions.wp is also set, the blueprint value takes precedence
+     * and only that single version will be used.
+     * @example "6.7"
+     * @example ["6.6", "6.7"]
+     */
+    wp?: NonNullable<BlueprintV1Declaration["preferredVersions"]>["wp"][];
     /**
      * WordPress Playground Blueprint configuration.
      * Can be an inline blueprint object or a file path to a blueprint JSON file.
+     * If not specified, a default blueprint will be created using the php and wp version settings.
      */
-    blueprint: Blueprint;
+    blueprint?: Blueprint;
     /**
      * Filesystem mounts to apply to this environment
      * @default []
      */
     mounts?: Mount[];
+    /**
+     * Environment variables to set when running PHPUnit tests
+     * @example { "WP_TESTS_DIR": "/custom/path" }
+     * @default {}
+     */
+    env?: EnvironmentVariables;
+    /**
+     * Whether this environment should be skipped.
+     * Skipped environments are excluded from test execution.
+     * Useful for temporarily excluding environments without removing them from configuration.
+     * @default false
+     */
+    skip?: boolean;
+}
+/**
+ * Watch mode configuration for automatic test re-runs.
+ */
+export interface WatchConfig {
+    /**
+     * Glob patterns for files/directories to watch (relative to projectHostPath).
+     * If not specified, watches all files in the projectHostPath directory.
+     */
+    include?: string[];
+    /**
+     * Glob patterns to exclude from watching.
+     */
+    exclude?: string[];
 }
 /**
  * Complete wp-tester configuration.
@@ -159,6 +284,21 @@ export interface WPTesterConfig {
      * @example "./my-project"
      */
     projectHostPath?: string;
+    /**
+     * Path where your project directory will be mounted in the WordPress environment.
+     *
+     * When not specified, the path is automatically determined based on projectType:
+     * - plugin: /wordpress/wp-content/plugins/{dir-name}
+     * - theme: /wordpress/wp-content/themes/{dir-name}
+     * - wp-content: /wordpress/wp-content
+     * - wordpress: /wordpress
+     * - other: **Required** - You must specify where your project directory should be mounted
+     *
+     * @example "/project" - Mount your project at the root level
+     * @example "/wordpress/wp-content/mu-plugins/my-mu-plugin" - Mount as a must-use plugin
+     * @example "/wordpress/wp-content/plugins/my-custom-plugin" - Mount as a WordPress plugin
+     */
+    projectVFSPath?: string;
     /**
      * Detected WordPress project type.
      * Automatically detected during setup based on project structure.
@@ -176,9 +316,10 @@ export interface WPTesterConfig {
      */
     tests: Tests;
     /**
-     * Output reporters for test results
-     * @default ["default"]
+     * Output reporters for test results.
+     * Each reporter can be configured with filtering options.
+     * @default { "default": { "passed": true, "failed": true, "skipped": true, "pending": true, "other": true } }
      */
-    reporters?: Reporter[];
+    reporters?: Reporters;
 }
 //# sourceMappingURL=wp-tester-config.d.ts.map

package/dist/wp-tester-config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"wp-tester-config.d.ts","sourceRoot":"","sources":["../src/wp-tester-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,KAAK,IAAI,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,aAAa,CAAC;AAG9C,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,sBAAsB,GAAG,MAAM,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe;IAC5C;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb;;;;OAIG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,QAAQ,GAAG,SAAS,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;AAEjE;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;CAClB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;;;OAKG;IACH,YAAY,EAAE,WAAW,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;;OAGG;IACH,SAAS,CAAC,EAAE,QAAQ,EAAE,CAAC;CACxB"}
+{"version":3,"file":"wp-tester-config.d.ts","sourceRoot":"","sources":["../src/wp-tester-config.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACxE,OAAO,KAAK,EAAE,KAAK,IAAI,eAAe,EAAE,MAAM,2BAA2B,CAAC;AAC1E,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAEjE;;;;;;;;;GASG;AACH,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,aAAa,CAAC;AAG9C,YAAY,EAAE,WAAW,EAAE,CAAC;AAE5B;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG,sBAAsB,GAAG,MAAM,CAAC;AAExD;;;;;;GAMG;AACH,MAAM,WAAW,KAAM,SAAQ,eAAe;IAC5C;;;;;OAKG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb;;;;OAIG;IACH,OAAO,CAAC,EAAE,aAAa,CAAC;IAExB;;;OAGG;IACH,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB;;;;;OAKG;IACH,eAAe,CAAC,EAAE,OAAO,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,mBAAmB,CAAC;AAEzD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,mBAAmB;IAC9D;;;;OAIG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,SAAS;IACxB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAE3C;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;AAE1D;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC1B;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;;;;;OAQG;IACH,GAAG,CAAC,EAAE,WAAW,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,CAAC;IAExE;;;;;;;;OAQG;IACH,EAAE,CAAC,EAAE,WAAW,CAAC,sBAAsB,CAAC,mBAAmB,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;IAEtE;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IAEtB;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,EAAE,CAAC;IAEjB;;;;OAIG;IACH,GAAG,CAAC,EAAE,oBAAoB,CAAC;IAE3B;;;;;OAKG;IACH,IAAI,CAAC,EAAE,OAAO,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;;;;;;;;OAaG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B;;;;;OAKG;IACH,YAAY,EAAE,WAAW,EAAE,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC;IAEb;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;CACvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wp-tester/config",
-  "version": "0.0.4",
+  "version": "0.1.0",
   "description": "Configuration management for wp-tester",
   "type": "module",
   "private": false,