Scripts de verificação de linter avançados

Os scripts de verificação do linter ajudam você a escrever verificações que procuram problemas em scripts. Quando uma verificação de linter é executada em um registro, ela fornece uma árvore de sintaxe abstrata para seu código. Você pode usar esta árvore de sintaxe abstrata para analisar problemas com o código, como muitas declarações if aninhadas ou usos de API lenta em um loop de tempo.

Uso de verificação de linter

As verificações de linter têm um objeto exclusivo para usar chamado rootNode. Este é o nó raiz da árvore de sintaxe abstrata (AST) analisada para o script do registro atual. Este objeto tem muitas funções, mas a função de visita é a mais importante. A função de visita usa uma função de retorno de chamada como um parâmetro que é chamado em cada nó da árvore. A função de retorno de chamada usa um nó como parâmetro que representa o nó atual durante sua iteração. Você pode retornar falso da função de retorno de chamada para parar de iterar a árvore mais cedo, caso contrário, ele continuará visitando todos os subnós na árvore do nó que você chamou de visita.

Por exemplo, se você quiser verificar uma API obsoleta chamada mauFunção(). Você pode escrever uma verificação de linter com um script no exemplo a seguir:

(function(engine) {
	engine.rootNode.visit(function(node) {
		if (node.getTypeName() === "NAME" &&
				node.getNameIdentifier() === "badFunction" &&
				node.getParent().getTypeName() === "CALL") {
			engine.finding.incrementWithNode(node);
		}
	});
})(engine);

Quando você executa uma verificação com esta Verificação de linter, ela verifica todos os registros na verificação com um campo de script. Por exemplo, se um registro nessa verificação tiver um script semelhante ao seguinte, a verificação selecionará uma descoberta para este registro.

/*
badFunction()
*/
// badFunction()
function badFunction() {
	return;
}
var GoodClass = Class.create();
GoodClass.prototype = Object.extendsObject(Object, {
	badFunction: function() {
		// actually good
	}
});
var badFunction = ["badFunction", "badFunction()"];
badFunctionButSometimesGood();

badFunction();

Funções de nó

A seguir está uma lista de funções disponíveis para chamar no objeto de nó.

• getRootNode(): obtém o nó raiz da árvore para este nó
• getParent(): obtém o primário deste nó
• getLineNo(): obtém o local do número da linha deste nó
• getColumnNo(): obtém o local do número da coluna deste nó
• toSource(): obtém a origem deste nó. A origem é baseada neste nó e em seus secundários
• getTypeName(): obtém o nome do tipo de nó deste nó. Por exemplo, uma chamada de função na origem é tokenizada como um nó com o nome do tipo "CALL"
  Nota:

  Os valores de node.getTypeName() são de diferentes tipos de nós em uma árvore de sintaxe abstrata (AST). Os valores possíveis vêm do próprio analisador AST do Rhino.
• getNameIdentifier(): se o tipo de nó deste nó for "NAME", retorne o identificador, que é o valor da cadeia de caracteres do próprio nome. Um nó "NAME" representa um nome simples que não é uma palavra-chave, como um nome de função ou um nome de variável.
  Nota:

  Se este nó não for um nó NAME, o resultado será nulo.
• getAbsolutePosition(): obtém a posição absoluta deste nó. A posição absoluta é o número de caracteres desde o início do script até este nó
• compareTo(other): compara este nó com outro nó. O nó com uma posição absoluta e comprimento maiores será o maior em comparação. outro é um nó a ser comparado com este nó
• visit(callbackFunction): visite cada nó na subárvore começando por este nó e execute a função de retorno de chamada fornecida em cada nó. callbackFunction é uma função que será executada em cada nó na subárvore deste nó. Esta função de retorno de chamada usa um LinterCheckAstNode como um parâmetro que será o nó que está sendo visitado
• debugprint(): retorna uma representação de cadeia de caracteres da árvore de sintaxe abstrata, começando a partir deste nó. Cada linha contém informações sobre um nó e o recuo representa o relacionamento de hierarquia entre os nós. As informações em cada linha são organizadas da seguinte forma
  1. Posição absoluta
  2. Nome do tipo de nó
  3. Posição relativa ao primário
  4. Comprimento
  5. Identificador de nome (se for um nó NAME)

Para obter mais informações, consulte API LinterCheckAstNode - Scoped, Global.