Class DotGit

Represents the real location of the Git data directory.

  • In standalone repos this is .git/
  • If the contracts workspace repository is a submodule, .git will be a file containing e.g. "gitdir: ../.git/modules/something"

Hierarchy (view full)

Constructors

constructor

Properties

absolute isSubmodule log present rootRepoRE separator

Accessors

[toStringTag] dirname name rootRepo short submoduleDir url

Methods

basename entrypoint make relativeFrom relativeTo resolve

Constructors

constructor

  • new DotGit(base, ...fragments): DotGit

  • Parameters

    • base: string | URL
    • Rest ...fragments: string[]

    Returns DotGit

Properties

absolute

absolute: string

The resolved absolute filesystem path represented by this object.

Readonly isSubmodule

isSubmodule: boolean

Whether the workspace's repository is a submodule and its .git is a pointer to the parent's .git/modules

log

log: Core.Console

Readonly present

present: boolean

Whether a .git is present

Static rootRepoRE

rootRepoRE: RegExp

Static separator

separator: "\\" | "/" = sep

Accessors

[toStringTag]

  • get [toStringTag](): string

  • Returns string

dirname

  • get dirname(): string

  • Returns string

    absolute path to parent directory.

name

  • get name(): string

  • Returns string

    name of this file or directory.

rootRepo

  • get rootRepo(): Path

  • Returns Path

short

  • get short(): string

  • Returns string

submoduleDir

  • get submoduleDir(): string

  • Returns string

url

  • get url(): URL

  • Returns URL

    this.absolute represented as a file:/// URL

Methods

basename

  • basename(ext?): string

  • Parameters

    • Optional ext: string

    Returns string

    name of this file or directory.

entrypoint

  • entrypoint<T>(command): T

  • Type Parameters

    • T

    Parameters

    • command: ((argv) => T)
        • (argv): T

        • Parameters

          • argv: string[]

          Returns T

    Returns T

make

  • make(): this

  • Returns this

relativeFrom

  • relativeFrom(base?): string

  • Parameters

    • base: string = ...

    Returns string

relativeTo

  • relativeTo(target?): string

  • Parameters

    • target: string = ...

    Returns string

resolve

  • resolve(...fragments): string

  • Parameters

    • Rest ...fragments: string[]

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc