Add help flag for flexible-event script (#1470)

WICG · Nov 19, 2024 · a197888 · a197888
1 parent fa4943f
commit a197888
Showing 1 changed file with 59 additions and 41 deletions.
diff --git a/ts/src/flexible-event/main.ts b/ts/src/flexible-event/main.ts
@@ -26,50 +26,68 @@ interface Arguments {
   windows?: Wrapped<number[]>
   buckets?: Wrapped<number[]>
   json_file?: string
+  help: boolean
 }
 
-const options = parse<Arguments>({
-  max_event_level_reports: {
-    alias: 'm',
-    type: Number,
-    defaultValue: 20,
+const options = parse<Arguments>(
+  {
+    max_event_level_reports: {
+      alias: 'm',
+      type: Number,
+      defaultValue: 20,
+    },
+    attribution_scope_limit: {
+      alias: 'a',
+      type: Number,
+      optional: true,
+    },
+    max_event_states: {
+      alias: 's',
+      type: Number,
+      optional: true,
+    },
+    epsilon: {
+      alias: 'e',
+      type: Number,
+      defaultValue: 14,
+    },
+    source_type: {
+      alias: 't',
+      type: parseSourceType,
+      defaultValue: SourceType.navigation,
+    },
+    windows: {
+      alias: 'w',
+      type: commaSeparatedInts,
+      optional: true,
+    },
+    buckets: {
+      alias: 'b',
+      type: commaSeparatedInts,
+      optional: true,
+    },
+    json_file: {
+      alias: 'f',
+      type: String,
+      optional: true,
+    },
+    help: {
+      alias: 'h',
+      type: Boolean,
+      description: 'Prints this usage guide.',
+    },
   },
-  attribution_scope_limit: {
-    alias: 'a',
-    type: Number,
-    optional: true,
-  },
-  max_event_states: {
-    alias: 's',
-    type: Number,
-    optional: true,
-  },
-  epsilon: {
-    alias: 'e',
-    type: Number,
-    defaultValue: 14,
-  },
-  source_type: {
-    alias: 't',
-    type: parseSourceType,
-    defaultValue: SourceType.navigation,
-  },
-  windows: {
-    alias: 'w',
-    type: commaSeparatedInts,
-    optional: true,
-  },
-  buckets: {
-    alias: 'b',
-    type: commaSeparatedInts,
-    optional: true,
-  },
-  json_file: {
-    alias: 'f',
-    type: String,
-    optional: true,
-  },
-})
+  {
+    helpArg: 'help',
+    headerContentSections: [
+      {
+        header: 'Attribution Reporting Flexible Event',
+        content:
+          'Computes privacy-related information for an attribution source.',
+      },
+    ],
+  }
+)
 
 function logIssue(prefix: string, i: Issue): void {
   console.log(