Class: MergeTool

@nginstack/devops/lib/merge/MergeTool~ MergeTool


new MergeTool()

Classe base das ferramentas que exibem as diferenças entre dois conteúdos de texto e permitem mesclá-los. A ferramenta pode ser o visualizador padrão, exibido no navegador do usuário, ou uma aplicação externa instalada na máquina do Engine, como o WinMerge e o Meld.

As aplicações externas suportadas são implementadas pelas classes module:@nginstack/devops/lib/merge/WinMerge e module:@nginstack/devops/lib/merge/Meld.

Example
const WinMerge = require('@nginstack/devops/lib/merge/WinMerge.js');
const tool = new WinMerge();
tool.mergeContents(sourceContent, targetContent).then(function (merged) {
  // merged é null caso o usuário cancele o merge
});

Members


name :string

Nome da ferramenta de merge, utilizado em mensagens para o usuário.

Type:
  • string

waitingMessage :string

Mensagem que deve ser exibida enquanto o processo aguarda a ferramenta. Fica vazia quando a própria ferramenta já indica a espera.

Type:
  • string

Methods


compareContents(source, target [, options])

Exibe as diferenças entre os conteúdos, sem permitir a sua alteração.

Parameters:
Name Type Argument Description
source string

Conteúdo de origem, exibido à esquerda.

target string

Conteúdo de destino, exibido à direita.

options module:@nginstack/web-framework/lib/dialogs/MergeDialog~MergeDialogOptions <optional>

Opções da comparação.

Returns:

Promise resolvido quando o usuário encerrar a comparação.

Type
module:@nginstack/web-framework/lib/promise/Promise~Promise

mergeContents(source, target [, options])

Permite ao usuário mesclar os conteúdos, alterando o conteúdo de destino.

Parameters:
Name Type Argument Description
source string

Conteúdo de origem, exibido à esquerda.

target string

Conteúdo de destino, exibido à direita, que pode ser alterado.

options module:@nginstack/web-framework/lib/dialogs/MergeDialog~MergeDialogOptions <optional>

Opções do merge.

Returns:

Promise para o conteúdo final do destino, ou para null caso o usuário cancele o merge.

Type
module:@nginstack/web-framework/lib/promise/Promise~Promise

<static> findApplication()

Localiza o aplicativo WinMerge nos caminhos de instalação normalmente utilizados.

Deprecated:
  • Utilize module:@nginstack/devops/lib/merge/WinMerge.findApplication ou module:@nginstack/devops/lib/merge/Meld.findApplication.
Returns:

Retorna o caminho caso encontre, caso contrário retornará null.

Type
string| null