@napi-rs/simple-git - npm Package Compare versions

Comparing version 0.1.1 to 0.1.2

index.d.ts

@@ -14,2 +14,32 @@ /* tslint:disable */
 }
+/** An enumeration of the possible directions for a remote. */
+export const enum Direction {
+  /** Data will be fetched (read) from this remote. */
+  Fetch = 0,
+  /** Data will be pushed (written) to this remote. */
+  Push = 1
+}
+export interface Progress {
+  totalObjects: number
+  indexedObjects: number
+  receivedObjects: number
+  localObjects: number
+  totalDeltas: number
+  indexedDeltas: number
+  receivedBytes: number
+}
+export const enum RepositoryState {
+  Clean = 0,
+  Merge = 1,
+  Revert = 2,
+  RevertSequence = 3,
+  CherryPick = 4,
+  CherryPickSequence = 5,
+  Bisect = 6,
+  Rebase = 7,
+  RebaseInteractive = 8,
+  RebaseMerge = 9,
+  ApplyMailbox = 10,
+  ApplyMailboxOrRebase = 11
+}
 export class Reference {
@@ -82,2 +112,57 @@ /**
 }
+export class Remote {
+  /** Ensure the remote name is well-formed. */
+  static isValidName(name: string): boolean
+  /**
+   * Get the remote's name.
+   *
+   * Returns `None` if this remote has not yet been named or if the name is
+   * not valid utf-8
+   */
+  name(): string | undefined | null
+  /**
+   * Get the remote's url.
+   *
+   * Returns `None` if the url is not valid utf-8
+   */
+  url(): string | undefined | null
+  /**
+   * Get the remote's pushurl.
+   *
+   * Returns `None` if the pushurl is not valid utf-8
+   */
+  pushurl(): string | undefined | null
+  /**
+   * Get the remote's default branch.
+   *
+   * The remote (or more exactly its transport) must have connected to the
+   * remote repository. This default branch is available as soon as the
+   * connection to the remote is initiated and it remains available after
+   * disconnecting.
+   */
+  defaultBranch(): string
+  /** Open a connection to a remote. */
+  connect(dir: Direction): void
+  /** Check whether the remote is connected */
+  connected(): boolean
+  /** Disconnect from the remote */
+  disconnect(): void
+  /**
+   * Cancel the operation
+   *
+   * At certain points in its operation, the network code checks whether the
+   * operation has been cancelled and if so stops the operation.
+   */
+  stop(): void
+  fetch(refspecs: string[], cb?: (progress: Progress) => void): void
+}
+export class RemoteCallbacks {
+  constructor()
+  transferProgress(callback: (...args: any[]) => any): void
+  pushTransferProgress(callback: (a: number, b: number, c: number) => void): void
+}
+export class FetchOptions {
+  constructor()
+  remoteCallback(callback: RemoteCallbacks): void
+}
 export class Repository {
@@ -88,4 +173,50 @@ static init(p: string): Repository
   head(): Reference
+  isShallow(): boolean
+  isEmpty(): boolean
+  isWorktree(): boolean
+  /**
+   * Returns the path to the `.git` folder for normal repositories or the
+   * repository itself for bare repositories.
+   */
+  path(): string
+  /** Returns the current state of this repository */
+  state(): RepositoryState
+  /**
+   * Get the path of the working directory for this repository.
+   *
+   * If this repository is bare, then `None` is returned.
+   */
+  workdir(): string | undefined | null
+  /**
+   * Set the path to the working directory for this repository.
+   *
+   * If `update_link` is true, create/update the gitlink file in the workdir
+   * and set config "core.worktree" (if workdir is not the parent of the .git
+   * directory).
+   */
+  setWorkdir(path: string, updateGitlink: boolean): void
+  /**
+   * Get the currently active namespace for this repository.
+   *
+   * If there is no namespace, or the namespace is not a valid utf8 string,
+   * `None` is returned.
+   */
+  namespace(): string | undefined | null
+  /** Set the active namespace for this repository. */
+  setNamespace(namespace: string): void
+  /** Remove the active namespace for this repository. */
+  removeNamespace(): void
+  /**
+   * Retrieves the Git merge message.
+   * Remember to remove the message when finished.
+   */
+  message(): string
+  /** Remove the Git merge message. */
+  removeMessage(): void
+  /** List all remotes for a given repository */
+  remotes(): Array<string>
+  /** Get the information for a particular remote */
+  remote(name: string): Remote
   getFileLatestModifiedDate(filepath: string): number
   getFileLatestModifiedDateAsync(filepath: string, signal?: AbortSignal | undefined | null): Promise<unknown>
 }

