lint

invertase · Jul 17, 2024 · ad8c9ae · ad8c9ae
1 parent 5838db2
commit ad8c9ae
Show file tree

Hide file tree

Showing 14 changed files with 1,009 additions and 1,012 deletions.
diff --git a/api/src/bundler/index.ts b/api/src/bundler/index.ts
@@ -7,195 +7,195 @@ import { parseMdx } from "./mdx";
 import type { HeadingNode } from "./plugins/rehype-headings";
 
 export const ERROR_CODES = {
-  REPO_NOT_FOUND: "REPO_NOT_FOUND",
-  FILE_NOT_FOUND: "FILE_NOT_FOUND",
-  BUNDLE_ERROR: "BUNDLE_ERROR",
+	REPO_NOT_FOUND: "REPO_NOT_FOUND",
+	FILE_NOT_FOUND: "FILE_NOT_FOUND",
+	BUNDLE_ERROR: "BUNDLE_ERROR",
 } as const;
 
 type Source = {
-  type: "PR" | "commit" | "branch";
-  owner: string;
-  repository: string;
-  ref?: string;
+	type: "PR" | "commit" | "branch";
+	owner: string;
+	repository: string;
+	ref?: string;
 };
 
 export type BundlerOutput = {
-  source: Source;
-  ref: string;
-  stars: number;
-  forks: number;
-  private: boolean;
-  baseBranch: string;
-  path: string;
-  config: Config;
-  markdown: string;
-  headings: HeadingNode[];
-  frontmatter: Record<string, unknown>;
-  code: string;
+	source: Source;
+	ref: string;
+	stars: number;
+	forks: number;
+	private: boolean;
+	baseBranch: string;
+	path: string;
+	config: Config;
+	markdown: string;
+	headings: HeadingNode[];
+	frontmatter: Record<string, unknown>;
+	code: string;
 };
 
 type CreateBundlerParams = {
-  // The owner of the repository to bundle.
-  owner: string;
-  // The repository to bundle.
-  repository: string;
-  // The path to file in the repository to bundle.
-  path: string;
-  // An optional ref to use for the content.
-  ref?: string;
-  // A list of components which are supported for bundling.
-  components?: Array<string>;
+	// The owner of the repository to bundle.
+	owner: string;
+	// The repository to bundle.
+	repository: string;
+	// The path to file in the repository to bundle.
+	path: string;
+	// An optional ref to use for the content.
+	ref?: string;
+	// A list of components which are supported for bundling.
+	components?: Array<string>;
 };
 
 export class Bundler {
-  readonly #owner: string;
-  readonly #repository: string;
-  readonly #path: string;
-  readonly #components: Array<string>;
-  #ref: string | undefined;
-  #source?: Source;
-  #config?: Config;
-  #markdown?: string;
-
-  constructor(params: CreateBundlerParams) {
-    this.#owner = params.owner;
-    this.#repository = params.repository;
-    this.#path = params.path;
-    this.#ref = params.ref;
-    this.#components = params.components || [];
-  }
-
-  /**
-   * Gets the source of the bundle.
-   *
-   * If the ref is a PR, it will fetch the PR metadata and update the source.
-   */
-  private async getSource(): Promise<Source> {
-    if (this.#ref) {
-      // If the ref is a PR
-      if (/^[0-9]*$/.test(this.#ref)) {
-        const pullRequest = await getPullRequestMetadata(
-          this.#owner,
-          this.#repository,
-          this.#ref
-        );
-        if (pullRequest) {
-          return {
-            type: "PR",
-            ...pullRequest,
-          };
-        }
-      }
-
-      // If the ref is a commit hash
-      if (/^[a-fA-F0-9]{40}$/.test(this.#ref)) {
-        return {
-          type: "commit",
-          owner: this.#owner,
-          repository: this.#repository,
-          ref: this.#ref,
-        };
-      }
-    }
-
-    return {
-      type: "branch",
-      owner: this.#owner,
-      repository: this.#repository,
-      ref: this.#ref,
-    };
-  }
-
-  /**
-   * Builds the payload with the MDX bundle.
-   */
-  async build(): Promise<BundlerOutput> {
-    // Get the real source of the request
-    this.#source = await this.getSource();
-
-    // Update the ref to the real ref
-    this.#ref = this.#source.ref;
-
-    const metadata = await getGitHubContents({
-      owner: this.#source.owner,
-      repository: this.#source.repository,
-      path: this.#path,
-      ref: this.#ref,
-    });
-
-    if (!metadata) {
-      throw new BundlerError({
-        code: 404,
-        name: ERROR_CODES.REPO_NOT_FOUND,
-        message: `The repository ${this.#source.owner}/${
-          this.#source.repository
-        } was not found.`,
-      });
-    }
-
-    if (!metadata.md) {
-      throw new BundlerError({
-        code: 404,
-        name: ERROR_CODES.FILE_NOT_FOUND,
-        message: `No file was found in the repository matching this path. Ensure a file exists at <code>/docs/${
-          this.#path
-        }.mdx<code> or <code>/docs/${this.#path}/index.mdx<code>.`,
-        source: `https://github.com/${this.#source.owner}/${
-          this.#source.repository
-        }`,
-      });
-    }
-
-    this.#markdown = metadata.md;
-
-    // If there is no ref (either not provided, or not a PR), use the metadata.
-    if (!this.#ref) {
-      this.#ref = metadata.baseBranch;
-      this.#source.ref = metadata.baseBranch;
-    }
-
-    // Parse the users config, but fallback if it errors.
-    try {
-      this.#config = parseConfig({
-        json: metadata.config.configJson,
-        yaml: metadata.config.configYaml,
-      });
-    } catch {
-      this.#config = defaultConfig;
-    }
-
-    try {
-      // Bundle the markdown file via MDX.
-      const mdx = await parseMdx(this.#markdown, {
-        headerDepth: this.#config.content?.headerDepth ?? 3,
-        components: this.#components,
-      });
-
-      return {
-        source: this.#source,
-        ref: this.#ref,
-        stars: metadata.stars,
-        forks: metadata.forks,
-        private: metadata.isPrivate,
-        baseBranch: metadata.baseBranch,
-        path: this.#path,
-        config: this.#config,
-        markdown: this.#markdown,
-        headings: mdx.headings,
-        frontmatter: mdx.frontmatter,
-        code: replaceMoustacheVariables(this.#config.variables ?? {}, mdx.code),
-      };
-    } catch (e) {
-      console.error(e);
-      // @ts-ignore
-      throw new BundlerError({
-        code: 500,
-        name: ERROR_CODES.BUNDLE_ERROR,
-        message: `Something went wrong while bundling the file /${metadata.path}.mdx. Are you sure the MDX is valid?`,
-        source: `https://github.com/${this.#source.owner}/${
-          this.#source.repository
-        }`,
-      });
-    }
-  }
+	readonly #owner: string;
+	readonly #repository: string;
+	readonly #path: string;
+	readonly #components: Array<string>;
+	#ref: string | undefined;
+	#source?: Source;
+	#config?: Config;
+	#markdown?: string;
+
+	constructor(params: CreateBundlerParams) {
+		this.#owner = params.owner;
+		this.#repository = params.repository;
+		this.#path = params.path;
+		this.#ref = params.ref;
+		this.#components = params.components || [];
+	}
+
+	/**
+	 * Gets the source of the bundle.
+	 *
+	 * If the ref is a PR, it will fetch the PR metadata and update the source.
+	 */
+	private async getSource(): Promise<Source> {
+		if (this.#ref) {
+			// If the ref is a PR
+			if (/^[0-9]*$/.test(this.#ref)) {
+				const pullRequest = await getPullRequestMetadata(
+					this.#owner,
+					this.#repository,
+					this.#ref,
+				);
+				if (pullRequest) {
+					return {
+						type: "PR",
+						...pullRequest,
+					};
+				}
+			}
+
+			// If the ref is a commit hash
+			if (/^[a-fA-F0-9]{40}$/.test(this.#ref)) {
+				return {
+					type: "commit",
+					owner: this.#owner,
+					repository: this.#repository,
+					ref: this.#ref,
+				};
+			}
+		}
+
+		return {
+			type: "branch",
+			owner: this.#owner,
+			repository: this.#repository,
+			ref: this.#ref,
+		};
+	}
+
+	/**
+	 * Builds the payload with the MDX bundle.
+	 */
+	async build(): Promise<BundlerOutput> {
+		// Get the real source of the request
+		this.#source = await this.getSource();
+
+		// Update the ref to the real ref
+		this.#ref = this.#source.ref;
+
+		const metadata = await getGitHubContents({
+			owner: this.#source.owner,
+			repository: this.#source.repository,
+			path: this.#path,
+			ref: this.#ref,
+		});
+
+		if (!metadata) {
+			throw new BundlerError({
+				code: 404,
+				name: ERROR_CODES.REPO_NOT_FOUND,
+				message: `The repository ${this.#source.owner}/${
+					this.#source.repository
+				} was not found.`,
+			});
+		}
+
+		if (!metadata.md) {
+			throw new BundlerError({
+				code: 404,
+				name: ERROR_CODES.FILE_NOT_FOUND,
+				message: `No file was found in the repository matching this path. Ensure a file exists at <code>/docs/${
+					this.#path
+				}.mdx<code> or <code>/docs/${this.#path}/index.mdx<code>.`,
+				source: `https://github.com/${this.#source.owner}/${
+					this.#source.repository
+				}`,
+			});
+		}
+
+		this.#markdown = metadata.md;
+
+		// If there is no ref (either not provided, or not a PR), use the metadata.
+		if (!this.#ref) {
+			this.#ref = metadata.baseBranch;
+			this.#source.ref = metadata.baseBranch;
+		}
+
+		// Parse the users config, but fallback if it errors.
+		try {
+			this.#config = parseConfig({
+				json: metadata.config.configJson,
+				yaml: metadata.config.configYaml,
+			});
+		} catch {
+			this.#config = defaultConfig;
+		}
+
+		try {
+			// Bundle the markdown file via MDX.
+			const mdx = await parseMdx(this.#markdown, {
+				headerDepth: this.#config.content?.headerDepth ?? 3,
+				components: this.#components,
+			});
+
+			return {
+				source: this.#source,
+				ref: this.#ref,
+				stars: metadata.stars,
+				forks: metadata.forks,
+				private: metadata.isPrivate,
+				baseBranch: metadata.baseBranch,
+				path: this.#path,
+				config: this.#config,
+				markdown: this.#markdown,
+				headings: mdx.headings,
+				frontmatter: mdx.frontmatter,
+				code: replaceMoustacheVariables(this.#config.variables ?? {}, mdx.code),
+			};
+		} catch (e) {
+			console.error(e);
+			// @ts-ignore
+			throw new BundlerError({
+				code: 500,
+				name: ERROR_CODES.BUNDLE_ERROR,
+				message: `Something went wrong while bundling the file /${metadata.path}.mdx. Are you sure the MDX is valid?`,
+				source: `https://github.com/${this.#source.owner}/${
+					this.#source.repository
+				}`,
+			});
+		}
+	}
 }