@totvs/prettier-plugin-4gl

Extensão Prettier para formatação de código 4GL.

Usage no npm install needed!

<script type="module">
  import totvsPrettierPlugin4gl from 'https://cdn.skypack.dev/@totvs/prettier-plugin-4gl';
</script>

README

Prettier 4GL Plugin

All Contributors

Instalação

Primero, efetuar a instalação do Prettier e em seguida esta extensão.

Para uso local:

npm install prettier-plugin-4gl --save-dev

Para uso global:

npm install prettier-plugin-4gl -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

4GL

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

Chave Uso
--4gl-align-fields Alinhar identificação de campos em comandos DEFINE/RECORD. Padrão: false
--4gl-align-comment Coluna de alinhamento de comentário de fim de linha. Padrão: 0 (desligado)
--4gl-braces Espaçamento entre chaves. Padrão: false
--4gl-bracket Espaçamento entre colchetes. Padrão: false
--4gl-comma Espaçamento após virgulas de separção. Padrão: false
--4gl-format-number Formata números, p.e. 1234 é formatado para 1,234.
--4gl-keywords-case <upper lower
--4gl-max-empty-line Máximo de linhas em branco na sequência. Padrão: 0 (sem limite)
--4gl-math-operators Espaçamento em operadores matemáticos. Padrão: false
--4gl-parenthesis Espaçamento entre parenteses. Padrão: false
--4gl-string-style <double-quotes single-quotes

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 resposável de infra-estrutura/segurança.

npm prettier --parser=4gl [options]

Integração com editores

Ver Editor Integration.

Nesse modo informe as opções usando o nome longo da opção sem o -- e as letras precedidas por '-' em maiúsculas, na sessão 4gl.formatter no arquivo settings.json.

{
  ...
  "4gl.formatter": {
    "keywordsCase": "upper",
    "stringStyle": "ignore",
    "formatNumber": false,
    "operatorSpacing": false
  }
  ...

Embarcado

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

  const options: any = { ... } //Prettier Options and Formatter 4GL Options*
  //Full source
  let result: any = prettier.format(content, {
    parser: "4gl",
    ...options,
  });

Mantenedor


TOTVS S.A.

🚧 🔌 📆

Colaboradores


Alan Cândido

💻 📖 ⚠️