factorio-test-cli 3.1.0 → 3.1.2

package/README.md

@@ -9,60 +9,3 @@ If using an npm package, you can install `factorio-test-cli` to your dev depende
 ```bash
 npm install --save-dev factorio-test-cli
 ```
-
-## Configuration Architecture
-
-### Config Categories
-
-| Category | Casing | Location | Example Fields |
-|----------|--------|----------|----------------|
-| CLI-only | camelCase | `cli-config.ts` | `config`, `graphics`, `watch` |
-| File+CLI | camelCase | `cli-config.ts` | `modPath`, `factorioPath`, `verbose`, `forbidOnly` |
-| Test | snake_case | `types/config.d.ts` | `test_pattern`, `game_speed`, `bail` |
-
-- **CLI-only**: Options only available via command line, not in config files
-- **File+CLI**: Options that can be set in `factorio-test.json` or via command line (CLI overrides file)
-- **Test**: Runner configuration passed to the Factorio mod; uses snake_case for Lua compatibility
-
-### Type Hierarchy
-
-```
-types/config.d.ts
-└── TestRunnerConfig        # CLI-passable fields (source of truth)
-        │
-        ├── Extended by: FactorioTest.Config (types/index.d.ts)
-        │                 └── Adds mod-only fields: default_ticks_between_tests,
-        │                     before_test_run, after_test_run, sound_effects
-        │
-        └── Validated by: testRunnerConfigSchema (cli/config/test-config.ts)
-                          └── Zod schema for runtime validation
-```
-
-### Data Flow
-
-```
-CLI args ─────────────────┐
-                          ▼
-factorio-test.json ──► loadConfig() ──► mergeCliConfig() ──► RunOptions
-                                              │
-                                              ▼
-                                        buildTestConfig() ──► TestRunnerConfig ──► Factorio mod
-```
-
-1. `loadConfig()` reads `factorio-test.json` (or `package.json["factorio-test"]`)
-2. `mergeCliConfig()` merges file config with CLI options (CLI wins)
-3. `buildTestConfig()` extracts test runner options, combining patterns with OR logic
-
-### File Organization
-
-```
-types/
-├── config.d.ts       # TestRunnerConfig interface (source of truth for CLI-passable test options)
-└── index.d.ts        # FactorioTest.Config extends TestRunnerConfig with mod-only fields
-
-cli/config/
-├── index.ts          # Re-exports all public APIs
-├── test-config.ts    # Zod schema validating TestRunnerConfig + CLI registration
-├── cli-config.ts     # CliConfig + CliOnlyOptions schemas + CLI registration
-└── loader.ts         # Config loading, path resolution, merging, RunOptions type
-```

package/cli.js

@@ -1,11 +1,14 @@
 #!/usr/bin/env node
 import chalk from "chalk";
 import { program } from "commander";
+import { readFileSync } from "fs";
 import { CliError } from "./cli-error.js";
 import "./run.js";
+const { version } = JSON.parse(readFileSync(new URL("package.json", import.meta.url), "utf8"));
 try {
     await program
         .name("factorio-test")
+        .version(version)
         .description("cli for factorio testing")
         .helpCommand(true)
         .showHelpAfterError()

package/config/test-config.js

@@ -4,7 +4,7 @@ const testConfigFields = {
         schema: z.string().optional(),
         cli: {
             flags: "--test-pattern <pattern>",
-            description: "Filter tests by name pattern.",
+            description: "Filter tests by Lua pattern (escape - as %-).",
         },
     },
     tag_whitelist: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "factorio-test-cli",
-  "version": "3.1.0",
+  "version": "3.1.2",
   "description": "A CLI to run FactorioTest.",
   "license": "MIT",
   "repository": {

package/run.js

@@ -23,6 +23,10 @@ When using variadic options (--mods, --factorio-args, etc.) with filter patterns
 use -- to separate them:
   factorio-test run -p ./my-mod --mods quality space-age -- "inventory"
 
+Patterns use Lua pattern syntax (not regex). Special characters like - must be
+escaped with %:
+  factorio-test run -p ./my-mod "my%-test"  Match "my-test" (escape the dash)
+
 Examples:
   factorio-test run -p ./my-mod             Run all tests
   factorio-test run -p ./my-mod -v          Run with verbose output
@@ -30,7 +34,7 @@ Examples:
   factorio-test run -p ./my-mod -b          Bail on first failure
   factorio-test run -p ./my-mod "inventory" Run tests matching "inventory"
 `)
-    .argument("[filter...]", "Test patterns to filter (OR logic)");
+    .argument("[filter...]", "Lua patterns to filter tests (OR logic)");
 registerAllCliOptions(thisCommand);
 thisCommand.action((patterns, options) => runTests(patterns, options));
 async function setupTestRun(patterns, options) {