Prettier Docs

Prettier — Code Formatter

> Opinionated code formatter that enforces a consistent style across your entire codebase.

Version: 3.9.5 | Language: JavaScript/TypeScript | License: MIT

Quick Reference

| Topic | File | |-------|------| | About, Philosophy & Rationale (What is Prettier, Why Prettier, Prettier vs Linters, Option Philosophy, Rationale) | about.md | | Getting Started (Install, Ignoring Code, Editor Integration, Watching For Changes) | getting-started.md | | CLI, API, Browser & CI (CLI commands & flags, JavaScript API, Browser standalone, CI with GitHub Actions) | cli-api.md | | Options & Configuration (All format options, Configuration files, Sharing configurations, EditorConfig) | options-config.md | | Integrations & Plugins (Linters integration, Pre-commit hooks, Plugins API, Related projects) | integrations.md | | Technical Details & Enterprise (Printer algorithm, IR/Doc, Tidelift subscription) | technical.md |

Core Concepts

• Opinionated formatting: Prettier removes all original styling and reprints code from scratch, taking line length into account.
• AST-based: Parses code into an AST, then re-prints with its own rules. Formatting won't affect the AST.
• Supported languages: JavaScript, JSX, Angular, Vue, Flow, TypeScript, CSS/Less/SCSS, HTML, Ember/Handlebars, JSON, GraphQL, Markdown/GFM/MDX, YAML, LWC, MJML.
• Options are frozen: No new formatting options will be added. The existing set is final.
• Use Prettier for formatting, linters for bugs: Prettier handles formatting rules; linters handle code-quality rules.

Official Documentation

• What is Prettier? — Introduction
• Why Prettier? — Motivation
• Prettier vs. Linters — Comparison
• Option Philosophy — Why options are frozen
• Rationale — Design decisions
• Install — Getting started
• Ignoring Code — .prettierignore & inline comments
• Editor Integration — VS Code, Vim, Emacs, etc.
• WebStorm Setup — JetBrains IDEs
• Vim Setup — vim-prettier, Neoformat, ALE, coc-prettier
• Watching For Changes — File watcher setup
• CLI — Command-line usage
• API — Programmatic usage
• Browser — Standalone browser build
• Run Prettier on CI — GitHub Actions
• Options — All format options
• Configuration File — Config files & overrides
• Sharing configurations — Shareable configs
• Integrating with Linters — ESLint/Stylelint
• Pre-commit Hook — Git hooks
• Plugins — Plugin API & development
• Related Projects — Ecosystem
• Technical Details — Printer algorithm
• For Enterprise — Tidelift subscription

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

• Author: pledgeandgrow
• Source: pledgeandgrow/pledge-skills
• License: MIT

Install and usage instructions live in the source repository linked above.