From 09ff261f156a8599d45c1496fe246ded6e035191 Mon Sep 17 00:00:00 2001 From: HampusM Date: Mon, 26 Jul 2021 23:56:53 +0200 Subject: Added backend TSDoc/JSDoc comments & refactored a tiny bit --- packages/server/src/git/repository.ts | 107 +++++++++++++++++++++++++++------- 1 file changed, 87 insertions(+), 20 deletions(-) (limited to 'packages/server/src/git/repository.ts') diff --git a/packages/server/src/git/repository.ts b/packages/server/src/git/repository.ts index 2b14e89..a67d6f7 100644 --- a/packages/server/src/git/repository.ts +++ b/packages/server/src/git/repository.ts @@ -7,9 +7,15 @@ import { Commit } from "./commit"; import { FastifyReply } from "fastify"; import { Tag } from "./tag"; import { Tree } from "./tree"; -import { BaseError, BranchError, createError, RepositoryError } from "./error"; +import { BranchError, createError, RepositoryError } from "./error"; import { isNodeGitReferenceBranch, isNodeGitReferenceTag, Reference } from "./reference"; +/** + * Returns the full name of a git repository + * + * @param repo_name - The name of a repository + * @returns The repository name ending with .git + */ function getFullRepositoryName(repo_name: string) { return repo_name.endsWith(".git") ? repo_name : `${repo_name}.git`; } @@ -19,18 +25,15 @@ type RepositoryName = { full: string, } -type RepositoryConstructorData = { - description: string | null, - owner: string | null, - branch: string -} - // This fucking shit isn't in the Nodegit documentation. interface WeirdNodeGitError extends Error { errno: number; errorFunction: string; } +/** + * A representation of an bare git repository + */ export class Repository { private _ng_repository: NodeGitRepository; @@ -38,26 +41,50 @@ export class Repository { public name: RepositoryName; public base_dir: string; - public description: string | null; - public owner: string | null; - constructor(repository: NodeGitRepository, data: RepositoryConstructorData) { + /** + * @param repository - An instance of a Nodegit repository + * @param branch - The branch to use + */ + constructor(repository: NodeGitRepository, branch: string) { this._ng_repository = repository; this.name = { short: basename(repository.path()).slice(0, -4), full: basename(repository.path()) }; this.base_dir = dirname(repository.path()); - this.description = data.description; - this.owner = data.owner; - this._branch = data.branch; + this._branch = branch; + } + + /** + * Returns the repository's description + */ + public description(): Promise { + return getFile(this.base_dir, this.name.full, "description"); } + /** + * Returns the repository's owner + */ + public owner(): Promise { + return getFile(this.base_dir, this.name.full, "owner"); + } + + /** + * Returns the repository's branch + * + * @returns An instance of a branch + */ public branch(): Promise { return Branch.lookup(this, this._branch); } + /** + * Returns the repository's commits + * + * @returns An array of commit instances + */ public async commits(): Promise { const walker = NodeGitRevwalk.create(this._ng_repository); walker.pushHead(); @@ -65,28 +92,60 @@ export class Repository { return Promise.all((await walker.getCommitsUntil(() => true)).map(commit => new Commit(this, commit))); } + /** + * Returns the repository's tree + * + * @returns An instance of a tree + */ public async tree(): Promise { return Tree.ofRepository(this); } + /** + * Returns if an git object exists or not + * + * @param id - The SHA of a git object + * @returns Whether or not it exists + */ public lookupExists(id: string): Promise { return NodeGitObject.lookup(this._ng_repository, NodeGitOid.fromString(id), NodeGitObject.TYPE.ANY) .then(() => true) .catch(() => false); } + /** + * Returns the repository's branches + * + * @returns An array of branch instances + */ public branches(): Promise { return Reference.all(this, Branch, isNodeGitReferenceBranch); } + /** + * Returns the repository's tags + * + * @returns An array of tag instances + */ public async tags(): Promise { return Reference.all(this, Tag, isNodeGitReferenceTag); } + /** + * Returns the repository's master commit + * + * @returns An instance of a commit + */ public async masterCommit(): Promise { return Commit.masterCommit(this); } + /** + * Connect to the Git HTTP backend + * + * @param req - A Fastify request + * @param reply - A Fastify reply + */ public HTTPconnect(req: Request, reply: FastifyReply): void { connect(this, req, reply); } @@ -95,6 +154,14 @@ export class Repository { return this._ng_repository; } + /** + * Opens a bare git repository + * + * @param base_dir - The directory that contains the repository + * @param repository - The directory of a bare repository + * @param branch - A branch to use + * @returns An instance of a git repository + */ public static async open(base_dir: string, repository: string, branch?: string): Promise { let ng_repository = await NodeGitRepository.openBare(`${base_dir}/${getFullRepositoryName(repository)}`).catch((err: WeirdNodeGitError) => { if(err.errno === -3) { @@ -110,15 +177,15 @@ export class Repository { } } - const owner = await getFile(base_dir, getFullRepositoryName(repository), "owner").catch(err => err); - - return new Repository(ng_repository, { - description: await getFile(base_dir, getFullRepositoryName(repository), "description"), - owner: owner instanceof BaseError ? null : owner, - branch: branch || "master" - }); + return new Repository(ng_repository, branch || "master"); } + /** + * Opens all of the git repositories inside a directory + * + * @param base_dir - The directory that contains the repositories + * @returns An array of repository instances + */ public static async openAll(base_dir: string): Promise { const dir_content = await getDirectory(base_dir); -- cgit v1.2.3-18-g5258