[patch] allow virmator flags to be passed after the command name

electrovir · Aug 13, 2024 · fbff3e7 · fbff3e7
1 parent 36dbdc6
commit fbff3e7
Show file tree

Hide file tree

Showing 20 changed files with 142 additions and 93 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@virmator/mono-repo-root",
-    "version": "13.2.6",
+    "version": "13.2.7",
     "private": true,
     "type": "module",
     "workspaces": [

diff --git a/packages/compile/package.json b/packages/compile/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@virmator/compile",
-    "version": "13.2.6",
+    "version": "13.2.7",
     "description": "Default TS compile plugin for virmator.",
     "keywords": [
         "virmator",
@@ -33,12 +33,12 @@
     "dependencies": {
         "@augment-vir/common": "^29.3.0",
         "@augment-vir/node-js": "^29.3.0",
-        "@virmator/core": "^13.2.6",
+        "@virmator/core": "^13.2.7",
         "run-time-assertions": "^1.5.2"
     },
     "devDependencies": {
         "@types/node": "^22.2.0",
-        "@virmator/plugin-testing": "^13.2.6",
+        "@virmator/plugin-testing": "^13.2.7",
         "c8": "^10.1.2",
         "chalk": "^5.3.0",
         "concurrently": "^8.2.2",

diff --git a/packages/core/package.json b/packages/core/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@virmator/core",
-    "version": "13.2.6",
+    "version": "13.2.7",
     "description": "Shared core functionality for all virmator plugins and the virmator CLI.",
     "keywords": [
         "automation",

diff --git a/packages/core/src/api/parse-args.test.ts b/packages/core/src/api/parse-args.test.ts
@@ -1,8 +1,9 @@
-import {NpmDepType, PackageType, VirmatorEnv} from '@virmator/core';
+import {emptyLog, NpmDepType, PackageType, VirmatorEnv} from '@virmator/core';
 import assert from 'node:assert/strict';
 import {join} from 'node:path';
 import {describe, it} from 'node:test';
-import {calculateUsedCommands} from './parse-args.js';
+import {VirmatorPlugin} from '../plugin/plugin.js';
+import {calculateUsedCommands, parseCliArgs} from './parse-args.js';
 
 describe(calculateUsedCommands.name, () => {
     it('calculates correctly', () => {
@@ -186,3 +187,51 @@ describe(calculateUsedCommands.name, () => {
         );
     });
 });
+
+describe(parseCliArgs.name, () => {
+    const examplePlugins = [
+        {
+            cliCommands: {
+                fake: {},
+            },
+            name: 'fake plugin',
+        } satisfies Pick<
+            VirmatorPlugin,
+            | 'name'
+            | 'cliCommands'
+        > as VirmatorPlugin,
+    ] as const satisfies ReadonlyArray<Readonly<VirmatorPlugin>>;
+
+    function testParseCliArgs(cliCommand: string) {
+        return parseCliArgs({
+            cliCommand,
+            entryPointFilePath: '',
+            plugins: examplePlugins,
+            log: emptyLog,
+        });
+    }
+
+    it('parses command name', () => {
+        assert.deepStrictEqual(testParseCliArgs('fake'), {
+            commands: ['fake'],
+            filteredCommandArgs: [],
+            plugin: examplePlugins[0],
+            usedCommands: {fake: {subCommands: {}}},
+            virmatorFlags: {},
+        });
+    });
+    it('parses multiple args', () => {
+        assert.deepStrictEqual(testParseCliArgs('fake --no-deps some-arg --more-arg'), {
+            commands: ['fake'],
+            filteredCommandArgs: [
+                'some-arg',
+                '--more-arg',
+            ],
+            plugin: examplePlugins[0],
+            usedCommands: {fake: {subCommands: {}}},
+            virmatorFlags: {
+                '--no-deps': true,
+            },
+        });
+    });
+});
diff --git a/packages/core/src/api/parse-args.ts b/packages/core/src/api/parse-args.ts
@@ -144,7 +144,9 @@ export function parseCliArgs({
 
     const parsedArgs = relevantArgs.reduce(
         (parsedArgs: ParsedArgs, arg) => {
-            if (parsedArgs.filteredCommandArgs.length) {
+            if (hasKey(virmatorFlags, arg)) {
+                parsedArgs.virmatorFlags[arg] = true;
+            } else if (parsedArgs.filteredCommandArgs.length) {
                 parsedArgs.filteredCommandArgs.push(arg);
             } else if (isLengthAtLeast(parsedArgs.commands, 1)) {
                 const mainCommand = parsedArgs.commands[0];
@@ -164,8 +166,6 @@ export function parseCliArgs({
                 if (commandPlugin) {
                     (parsedArgs.commands as string[]).push(arg);
                     parsedArgs.plugin = commandPlugin.plugin;
-                } else if (hasKey(virmatorFlags, arg)) {
-                    parsedArgs.virmatorFlags[arg] = true;
                 } else {
                     log.warning(`Ignored unknown flag: '${arg}'`);
                 }

diff --git a/packages/core/src/plugin/plugin-logger.ts b/packages/core/src/plugin/plugin-logger.ts
@@ -90,7 +90,7 @@ export function createPluginLogger(
 }
 
 /** A {@link PluginLogger} implementation that does nothing. */
-export const emptyLogger: PluginLogger = createPluginLogger({
+export const emptyLog: PluginLogger = createPluginLogger({
     stderr: {
         write() {
             return true;