chore(core,node): remove unused LavaMoatOpts props

Removed `policy` and `policyOverride` which should be `policyPath` and `policyOverridePath`, respectively.
LavaMoat · Mar 8, 2024 · 75a6d94 · 75a6d94
1 parent a988bc5
commit 75a6d94
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 16 deletions.
diff --git a/packages/core/test/util.js b/packages/core/test/util.js
@@ -500,17 +500,17 @@ async function prepareScenarioOnDisk({
   if (!scenario.opts?.writeAutoPolicy) {
     const defaultPaths = getDefaultPaths(policyName)
     const primaryPath =
-      typeof scenario.opts?.policy === 'string'
-        ? scenario.opts.policy
+      typeof scenario.opts?.policyPath === 'string'
+        ? scenario.opts.policyPath
         : defaultPaths.primary
     filesToWrite.push({
       file: primaryPath,
       content: stringify(scenario.config),
     })
     if (scenario.configOverride) {
       const overridePath =
-        typeof scenario.opts?.policyOverride === 'string'
-          ? scenario.opts.policyOverride
+        typeof scenario.opts?.policyOverridePath === 'string'
+          ? scenario.opts.policyOverridePath
           : defaultPaths.override
       filesToWrite.push({
         file: overridePath,

diff --git a/packages/node/src/defaults.js b/packages/node/src/defaults.js
@@ -11,19 +11,20 @@ const defaultPaths = getDefaultPaths('node')
 
 /**
  * @typedef LavaMoatOpts
- * @property {LavaMoatScuttleOpts} [scuttleGlobalThis]
+ * @property {LavaMoatScuttleOpts} [scuttleGlobalThis] Enable or disable
+ *   scuttling of `globalThis`
  * @property {string[]} [scuttleGlobalThisExceptions]
- * @property {boolean} [writeAutoPolicy]
- * @property {boolean} [writeAutoPolicyDebug]
- * @property {boolean} [writeAutoPolicyAndRun]
- * @property {string} [policyPath]
- * @property {string} [policyDebugPath]
- * @property {string} [policyOverridePath]
- * @property {string} [projectRoot]
- * @property {boolean} [debugMode]
- * @property {boolean} [statsMode]
- * @property {string} [policy] - Alias for `policyPath`?
- * @property {string} [policyOverride] - Alias for `policyOverridePath`?
+ * @property {boolean} [writeAutoPolicy] Automatically write a policy file
+ * @property {boolean} [writeAutoPolicyDebug] Automatically write a debug policy
+ *   file
+ * @property {boolean} [writeAutoPolicyAndRun] Automatically write a policy file
+ *   and run the application
+ * @property {string} [policyPath] Path to policy file
+ * @property {string} [policyDebugPath] Path to policy debug file
+ * @property {string} [policyOverridePath] Path to policy override file
+ * @property {string} [projectRoot] Path to project root
+ * @property {boolean} [debugMode] Enable debug mode
+ * @property {boolean} [statsMode] Enable stats mode
  */
 
 /** @type {LavaMoatOpts} */