Class RegraConvencaoNomenclatura

Regra que enforça convenções de nomenclatura.

Exemplos:

Variáveis em caixaCamelo: var meuNome (não var MeuNome ou var meu_nome)
Constantes em CAIXA_ALTA: constante PI_VALOR (não constante piValor)
Funções em caixaCamelo: função calcularTotal() (não função CalcularTotal())

Implements

RegraEstilizacao

Index

Constructors

Properties

Methods

aplicarEmDeclaracao validarNome

Constructors

constructor

new RegraConvencaoNomenclatura(
opcoes?: OpcoesConvencaoNomenclatura,
): RegraConvencaoNomenclatura
Parameters
- opcoes: OpcoesConvencaoNomenclatura = {}
Returns RegraConvencaoNomenclatura
- Defined in fontes/estilizador/regras/convencao-nomenclatura.ts:47

Properties

descricao

descricao: string = 'Enforça convenções de nomenclatura para variáveis, constantes e funções'

Descrição do que a regra faz.

nome

nome: string = 'convencao-nomenclatura'

Nome da regra para identificação e logs.

Methods

aplicarEmDeclaracao

aplicarEmDeclaracao(declaracao: Declaracao): Declaracao
Aplica a regra em uma declaração.
Parameters
- declaracao: Declaracao
  A declaração a ser verificada/transformada.
Returns Declaracao
A declaração (modificada ou não).
Implementation of RegraEstilizacao.aplicarEmDeclaracao
- Defined in fontes/estilizador/regras/convencao-nomenclatura.ts:55

validarNome

validarNome(nome: string, convencao: string): boolean
Valida se um nome está na convenção especificada.
Parameters
- nome: string
- convencao: string
Returns boolean
- Defined in fontes/estilizador/regras/convencao-nomenclatura.ts:199