README.md

Prettier AdvPL Plugin

Instalação

Efetuar a instalação do Prettier e em seguida esta extensão.

Para uso local:

npm install prettier-plugin-advpl --save-dev

Para uso global:

npm install prettier-plugin-advpl -g

Opções

Prettier

Para detalhes sobre configuração e chaves do Prettier. Abaixo, configurações do Prettier utilizados pela extensão.

Chave	Uso
--tab-width	Número de espaços por nível de indentação.
	Padrão: 2
--use-tabs	Recuar com tabulações em vez de espaços.
	Padrão: false
--insert-pragma	Insere '@format' no inicio do do arquivo.
	Padrão false
--require-pragma	Requer que '@prettier' ou '@format' esteja presente no arquivo.
	Padrão: false
-w, --write	Grava o arquivo formato. Cuidado: o arquivo original será sobrescrito.
	Padrão: false

AdvPL

Chaves específicas para formatação de fontes Advpl.

Chave	Uso

| --advpl-braces | Espaçamento entre chaves. Padrão: false | | --advpl-bracket | Espaçamento entre colchetes. Padrão: false | | --advpl-comma | Espaçamento após virgulas de separção. Padrão: false | | --advpl-keywords-case <upper | lower | ignore> | Coloca palavras-chaves em maiúsculas ou minúsculas. Padrão: upper | | --advpl-max-empty-line | Máximo de linhas em branco na sequência. Padrão: 0 (sem limite) | | --advpl-math-operators | Espaçamento em operadores matemáticos. Padrão: false | | --advpl-parenthesis | Espaçamento entre parenteses. Padrão: false | | --advpl-string-style <double-quotes | single-quotes | ignore> | Usar aspas simples ou duplas em strings. Padrão: ignore | | --advplBreakLineInSemiColon | Força nova linha ao encontrar ponto-e-virgula. Padrão: false | | --advplBreakLineInCodeBlock | Força nova linha em definições de codeblock. Padrão: false | | --advplExpandShortCommand | Expande comandos abreviados, p.e. func para function. Padrão: false |

Uso em linha de comando

Detalhes sobre o uso em CLI.

Em determinados sistemas operacionais ou devido a politicas de segurança, pode ser necessário configurações adicionais. Veja a documentação específica do seu sistema operacional ou acione o responsável de infra-estrutura/segurança.

npm prettier --parser=advpl [options]

Integração com editores

Ver Editor Integration.

Embarcado (API)

Nesse modo, informe as opções usando o nome longo das opções sem o --.

  const options: any = { ... } //Prettier Options and Formatter AdvPL Options*

let result: any = prettier.format(content, {
    parser: "advpl",
    ...options,
  });

Mantenedor

TOTVS S.A. 🚧 🔌 📆

Colaboradores

Alan Cândido 💻 📖 ⚠️