new Git( [opt_options])
Classe que permite a execução de comandos do Git.
Parameters:
Name | Type | Argument | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
opt_options |
Object |
<optional> |
Opções do uso do Git. Properties
|
Members
-
path :string
-
Caminho para o binário do Git. O valor padrão utiliza o arquivo existente no path global.
Type:
- string
Methods
-
clone(repositoryURL, localPath)
-
Clona o repositório informado em repositoryURL no diretório informado em localPath.
Parameters:
Name Type Description repositoryURL
string URL do repositório que deverá ser clonado.
localPath
string Diretório local onde o repositório deverá ser clonado. O caminho informado não pode existir.
-
getVersion()
-
Retorna a versão do JSDoc.
Returns:
- Type
- string
-
init(localPath)
-
Inicializa um repositório Git vazio no diretório informado.
Parameters:
Name Type Description localPath
-
isARepository(localPath)
-
Indica se o caminho local indicado é um repositório Git.
Parameters:
Name Type Description localPath
string Caminho a ser verificado.
Returns:
True se for um repositório Git.
- Type
- boolean
-
isAvailable()
-
Indica se o caminho #path aponta corretamente para uma instalação do JSDoc3.
Returns:
- Type
- boolean
-
run(params, workDir, opt_timeout)
-
Executa o Git com os parâmetros informados.
Parameters:
Name Type Argument Description params
string Comando e parâmetros do Git a serem executados.
workDir
string Diretório no qual o comando git será executado.
opt_timeout
number <nullable>
Tempo máximo em milissegundos que será aguardado o retorno do Git. Caso não seja informado, será aguardado 5 minutos.
Returns:
Resultado da execução do comando Git.
- Type
- string