improved fff plugin docs

lumeland · May 11, 2024 · 175cc1b · 175cc1b
1 parent 9b2325e
commit 175cc1b
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/plugins/fff.ts b/plugins/fff.ts
@@ -14,9 +14,15 @@ import {
 export interface Options {
   /** The list extensions this plugin applies to */
   extensions: string[];
+  /**
+   * The list of presets to apply
+   * @see https://fff.js.org/concepts/flavor-transform.html#fff-transform-preset
+   */
   presets: FFFTransformPreset[];
   strict: false | StrictPresetOptions;
+  /** To convert the generic `date` field to one of these values */
   date?: "created" | "updated" | "published";
+  /** Get the date from the git history */
   getGitDate?: boolean;
   postTypeDiscovery?: boolean;
 }