rename option

Author: AndreasArvidsson

packages/lib-common/src/types/HatTokenMap.ts

@@ -16,10 +16,10 @@ export interface HatTokenMap {
 
 export interface HatAllocationOptions {
   /**
-   * Whether to preserve previous hat assignments. Defaults to `true`.
-   * Set to `false` to initialize an allocation independently of its history.
+   * Whether to ignore previous hat assignments and allocate from scratch.
+   * Defaults to `false`. Forced hats still apply when starting fresh.
    */
-  preserveExistingHats?: boolean;
+  startFresh?: boolean;
 }
 
 export interface TokenHat {

packages/lib-engine/src/core/HatAllocator.test.ts

@@ -76,7 +76,7 @@ suite("HatAllocator", () => {
       assert.ok(map.getToken("blue", "h"), "Normal allocation preserves hats");
 
       await allocator.allocateHats([forcedWorld], {
-        preserveExistingHats: false,
+        startFresh: true,
       });
       assert.deepEqual(snapshot(), expected);
       assert.ok(map.getToken("default", "w"), "Forced hats are still applied");

packages/lib-engine/src/core/HatAllocator.ts

@@ -60,11 +60,11 @@ export class HatAllocator {
    *
    * @param forceTokenHats If supplied, force the allocator to use these hats
    * for the given tokens. This is used for the tutorial, and for testing.
-   * @param options Controls whether to preserve previous hat assignments.
+   * @param options Controls whether to start fresh without previous hat assignments.
    */
   async allocateHats(
     forceTokenHats?: TokenHat[],
-    { preserveExistingHats = true }: HatAllocationOptions = {},
+    { startFresh = false }: HatAllocationOptions = {},
   ) {
     const activeMap = await this.context.getActiveMap();
 
@@ -80,9 +80,7 @@ export class HatAllocator {
           tokenGraphemeSplitter: this.tokenGraphemeSplitter,
           enabledHatStyles: this.hats.enabledHatStyles,
           forceTokenHats: normalizedForceTokenHats,
-          oldTokenHats: preserveExistingHats
-            ? activeMap.getStaleTokenHats()
-            : [],
+          oldTokenHats: startFresh ? [] : activeMap.getStaleTokenHats(),
           hatStability: this.ide.configuration.getOwnConfiguration(
             "experimental.hatStability",
           ),

packages/lib-node-common/src/runRecordedTest.ts

@@ -152,7 +152,7 @@ export async function runRecordedTest({
   // depend on whether VS Code delivered those events before this point.
   await hatTokenMap.allocateHats(
     serializedMarksToTokenHats(fixture.initialState.marks, editor),
-    { preserveExistingHats: false },
+    { startFresh: true },
   );
 
   await Promise.all(