Pular para o conteúdo principal

Formatação Automática de Código no Cursor

dica

O Cursor oferece poderosos recursos de formatação de código que ajudam a manter um estilo de código consistente em seus projetos.

Configurando Formatadores​

Formatador Integrado​

O Cursor vem com um formatador integrado que suporta múltiplas linguagens. Para usá-lo:

  1. Abra a Paleta de Comandos (Ctrl/Cmd + Shift + P)
  2. Digite "Format Document"
  3. Pressione Enter

Formatadores Populares​

# Instalar Prettier
npm install --save-dev prettier

# Criar arquivo de configuração
echo {} > .prettierrc.json

Arquivos de Configuração​

Configuração do Prettier​

.prettierrc.json
{
  "semi": true,
  "trailingComma": "es5",
  "singleQuote": true,
  "printWidth": 80,
  "tabWidth": 2,
  "useTabs": false,
  "bracketSpacing": true,
  "arrowParens": "avoid"
}

Configuração do ESLint​

.eslintrc.json
{
  "env": {
    "browser": true,
    "es2021": true
  },
  "extends": [
    "eslint:recommended",
    "prettier"
  ],
  "rules": {
    "indent": ["error", 2],
    "linebreak-style": ["error", "unix"],
    "quotes": ["error", "single"],
    "semi": ["error", "always"]
  }
}

Formatação ao Salvar​

Habilitar Formatação Automática​

.vscode/settings.json
{
  "editor.formatOnSave": true,
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  },
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

Configurações Específicas de Linguagem​

{
  "[python]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "ms-python.python"
  },
  "[java]": {
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "redhat.java"
  }
}

Atalhos de Teclado​

Atalhos de formatação padrão:

AçãoWindows/LinuxmacOS
Formatar DocumentoShift + Alt + FShift + Option + F
Formatar SeleçãoCtrl + K Ctrl + FCmd + K Cmd + F

Configuração Avançada​

Ignorar Arquivos​

.prettierignore
# Saída de build
dist/
build/

# Dependências
node_modules/

# Arquivos gerados
*.generated.*

Integração com ESLint​

.eslintrc.json
{
  "extends": [
    "eslint:recommended",
    "plugin:prettier/recommended"
  ],
  "plugins": ["prettier"],
  "rules": {
    "prettier/prettier": "error"
  }
}

Regras de Formatação Personalizadas​

Aplicação de Guias de Estilo​

.prettierrc.json
{
  "overrides": [
    {
      "files": "*.component.ts",
      "options": {
        "printWidth": 120,
        "singleQuote": true
      }
    },
    {
      "files": "*.spec.ts",
      "options": {
        "printWidth": 80,
        "semi": true
      }
    }
  ]
}

Regras Específicas do Projeto​

.editorconfig
root = true

[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8
indent_style = space
indent_size = 2

[*.{js,ts}]
quote_type = single

[*.py]
indent_size = 4

Solução de Problemas​

Problemas Comuns​

  1. Formatação Não Funciona

    • Verificar instalação do formatador
    • Verificar arquivos de configuração
    • Garantir que o arquivo não está sendo ignorado

  2. Conflitos Entre Ferramentas

    .vscode/settings.json
    {
      "editor.formatOnSave": true,
      "editor.codeActionsOnSave": {
        "source.fixAll.eslint": true
      },
      "eslint.format.enable": false
    }

  3. Problemas de Desempenho

    {
      "editor.formatOnSaveTimeout": 5000,
      "editor.formatOnPaste": false
    }

Melhores Práticas​

1. Controle de Versão​

.gitignore
# Não ignorar configurações de formatação
!.prettierrc
!.eslintrc
!.editorconfig

# Ignorar arquivos de cache
.prettier-cache
.eslintcache

2. Consistência da Equipe​

.prettierrc.json
{
  "semi": true,
  "singleQuote": true,
  "trailingComma": "es5",
  "printWidth": 100,
  "tabWidth": 2
}

3. Integração CI/CD​

.github/workflows/format.yml
name: Verificar Formatação de Código
on: [push, pull_request]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Instalar Prettier
        run: npm install --global prettier
      - name: Verificar formatação
        run: prettier --check "**/*.{js,ts,jsx,tsx,json,css,md}"

Configuração Específica de Linguagem​

JavaScript/TypeScript​

.prettierrc.json
{
  "semi": true,
  "singleQuote": true,
  "trailingComma": "es5",
  "bracketSpacing": true,
  "arrowParens": "avoid"
}

Python​

pyproject.toml
[tool.black]
line-length = 88
target-version = ['py38']
include = '\.pyi?$'
exclude = '''
/(
    \.git
  | \.hg
  | \.mypy_cache
  | \.tox
  | \.venv
  | _build
  | buck-out
  | build
  | dist
)/
'''

Java​

pom.xml
<plugin>
  <groupId>com.diffplug.spotless</groupId>
  <artifactId>spotless-maven-plugin</artifactId>
  <version>2.22.1</version>
  <configuration>
    <java>
      <googleJavaFormat>
        <version>1.15.0</version>
        <style>GOOGLE</style>
      </googleJavaFormat>
    </java>
  </configuration>
</plugin>

Técnicas Avançadas​

Hooks Pre-commit​

package.json
{
  "scripts": {
    "format": "prettier --write \"**/*.{js,ts,jsx,tsx,json,css,md}\"",
    "lint": "eslint --fix \"**/*.{js,ts,jsx,tsx}\""
  },
  "husky": {
    "hooks": {
      "pre-commit": "lint-staged"
    }
  },
  "lint-staged": {
    "*.{js,ts,jsx,tsx}": [
      "eslint --fix",
      "prettier --write"
    ],
    "*.{json,css,md}": [
      "prettier --write"
    ]
  }
}

Plugins Personalizados​

.prettierrc.js
module.exports = {
  plugins: [
    require('prettier-plugin-tailwindcss'),
    require('prettier-plugin-organize-imports')
  ],
  semi: true,
  singleQuote: true,
  organizeImportsSkipDestructiveCodeActions: true
};

Compartilhamento de Regras de Formatação​

package.json
{
  "name": "company-formatting-config",
  "version": "1.0.0",
  "prettier": {
    "semi": true,
    "singleQuote": true,
    "trailingComma": "es5"
  },
  "eslintConfig": {
    "extends": [
      "eslint:recommended",
      "plugin:prettier/recommended"
    ]
  }
}

Recursos Relacionados​