docs: make role of getQuartzComponents more clear and also make it optional

quartz/plugins/emitters/aliases.ts

@@ -6,9 +6,6 @@ import { getAliasSlugs } from "../transformers/frontmatter"
 
 export const AliasRedirects: QuartzEmitterPlugin = () => ({
   name: "AliasRedirects",
-  getQuartzComponents() {
-    return []
-  },
   async getDependencyGraph(ctx, content, _resources) {
     const graph = new DepGraph<FilePath>()
 
@@ -22,7 +19,6 @@ export const AliasRedirects: QuartzEmitterPlugin = () => ({
     return graph
   },
   async emit(ctx, content, _resources): Promise<FilePath[]> {
-    const { argv } = ctx
     const fps: FilePath[] = []
 
     for (const [_tree, file] of content) {

quartz/plugins/emitters/assets.ts

@@ -15,9 +15,6 @@ const filesToCopy = async (argv: Argv, cfg: QuartzConfig) => {
 export const Assets: QuartzEmitterPlugin = () => {
   return {
     name: "Assets",
-    getQuartzComponents() {
-      return []
-    },
     async getDependencyGraph(ctx, _content, _resources) {
       const { argv, cfg } = ctx
       const graph = new DepGraph<FilePath>()

quartz/plugins/emitters/cname.ts

@@ -11,9 +11,6 @@ export function extractDomainFromBaseUrl(baseUrl: string) {
 
 export const CNAME: QuartzEmitterPlugin = () => ({
   name: "CNAME",
-  getQuartzComponents() {
-    return []
-  },
   async getDependencyGraph(_ctx, _content, _resources) {
     return new DepGraph<FilePath>()
   },

quartz/plugins/emitters/componentResources.ts

@@ -24,7 +24,7 @@ type ComponentResources = {
 function getComponentResources(ctx: BuildCtx): ComponentResources {
   const allComponents: Set<QuartzComponent> = new Set()
   for (const emitter of ctx.cfg.plugins.emitters) {
-    const components = emitter.getQuartzComponents(ctx)
+    const components = emitter.getQuartzComponents?.(ctx) ?? []
     for (const component of components) {
       allComponents.add(component)
     }
@@ -200,9 +200,6 @@ function addGlobalPageResources(ctx: BuildCtx, componentResources: ComponentReso
 export const ComponentResources: QuartzEmitterPlugin = () => {
   return {
     name: "ComponentResources",
-    getQuartzComponents() {
-      return []
-    },
     async getDependencyGraph(_ctx, _content, _resources) {
       return new DepGraph<FilePath>()
     },

quartz/plugins/emitters/contentIndex.tsx

@@ -196,6 +196,5 @@ export const ContentIndex: QuartzEmitterPlugin<Partial<Options>> = (opts) => {
         }
       }
     },
-    getQuartzComponents: () => [],
   }
 }

quartz/plugins/emitters/static.ts

@@ -6,9 +6,6 @@ import DepGraph from "../../depgraph"
 
 export const Static: QuartzEmitterPlugin = () => ({
   name: "Static",
-  getQuartzComponents() {
-    return []
-  },
   async getDependencyGraph({ argv, cfg }, _content, _resources) {
     const graph = new DepGraph<FilePath>()
 

quartz/plugins/types.ts

@@ -39,7 +39,12 @@ export type QuartzEmitterPlugin<Options extends OptionType = undefined> = (
 export type QuartzEmitterPluginInstance = {
   name: string
   emit(ctx: BuildCtx, content: ProcessedContent[], resources: StaticResources): Promise<FilePath[]>
-  getQuartzComponents(ctx: BuildCtx): QuartzComponent[]
+  /**
+   * Returns the components (if any) that are used in rendering the page.
+   * This helps Quartz optimize the page by only including necessary resources
+   * for components that are actually used.
+   */
+  getQuartzComponents?: (ctx: BuildCtx) => QuartzComponent[]
   getDependencyGraph?(
     ctx: BuildCtx,
     content: ProcessedContent[],