types - pull comments configuration into definition, use right type

Author: cscheid

src/project/types/website/website-giscus.ts

@@ -32,6 +32,7 @@ export async function resolveFormatForGiscus(
 ) {
   const comments = format.metadata[kComments] as
     | Record<string, unknown>
+    | false
     | undefined;
   if (!comments) return;
 

src/resources/editor/tools/vs-code.mjs

@@ -178,7 +178,107 @@
         preferred_color_scheme,
       ]
 
-- id: comments
+- id: giscus-configuration
+  object:
+    closed: true
+    properties:
+      repo:
+        string:
+          description:
+            short: The Github repo that will be used to store comments.
+            long: |
+              The Github repo that will be used to store comments.
+
+              In order to work correctly, the repo must be public, with the giscus app installed, and 
+              the discussions feature must be enabled.
+      repo-id:
+        string:
+          description:
+            short: The Github repository identifier.
+            long: |
+              The Github repository identifier.
+
+              You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
+              If this is not provided, Quarto will attempt to discover it at render time.
+      category:
+        string:
+          description:
+            short: The discussion category where new discussions will be created.
+            long: |
+              The discussion category where new discussions will be created. It is recommended 
+              to use a category with the **Announcements** type so that new discussions 
+              can only be created by maintainers and giscus.
+      category-id:
+        string:
+          description:
+            short: The Github category identifier.
+            long: |
+              The Github category identifier.
+
+              You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
+              If this is not provided, Quarto will attempt to discover it at render time.
+      mapping:
+        anyOf:
+          - enum: [pathname, url, title, og:title]
+          - string
+        description:
+          short: The mapping between the page and the embedded discussion.
+          long: |
+            The mapping between the page and the embedded discussion. 
+
+            - `pathname`: The discussion title contains the page path
+            - `url`: The discussion title contains the page url
+            - `title`: The discussion title contains the page title
+            - `og:title`: The discussion title contains the `og:title` metadata value
+            - any other string or number: Any other strings will be passed through verbatim and a discussion title
+            containing that value will be used. Numbers will be treated
+            as a discussion number and automatic discussion creation is not supported.
+      reactions-enabled:
+        boolean:
+          description: Display reactions for the discussion's main post before the comments.
+      loading:
+        enum: [lazy]
+        description: "Specify `loading: lazy` to defer loading comments until the user scrolls near the comments container."
+      input-position:
+        enum: [top, bottom]
+        description: Place the comment input box above or below the comments.
+      theme:
+        anyOf:
+          - string
+          - ref: giscus-themes
+          - object:
+              closed: true
+              properties:
+                light:
+                  anyOf:
+                    - string
+                    - ref: giscus-themes
+                  description: The light theme name.
+                dark:
+                  anyOf:
+                    - string
+                    - ref: giscus-themes
+                  description: The dark theme name.
+
+        description:
+          short: The giscus theme to use when displaying comments.
+          long: |
+            The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key: 
+
+            ```yaml
+            website:
+              comments:
+                giscus:
+                  theme:
+                    light: light # giscus theme used for light website theme
+                    dark: dark_dimmed # giscus theme used for dark website theme
+            ```
+      language:
+        string:
+          description: The language that should be used when displaying the commenting interface.
+    required: [repo]
+
+- id: document-comments-configuration
   anyOf:
     - enum: [false]
     - object:
@@ -226,104 +326,7 @@
                       - og:title
               required: [repo]
           giscus:
-            object:
-              closed: true
-              properties:
-                repo:
-                  string:
-                    description:
-                      short: The Github repo that will be used to store comments.
-                      long: |
-                        The Github repo that will be used to store comments.
-
-                        In order to work correctly, the repo must be public, with the giscus app installed, and 
-                        the discussions feature must be enabled.
-                repo-id:
-                  string:
-                    description:
-                      short: The Github repository identifier.
-                      long: |
-                        The Github repository identifier.
-
-                        You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
-                        If this is not provided, Quarto will attempt to discover it at render time.
-                category:
-                  string:
-                    description:
-                      short: The discussion category where new discussions will be created.
-                      long: |
-                        The discussion category where new discussions will be created. It is recommended 
-                        to use a category with the **Announcements** type so that new discussions 
-                        can only be created by maintainers and giscus.
-                category-id:
-                  string:
-                    description:
-                      short: The Github category identifier.
-                      long: |
-                        The Github category identifier.
-
-                        You can quickly find this by using the configuration tool at [https://giscus.app](https://giscus.app).
-                        If this is not provided, Quarto will attempt to discover it at render time.
-                mapping:
-                  anyOf:
-                    - enum: [pathname, url, title, og:title]
-                    - string
-                  description:
-                    short: The mapping between the page and the embedded discussion.
-                    long: |
-                      The mapping between the page and the embedded discussion. 
-
-                      - `pathname`: The discussion title contains the page path
-                      - `url`: The discussion title contains the page url
-                      - `title`: The discussion title contains the page title
-                      - `og:title`: The discussion title contains the `og:title` metadata value
-                      - any other string or number: Any other strings will be passed through verbatim and a discussion title
-                      containing that value will be used. Numbers will be treated
-                      as a discussion number and automatic discussion creation is not supported.
-                reactions-enabled:
-                  boolean:
-                    description: Display reactions for the discussion's main post before the comments.
-                loading:
-                  enum: [lazy]
-                  description: "Specify `loading: lazy` to defer loading comments until the user scrolls near the comments container."
-                input-position:
-                  enum: [top, bottom]
-                  description: Place the comment input box above or below the comments.
-                theme:
-                  anyOf:
-                    - string
-                    - ref: giscus-themes
-                    - object:
-                        closed: true
-                        properties:
-                          light:
-                            anyOf:
-                              - string
-                              - ref: giscus-themes
-                            description: The light theme name.
-                          dark:
-                            anyOf:
-                              - string
-                              - ref: giscus-themes
-                            description: The dark theme name.
-
-                  description:
-                    short: The giscus theme to use when displaying comments.
-                    long: |
-                      The giscus theme to use when displaying comments. Light and dark themes are supported. If a single theme is provided by name, it will be used as light and dark theme. To use different themes, use `light` and `dark` key: 
-
-                      ```yaml
-                      website:
-                        comments:
-                          giscus:
-                            theme:
-                              light: light # giscus theme used for light website theme
-                              dark: dark_dimmed # giscus theme used for dark website theme
-                      ```
-                language:
-                  string:
-                    description: The language that should be used when displaying the commenting interface.
-              required: [repo]
+            ref: giscus-configuration
           hypothesis:
             anyOf:
               - boolean
@@ -1121,7 +1124,7 @@
             Default site thumbnail image alt text for `twitter` /`open-graph`
       comments:
         schema:
-          ref: comments
+          ref: document-comments-configuration
 
       open-graph:
         anyOf:

src/resources/editor/tools/yaml/web-worker.js

@@ -2,5 +2,5 @@
   tags:
     formats: [$html-files]
   schema:
-    ref: comments
+    ref: document-comments-configuration
   description: Configuration for document commenting.