chore(ses-ava): Replace dynamic CLI options with static ones

Fixes #2998

Replace --no-config-$name and --only-config-$name with --exclude $name
and --only $name (and respective shorthands -x $name and -o $name).

Author: gibson042

packages/ses-ava/README.md

@@ -36,9 +36,9 @@ SES-AVA also provides a command line tool, `ses-ava`, that can run AVA with
 multiple configurations in a single command, intercepting flags to filter
 for interesting configurations.
 The `ses-ava` command consumes the `"ava"` and (new) `"sesAvaConfigs"` properties
-in `package.json` to discover and name the supported configurations and infer
-flags like `--only-config-configname` and `--no-config-configname` for each,
-where the `"ava"` configuration is the `default`, if present.
+in `package.json` to discover and name the supported configurations which can be
+referenced by `--only` and `--exclude` options (and their respective `-o` and
+`-x` shorthands), where the `"ava"` configuration is the `default`, if present.
 
 With appropriate configurations, packages can run many of the same tests
 with or without an initialized Endo environment.
@@ -93,8 +93,8 @@ Then, in `package.json`, we can use `ses-ava` instead of `ava`.
 }
 ```
 
-With this configuration, `ses-ava ...args --no-config-lockdown` and `ses-ava
-...args --only-config-unsafe` would both just run the `unsafe` configuration.
+With this configuration, `ses-ava ...args --exclude lockdown` and `ses-ava
+...args --only unsafe` would both just run the `unsafe` configuration.
 Using `ses-ava` under `c8` allows all configurations to cover used code.
 
 # Compatibility

packages/ses-ava/package.json

@@ -40,7 +40,7 @@
     "lint-fix": "eslint --fix .",
     "lint:eslint": "eslint .",
     "lint:types": "tsc",
-    "test": "ava && bin/ses-ava --only-config-env --only-config-raw"
+    "test": "ava && bin/ses-ava --only env --only raw"
   },
   "dependencies": {
     "@endo/env-options": "workspace:^",

packages/ses-ava/src/command.js

@@ -6,8 +6,9 @@
  * Each of these configurations requires a separate AVA config file like
  * test/_ava.special.config.js and a name.
  * The ses-ava command will by default run all tests in every mode but allows
- * the user to pass --only-* and --no-* at any argument position for any of
- * the named configurations to filter.
+ * the user to pass --only <name> and --exclude <name> (or shorthands -o <name>
+ * and -x <name>) at any argument position for any of the named configurations
+ * to filter.
  * Consequently, the "test" script for a package using ses-ava can simply be
  * "ses-ava" and preserves the filtering behaviors of the underlying "ava"
  * sessions if run like `yarn test -m file`.
@@ -46,8 +47,6 @@ export const main = async () => {
   if (ava) sesAvaConfigs.default = undefined;
   const keys = Object.keys(sesAvaConfigs);
   const allConfigNames = new Set(keys);
-  const noFlags = new Map(keys.map(key => [`--no-config-${key}`, key]));
-  const onlyFlags = new Map(keys.map(key => [`--only-config-${key}`, key]));
 
   // Parse arguments.
   const passThroughArgs = [];
@@ -56,38 +55,43 @@ export const main = async () => {
   let failFast = false;
   let firstArg = true;
   const argsIterator = process.argv.slice(2)[Symbol.iterator]();
-  for (const arg of argsIterator) {
-    if (arg === '--') {
+  for (const rawArg of argsIterator) {
+    if (rawArg === '--') {
       passThroughArgs.push(...argsIterator);
       break;
     }
-    const noKey = noFlags.get(arg);
-    const onlyKey = onlyFlags.get(arg);
-    const equalsAt = arg.indexOf('=');
-    if (passThroughFlags.has(arg)) {
-      passThroughArgs.push(arg);
-    } else if (arg.startsWith('--') && equalsAt !== -1) {
-      const flag = arg.slice(0, equalsAt);
-      if (!passThroughArgOptions.has(flag)) {
-        throw new Error(`Unrecognized flag ${flag}`);
+    const charsBeforeOptArg = rawArg.startsWith('--') ? rawArg.indexOf('=') : 2;
+    const arg =
+      charsBeforeOptArg !== -1 ? rawArg.slice(0, charsBeforeOptArg) : rawArg;
+    const getOptArg = () => {
+      if (charsBeforeOptArg !== -1) {
+        if (rawArg.startsWith('--')) return rawArg.slice(charsBeforeOptArg + 1);
+        if (rawArg.length > 2) return rawArg.slice(2);
       }
-      passThroughArgs.push(arg);
-    } else if (passThroughArgOptions.has(arg)) {
-      const { value: nextArg, done } = argsIterator.next();
+      const { value, done } = argsIterator.next();
       if (done) {
         throw new Error(`Expected argument after ${arg}`);
       }
-      passThroughArgs.push(arg, nextArg);
-    } else if (arg === '--fail-fast') {
+      return value;
+    };
+    if (passThroughFlags.has(arg)) {
+      passThroughArgs.push(rawArg);
+    } else if (passThroughArgOptions.has(arg)) {
+      if (arg !== rawArg) {
+        passThroughArgs.push(rawArg);
+      } else {
+        passThroughArgs.push(arg, getOptArg());
+      }
+    } else if (rawArg === '--fail-fast') {
       // Pass-through too
-      passThroughArgs.push(arg);
+      passThroughArgs.push(rawArg);
       failFast = true;
     } else if (arg === 'reset-cache' && firstArg) {
-      passThroughArgs.push(arg);
-    } else if (noKey) {
-      noConfigNames.add(noKey);
-    } else if (onlyKey) {
-      onlyConfigNames.add(onlyKey);
+      passThroughArgs.push(rawArg);
+    } else if (arg === '--exclude' || arg === '-x') {
+      noConfigNames.add(getOptArg());
+    } else if (arg === '--only' || arg === '-o') {
+      onlyConfigNames.add(getOptArg());
     } else if (arg.startsWith('-')) {
       throw new Error(
         `Unknown flag ${arg}. If this is an ava flag, pass through after --.`,
@@ -102,11 +106,9 @@ export const main = async () => {
   const configs = new Set();
   for (const config of noConfigNames) {
     if (onlyConfigNames.has(config)) {
-      // Ask not the advice of wizards, for they will say both --no-config- and
-      // --only-config-.
-      throw new Error(
-        `ses-ava cannot respect both --no-config-${config} and --only-config-${config}`,
-      );
+      // Ask not the advice of wizards, for they will say both --include and
+      // --exclude.
+      throw new Error(`ses-ava cannot both include and exclude ${config}`);
     }
   }
   for (const config of onlyConfigNames.size > 0

packages/ses-ava/test/ses-ava.env-test.js

@@ -3,6 +3,6 @@
 import test from 'ava';
 
 test('ses-ava env', t => {
-  // ses-ava --only-config-* flag sees this test and the corresponding config
+  // ses-ava `--only env` flag sees this test and the corresponding config
   t.is(process.env.SES_AVA, '1');
 });

packages/ses-ava/test/ses-ava.must-not-test.js

@@ -1,5 +1,5 @@
 import test from 'ava';
 
-test('ses-ava --no-config-* prevents this test from being discovered', t => {
-  t.fail('should not be reachable because --no-config-two');
+test('ses-ava --exclude prevents this test from being discovered', t => {
+  t.fail('should not be reachable because --exclude two');
 });