index.js

@@ -239,6 +239,11 @@ const { existsSync, readFileSync } = require('fs')
 
-const { Reference, ReferenceType, Repository } = nativeBinding
+const { Reference, ReferenceType, Direction, Remote, RemoteCallbacks, FetchOptions, RepositoryState, Repository } = nativeBinding
 
 module.exports.Reference = Reference
 module.exports.ReferenceType = ReferenceType
+module.exports.Direction = Direction
+module.exports.Remote = Remote
+module.exports.RemoteCallbacks = RemoteCallbacks
+module.exports.FetchOptions = FetchOptions
+module.exports.RepositoryState = RepositoryState
 module.exports.Repository = Repository

package.json

 {
   "name": "@napi-rs/simple-git",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "main": "index.js",
@@ -17,3 +17,2 @@ "types": "./index.d.ts",
         "x86_64-unknown-linux-musl",
-        "x86_64-unknown-freebsd",
         "armv7-linux-androideabi"
@@ -33,3 +32,3 @@ ]
   "devDependencies": {
-    "@napi-rs/cli": "^2.4.5",
+    "@napi-rs/cli": "^2.5.0",
     "@types/node": "^17.0.21",
@@ -52,15 +51,14 @@ "ava": "^4.0.1",
   "optionalDependencies": {
-    "@napi-rs/simple-git-win32-x64-msvc": "0.1.1",
-    "@napi-rs/simple-git-darwin-x64": "0.1.1",
-    "@napi-rs/simple-git-linux-x64-gnu": "0.1.1",
-    "@napi-rs/simple-git-darwin-arm64": "0.1.1",
-    "@napi-rs/simple-git-android-arm64": "0.1.1",
-    "@napi-rs/simple-git-linux-arm64-gnu": "0.1.1",
-    "@napi-rs/simple-git-linux-arm64-musl": "0.1.1",
-    "@napi-rs/simple-git-win32-arm64-msvc": "0.1.1",
-    "@napi-rs/simple-git-linux-arm-gnueabihf": "0.1.1",
-    "@napi-rs/simple-git-linux-x64-musl": "0.1.1",
-    "@napi-rs/simple-git-freebsd-x64": "0.1.1",
-    "@napi-rs/simple-git-android-arm-eabi": "0.1.1"
+    "@napi-rs/simple-git-win32-x64-msvc": "0.1.2",
+    "@napi-rs/simple-git-darwin-x64": "0.1.2",
+    "@napi-rs/simple-git-linux-x64-gnu": "0.1.2",
+    "@napi-rs/simple-git-darwin-arm64": "0.1.2",
+    "@napi-rs/simple-git-android-arm64": "0.1.2",
+    "@napi-rs/simple-git-linux-arm64-gnu": "0.1.2",
+    "@napi-rs/simple-git-linux-arm64-musl": "0.1.2",
+    "@napi-rs/simple-git-win32-arm64-msvc": "0.1.2",
+    "@napi-rs/simple-git-linux-arm-gnueabihf": "0.1.2",
+    "@napi-rs/simple-git-linux-x64-musl": "0.1.2",
+    "@napi-rs/simple-git-android-arm-eabi": "0.1.2"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21088

increased by23.81%

Dependency count

11

decreased by-8.33%

Lines of code

458

increased by42.24%

No dependency changes