Aller au contenu principal

Formatage automatique du code dans Cursor

astuce

Cursor offre de puissantes fonctionnalités de formatage de code qui aident à maintenir un style de code cohérent dans vos projets.

Configuration des formateurs​

Formateur intégré​

Cursor est livré avec un formateur intégré qui prend en charge plusieurs langages. Pour l'utiliser :

  1. Ouvrez la palette de commandes (Ctrl/Cmd + Maj + P)
  2. Tapez "Format Document"
  3. Appuyez sur Entrée

Formateurs populaires​

# Installer Prettier
npm install --save-dev prettier

# Créer un fichier de configuration
echo {} > .prettierrc.json

Fichiers de configuration​

Configuration Prettier​

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

Configuration 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"]
  }
}

Formatage à l'enregistrement​

Activer le formatage automatique​

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

Paramètres spécifiques au langage​

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

Raccourcis clavier​

Raccourcis de formatage par défaut :

ActionWindows/LinuxmacOS
Formater le documentMaj + Alt + FMaj + Option + F
Formater la sélectionCtrl + K Ctrl + FCmd + K Cmd + F

Configuration avancée​

Ignorer des fichiers​

.prettierignore
# Sortie de build
dist/
build/

# Dépendances
node_modules/

# Fichiers générés
*.generated.*

Intégration ESLint​

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

Règles de formatage personnalisées​

Application des guides de style​

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

Règles spécifiques au projet​

.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

Dépannage​

Problèmes courants​

  1. Le formatage ne fonctionne pas

    • Vérifier l'installation du formateur
    • Vérifier les fichiers de configuration
    • S'assurer que le fichier n'est pas ignoré

  2. Conflits entre outils

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

  3. Problèmes de performance

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

Bonnes pratiques​

1. Contrôle de version​

.gitignore
# Ne pas ignorer les configurations de formatage
!.prettierrc
!.eslintrc
!.editorconfig

# Ignorer les fichiers de cache
.prettier-cache
.eslintcache

2. Cohérence d'équipe​

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

3. Intégration CI/CD​

.github/workflows/format.yml
name: Vérification du formatage de code
on: [push, pull_request]

jobs:
  format:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Installer Prettier
        run: npm install --global prettier
      - name: Vérifier le formatage
        run: prettier --check "**/*.{js,ts,jsx,tsx,json,css,md}"

Configuration spécifique au langage​

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>

Techniques avancées​

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 personnalisés​

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

Partage des règles de formatage​

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

Ressources connexes​