remove unlink method from FsClient

alex-titarenko · alex-titarenko · commit 21213b7d1f2e · 2022-10-10T18:22:32.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "git-essentials",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "description": "A collection of essential Git commands for your browser and Node.js",
   "main": "dist/esm/index.js",
   "types": "index.d.ts",
diff --git a/src/api/merge.ts b/src/api/merge.ts
@@ -82,7 +82,7 @@ export type MergeResult = {
  * ## Limitations
  *
  * Currently it does not support incomplete merges. That is, if there are merge conflicts it cannot solve
- * with the built in diff3 algorithm it will not modify the working dir, and will throw a {@link MergeNotSupportedError} error.
+ * with the built in diff3 algorithm it will not modify the working dir, and will throw a {@link Errors.MergeNotSupportedError} error.
  *
  * Currently it will fail if multiple candidate merge bases are found. (It doesn't yet implement the recursive merge strategy.)
  *
diff --git a/src/clients/fs/InMemoryFsClient.ts b/src/clients/fs/InMemoryFsClient.ts
@@ -33,7 +33,7 @@ type Stats = {
 }
 
 class StatsImpl implements StatsLike {
-  type: 'file' | 'dir' | 'symlink'
+  private type: 'file' | 'dir' | 'symlink'
   mode: number
   size: number
   ino: number
@@ -188,20 +188,6 @@ export class InMemoryFsClient implements FsClient {
     }
   }
 
-  public async unlink(path: string): Promise<void> {
-    const { folder, entry, entryName } = this.parsePath(path)
-
-    if (!entry) {
-      throw new ENOENT(path)
-    }
-
-    if (entry.type === 'dir') {
-      throw new ENOENT(path)
-    }
-
-    folder.children = folder.children.filter(x => x.name !== entryName)
-  }
-
   public async readdir(path: string): Promise<string[]> {
     const { entry } = this.parsePath(path)
 
diff --git a/src/commands/checkout.ts b/src/commands/checkout.ts
@@ -181,7 +181,7 @@ export async function _checkout({
             if (method === 'rmdir-index') {
               index.delete({ filepath: fullpath })
             }
-            await fs.rmdir(filepath)
+            await fs.rm(filepath)
             if (onProgress) {
               await onProgress({
                 phase: 'Updating workdir',
diff --git a/src/commands/clone.ts b/src/commands/clone.ts
@@ -110,7 +110,7 @@ export async function _clone({
   } catch (err: any) {
     if (!(err instanceof AlreadyExistsError)) {
       // Remove partial local repository
-      await fs.rmdir(gitdir, { recursive: true }).catch(() => undefined)
+      await fs.rm(gitdir, { recursive: true }).catch(() => undefined)
     }
 
     throw err
diff --git a/src/errors/AlreadyExistsError.ts b/src/errors/AlreadyExistsError.ts
@@ -8,9 +8,6 @@ export type AlreadyExistsErrorData = {
   canForce: boolean
 }
 
-/**
- * @group Errors
- */
 export class AlreadyExistsError extends BaseError<AlreadyExistsErrorData> {
   public static readonly code = 'AlreadyExistsError'
 
diff --git a/src/errors/BaseError.ts b/src/errors/BaseError.ts
@@ -6,9 +6,6 @@ export type ErrorDto<T> = {
   stack?: string
 }
 
-/**
- * @group Errors
- */
 export class BaseError<T> extends Error {
   caller: string
 
diff --git a/src/errors/CheckoutConflictError.ts b/src/errors/CheckoutConflictError.ts
@@ -4,9 +4,6 @@ export type CheckoutConflictErrorData = {
   filepaths: string[]
 }
 
-/**
- * @group Errors
- */
 export class CheckoutConflictError extends BaseError<CheckoutConflictErrorData> {
   public static readonly code = 'CheckoutConflictError'
 
diff --git a/src/errors/CommitNotFetchedError.ts b/src/errors/CommitNotFetchedError.ts
@@ -5,9 +5,6 @@ export type CommitNotFetchedErrorData = {
   oid: string
 }
 
-/**
- * @group Errors
- */
 export class CommitNotFetchedError extends BaseError<CommitNotFetchedErrorData> {
   public static readonly code = 'CommitNotFetchedError'
 
diff --git a/src/errors/EmptyServerResponseError.ts b/src/errors/EmptyServerResponseError.ts
@@ -1,8 +1,5 @@
 import { BaseError } from './BaseError'
 
-/**
- * @group Errors
- */
 export class EmptyServerResponseError extends BaseError<void> {
   public static readonly code = 'EmptyServerResponseError'
 
diff --git a/src/errors/FastForwardError.ts b/src/errors/FastForwardError.ts
@@ -1,8 +1,5 @@
 import { BaseError } from './BaseError'
 
-/**
- * @group Errors
- */
 export class FastForwardError extends BaseError<void> {
   public static readonly code = 'FastForwardError'
 
diff --git a/src/errors/GitPushError.ts b/src/errors/GitPushError.ts
@@ -7,9 +7,6 @@ export type GitPushErrorData = {
   result: PushResult
 }
 
-/**
- * @group Errors
- */
 export class GitPushError extends BaseError<GitPushErrorData> {
   public static readonly code = 'GitPushError'
 
diff --git a/src/errors/HttpError.ts b/src/errors/HttpError.ts
@@ -6,9 +6,6 @@ export type HttpErrorData = {
   response?: string
 }
 
-/**
- * @group Errors
- */
 export class HttpError extends BaseError<HttpErrorData> {
   public static readonly code = 'HttpError'
 
diff --git a/src/errors/InternalError.ts b/src/errors/InternalError.ts
@@ -4,9 +4,6 @@ export type InternalErrorData = {
   message: string
 }
 
-/**
- * @group Errors
- */
 export class InternalError extends BaseError<InternalErrorData> {
   public static readonly code = 'InternalError'
 
diff --git a/src/errors/InvalidFilepathError.ts b/src/errors/InvalidFilepathError.ts
@@ -6,9 +6,6 @@ export type InvalidFilepathErrorData = {
   reason: InvalidFilepathReason
 }
 
-/**
- * @group Errors
- */
 export class InvalidFilepathError extends BaseError<InvalidFilepathErrorData> {
   public static readonly code = 'InvalidFilepathError'
 
diff --git a/src/errors/InvalidOidError.ts b/src/errors/InvalidOidError.ts
@@ -4,9 +4,6 @@ export type InvalidOidErrorData = {
   value: string
 }
 
-/**
- * @group Errors
- */
 export class InvalidOidError extends BaseError<InvalidOidErrorData> {
   public static readonly code = 'InvalidOidError'
 
diff --git a/src/errors/InvalidRefNameError.ts b/src/errors/InvalidRefNameError.ts
@@ -5,9 +5,6 @@ export type InvalidRefNameErrorData = {
   suggestion: string
 }
 
-/**
- * @group Errors
- */
 export class InvalidRefNameError extends BaseError<InvalidRefNameErrorData> {
   public static readonly code = 'InvalidRefNameError'
 
diff --git a/src/errors/MaxDepthError.ts b/src/errors/MaxDepthError.ts
@@ -4,9 +4,6 @@ export type MaxDepthErrorData = {
   depth: number
 }
 
-/**
- * @group Errors
- */
 export class MaxDepthError extends BaseError<MaxDepthErrorData> {
   public static readonly code = 'MaxDepthError'
 
diff --git a/src/errors/MergeNotSupportedError.ts b/src/errors/MergeNotSupportedError.ts
@@ -1,9 +1,6 @@
 import { BaseError } from './BaseError'
 
 
-/**
- * @group Errors
- */
 export class MergeNotSupportedError extends BaseError<void> {
   public static readonly code = 'MergeNotSupportedError'
 
diff --git a/src/errors/MissingNameError.ts b/src/errors/MissingNameError.ts
@@ -6,9 +6,6 @@ export type MissingNameErrorData = {
   role: MissingNameRole
 }
 
-/**
- * @group Errors
- */
 export class MissingNameError extends BaseError<MissingNameErrorData> {
   public static readonly code = 'MissingNameError'
 
diff --git a/src/errors/MissingParameterError.ts b/src/errors/MissingParameterError.ts
@@ -4,9 +4,6 @@ export type MissingParameterErrorData = {
   parameter: string
 }
 
-/**
- * @group Errors
- */
 export class MissingParameterError extends BaseError<MissingParameterErrorData> {
   static readonly code = 'MissingParameterError'
 
diff --git a/src/errors/NoRefspecError.ts b/src/errors/NoRefspecError.ts
@@ -4,9 +4,6 @@ export type NoRefspecErrorData = {
   remote: string
 }
 
-/**
- * @group Errors
- */
 export class NoRefspecError extends BaseError<NoRefspecErrorData> {
   public static readonly code = 'NoRefspecError'
 
diff --git a/src/errors/NotFoundError.ts b/src/errors/NotFoundError.ts
@@ -4,9 +4,6 @@ export type NotFoundErrorData = {
   what: string
 }
 
-/**
- * @group Errors
- */
 export class NotFoundError extends BaseError<NotFoundErrorData> {
   static readonly code = 'NotFoundError'
 
diff --git a/src/errors/ObjectTypeError.ts b/src/errors/ObjectTypeError.ts
@@ -9,9 +9,6 @@ export type ObjectTypeErrorData = {
   filepath?: string
 }
 
-/**
- * @group Errors
- */
 export class ObjectTypeError extends BaseError<ObjectTypeErrorData> {
   public static readonly code = 'ObjectTypeError'
 
diff --git a/src/errors/ParseError.ts b/src/errors/ParseError.ts
@@ -5,9 +5,6 @@ export type ParseErrorData = {
   actual: string
 }
 
-/**
- * @group Errors
- */
 export class ParseError extends BaseError<ParseErrorData> {
   public static readonly code = 'ParseError'
 
diff --git a/src/errors/PushRejectedError.ts b/src/errors/PushRejectedError.ts
@@ -6,9 +6,6 @@ export type PushRejectedErrorData = {
   reason: PushRejectionReason
 }
 
-/**
- * @group Errors
- */
 export class PushRejectedError extends BaseError<PushRejectedErrorData> {
   public static readonly code = 'PushRejectedError'
 
diff --git a/src/errors/RemoteCapabilityError.ts b/src/errors/RemoteCapabilityError.ts
@@ -8,9 +8,6 @@ export type RemoteCapabilityErrorData = {
   parameter: RemoteParameter
 }
 
-/**
- * @group Errors
- */
 export class RemoteCapabilityError extends BaseError<RemoteCapabilityErrorData> {
   public static readonly code = 'RemoteCapabilityError'
 
diff --git a/src/errors/SmartHttpError.ts b/src/errors/SmartHttpError.ts
@@ -5,9 +5,6 @@ export type SmartHttpErrorData = {
   response?: string
 }
 
-/**
- * @group Errors
- */
 export class SmartHttpError extends BaseError<SmartHttpErrorData> {
   public static readonly code = 'SmartHttpError'
 
diff --git a/src/errors/UnknownTransportError.ts b/src/errors/UnknownTransportError.ts
@@ -6,9 +6,6 @@ export type UnknownTransportErrorData = {
   suggestion?: string
 }
 
-/**
- * @group Errors
- */
 export class UnknownTransportError extends BaseError<UnknownTransportErrorData> {
   public static readonly code = 'UnknownTransportError'
 
diff --git a/src/errors/UnsafeFilepathError.ts b/src/errors/UnsafeFilepathError.ts
@@ -4,9 +4,6 @@ export type UnsafeFilepathErrorData = {
   filepath: string
 }
 
-/**
- * @group Errors
- */
 export class UnsafeFilepathError extends BaseError<UnsafeFilepathErrorData> {
   public static readonly code = 'UnsafeFilepathError'
 
diff --git a/src/errors/UrlParseError.ts b/src/errors/UrlParseError.ts
@@ -4,9 +4,6 @@ export type UrlParseErrorData = {
   url: string
 }
 
-/**
- * @group Errors
- */
 export class UrlParseError extends BaseError<UrlParseErrorData> {
   public static readonly code = 'UrlParseError'
 
diff --git a/src/errors/UserCanceledError.ts b/src/errors/UserCanceledError.ts
@@ -1,8 +1,5 @@
 import { BaseError } from './BaseError'
 
-/**
- * @group Errors
- */
 export class UserCanceledError extends BaseError<void> {
   public static readonly code = 'UserCanceledError'
 
diff --git a/src/errors/index.ts b/src/errors/index.ts
@@ -1,3 +1,7 @@
+/**
+ * @module Errors
+ */
+
 export * from './BaseError'
 export * from './AlreadyExistsError'
 export * from './CheckoutConflictError'
diff --git a/src/index.ts b/src/index.ts
@@ -3,7 +3,6 @@
  */
 
 export * from './models'
-export * from './errors'
 
 export * from './api/add'
 export * from './api/addRemote'
diff --git a/src/models/Auth.ts b/src/models/Auth.ts
@@ -11,7 +11,7 @@ export type Auth = {
   /** An object where you can provide your custom authentication header. */
   headers?: HttpHeaders
 
-  /** Tells git to throw a {@link UserCanceledError} (instead of an {@link HttpError}). */
+  /** Tells git to throw a {@link Errors.UserCanceledError} (instead of an {@link Errors.HttpError}). */
   cancel?: boolean
 }
 
diff --git a/src/models/BlobMergeCallback.ts b/src/models/BlobMergeCallback.ts
@@ -64,12 +64,12 @@ export type BlobMergeCallbackResult =
  * Please note that those examples are very basic implementations.
  * The actual one could be much more complicated and could include following the logic:
  * * Detect if the blob has binary or text content:
- *    * If binary: decide which one to return or throw {@link MergeNotSupportedError}.
+ *    * If binary: decide which one to return or throw {@link Errors.MergeNotSupportedError}.
  *    * If text: apply [diff3](https://www.npmjs.com/package/diff3) merge algorithm to return merged text.
  * * Decide what to do if there is no base blob.
  * * Decide what to do if one of the blobs were deleted.
  *
- * @throws {@link MergeNotSupportedError} when merge is not clean.
+ * @throws {@link Errors.MergeNotSupportedError} when merge is not clean.
  * @group Callbacks
  */
 export type BlobMergeCallback = (args: BlobMergeCallbackParams) => Promise<BlobMergeCallbackResult>
diff --git a/src/models/FileSystem.ts b/src/models/FileSystem.ts
diff --git a/src/models/FsClient.ts b/src/models/FsClient.ts
diff --git a/tests/add.test.ts b/tests/add.test.ts
diff --git a/typedoc.json b/typedoc.json

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "git-essentials",`
`3`		`- "version": "0.6.2",`
	`3`	`+ "version": "0.6.3",`
`4`	`4`	`"description": "A collection of essential Git commands for your browser and Node.js",`
`5`	`5`	`"main": "dist/esm/index.js",`
`6`	`6`	`"types": "index.d.ts",`
Original file line number	Diff line number	Diff line change
`@@ -82,7 +82,7 @@ export type MergeResult = {`
`82`	`82`	`* ## Limitations`
`83`	`83`	`*`
`84`	`84`	`* Currently it does not support incomplete merges. That is, if there are merge conflicts it cannot solve`
`85`		`- * with the built in diff3 algorithm it will not modify the working dir, and will throw a {@link MergeNotSupportedError} error.`
	`85`	`+ * with the built in diff3 algorithm it will not modify the working dir, and will throw a {@link Errors.MergeNotSupportedError} error.`
`86`	`86`	`*`
`87`	`87`	`* Currently it will fail if multiple candidate merge bases are found. (It doesn't yet implement the recursive merge strategy.)`
`88`	`88`	`*`
Original file line number	Diff line number	Diff line change
`@@ -181,7 +181,7 @@ export async function _checkout({`
`181`	`181`	`if (method === 'rmdir-index') {`
`182`	`182`	`index.delete({ filepath: fullpath })`
`183`	`183`	`}`
`184`		`- await fs.rmdir(filepath)`
	`184`	`+ await fs.rm(filepath)`
`185`	`185`	`if (onProgress) {`
`186`	`186`	`await onProgress({`
`187`	`187`	`phase: 'Updating workdir',`
Original file line number	Diff line number	Diff line change
`@@ -110,7 +110,7 @@ export async function _clone({`
`110`	`110`	`} catch (err: any) {`
`111`	`111`	`if (!(err instanceof AlreadyExistsError)) {`
`112`	`112`	`// Remove partial local repository`
`113`		`- await fs.rmdir(gitdir, { recursive: true }).catch(() => undefined)`
	`113`	`+ await fs.rm(gitdir, { recursive: true }).catch(() => undefined)`
`114`	`114`	`}`
`115`	`115`
`116`	`116`	`throw err`
Original file line number	Diff line number	Diff line change
`@@ -8,9 +8,6 @@ export type AlreadyExistsErrorData = {`
`8`	`8`	`canForce: boolean`
`9`	`9`	`}`
`10`	`10`
`11`		`-/**`
`12`		`- * @group Errors`
`13`		`- */`
`14`	`11`	`export class AlreadyExistsError extends BaseError<AlreadyExistsErrorData> {`
`15`	`12`	`public static readonly code = 'AlreadyExistsError'`
`16`	`13`
Original file line number	Diff line number	Diff line change
`@@ -6,9 +6,6 @@ export type ErrorDto<T> = {`
`6`	`6`	`stack?: string`
`7`	`7`	`}`
`8`	`8`
`9`		`-/**`
`10`		`- * @group Errors`
`11`		`- */`
`12`	`9`	`export class BaseError<T> extends Error {`
`13`	`10`	`caller: string`
`14`	`11`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,6 @@ export type CheckoutConflictErrorData = {`
`4`	`4`	`filepaths: string[]`
`5`	`5`	`}`
`6`	`6`
`7`		`-/**`
`8`		`- * @group Errors`
`9`		`- */`
`10`	`7`	`export class CheckoutConflictError extends BaseError<CheckoutConflictErrorData> {`
`11`	`8`	`public static readonly code = 'CheckoutConflictError'`
`12`	`9`
Original file line number	Diff line number	Diff line change
`@@ -5,9 +5,6 @@ export type CommitNotFetchedErrorData = {`
`5`	`5`	`oid: string`
`6`	`6`	`}`
`7`	`7`
`8`		`-/**`
`9`		`- * @group Errors`
`10`		`- */`
`11`	`8`	`export class CommitNotFetchedError extends BaseError<CommitNotFetchedErrorData> {`
`12`	`9`	`public static readonly code = 'CommitNotFetchedError'`
`13`	`10`