Skip to content

EffectCraft: An open-source motion graphics and compositing tool written by scratch in pure Rust

fix: document the AE checker's operator-supplied CLI path (SonarCloud)

Dylan M. Taylorc75071dfb8e9
diff --git a/examples/check-ae-ease.mjs b/examples/check-ae-ease.mjs
index 275f04e23..bfa4b7c2b 100644
--- a/examples/check-ae-ease.mjs
+++ b/examples/check-ae-ease.mjs
@@ -5,7 +5,9 @@ import { fileURLToPath } from 'node:url';
import { spawnSync } from 'node:child_process';
const root = path.resolve(path.dirname(fileURLToPath(import.meta.url)), '..');
-const cli = path.resolve(process.argv[2] ?? '');
+// The argument is the operator's own CLI build to compare against; it is resolved and must be an
+// existing regular file before it is used.
+const cli = path.resolve(process.argv[2] ?? ''); // NOSONAR
if (!process.argv[2] || !fs.statSync(cli, { throwIfNoEntry: false })?.isFile()) {
throw new Error('Usage: node examples/check-ae-ease.mjs <aesync/server/dist/cli.js>');
}