https://github.com/gmasclet/prettier-plugin-pgn Skip to content Navigation Menu Toggle navigation Sign in * Product + GitHub Copilot Write better code with AI + Security Find and fix vulnerabilities + Actions Automate any workflow + Codespaces Instant dev environments + Issues Plan and track work + Code Review Manage code changes + Discussions Collaborate outside of code + Code Search Find more, search less Explore + All features + Documentation + GitHub Skills + Blog * Solutions By company size + Enterprises + Small and medium teams + Startups By use case + DevSecOps + DevOps + CI/CD + View all use cases By industry + Healthcare + Financial services + Manufacturing + Government + View all industries View all solutions * Resources Topics + AI + DevOps + Security + Software Development + View all Explore + Learning Pathways + White papers, Ebooks, Webinars + Customer Stories + Partners + Executive Insights * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles Repositories + Topics + Trending + Collections * Enterprise + Enterprise platform AI-powered developer platform Available add-ons + Advanced Security Enterprise-grade security features + GitHub Copilot Enterprise-grade AI features + Premium Support Enterprise-grade 24/7 support * Pricing Search or jump to... Search code, repositories, users, issues, pull requests... Search [ ] Clear Search syntax tips Provide feedback We read every piece of feedback, and take your input very seriously. [ ] [ ] Include my email address so I can be contacted Cancel Submit feedback Saved searches Use saved searches to filter your results more quickly Name [ ] Query [ ] To see all available qualifiers, see our documentation. Cancel Create saved search Sign in Sign up Reseting focus You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session. You switched accounts on another tab or window. Reload to refresh your session. Dismiss alert {{ message }} gmasclet / prettier-plugin-pgn Public * Notifications You must be signed in to change notification settings * Fork 0 * Star 22 A Prettier plugin for formatting PGN files License MIT license 22 stars 0 forks Branches Tags Activity Star Notifications You must be signed in to change notification settings * Code * Issues 0 * Pull requests 0 * Actions * Security * Insights Additional navigation options * Code * Issues * Pull requests * Actions * Security * Insights gmasclet/prettier-plugin-pgn develop BranchesTags [ ] Go to file Code Folders and files Name Name Last commit Last commit message date Latest commit History 24 Commits src src test test .gitignore .gitignore .nvmrc .nvmrc .nycrc .nycrc .prettierrc .prettierrc LICENSE.txt LICENSE.txt README.md README.md eslint.config.mjs eslint.config.mjs package-lock.json package-lock.json package.json package.json tsconfig.json tsconfig.json View all files Repository files navigation * README * MIT license Prettier PGN plugin Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary. This plugin adds support for the Portable Game Notation format to Prettier. Portable Game Notation (PGN) is a standard plain text format for recording chess games (both the moves and related data), which can be read by humans and is also supported by most chess software. Example This sample game: [Event "Immortal Game"][Date "1851.06.21"][White "Anderssen, Adolf"][Black "Kieseritzky, Lionel"][Result "*"] 1.e2-e4 e7-e5 f4 exf4 3.Bc4 3...Qh4+ 4.Kf1 b5 {C33 King's Gambit Accepted: Bishop's Gambit, Bryan Countergambit} 5.Bxb5 Nf6 6.Nf3 Qh6 7.d3 Nh5 8.Nh4 ?! {Inaccuracy. Rg1 was best.} (8.Rg1 c6 9.Bc4 Be7 10.Nc3 O-O 11.Kf2 Nf6 12.Re1 Ng4+ 13.Kg1 Ba6 14.Bxa6 Nxa6 15.Qe2 Bc5+ 16.d4 Bxd4+ 17.Nxd4) 8...Qg5 9.Nf5 c6 {White eventually won by checkmate after 23 moves.} * will be transformed to this: [Event "Immortal Game"] [Date "1851.06.21"] [White "Anderssen, Adolf"] [Black "Kieseritzky, Lionel"] [Result "*"] 1.e4 e5 2.f4 exf4 3.Bc4 Qh4+ 4.Kf1 b5 {C33 King's Gambit Accepted: Bishop's Gambit, Bryan Countergambit} 5.Bxb5 Nf6 6.Nf3 Qh6 7.d3 Nh5 8.Nh4?! {Inaccuracy. Rg1 was best.} (8.Rg1 c6 9.Bc4 Be7 10.Nc3 O-O 11.Kf2 Nf6 12.Re1 Ng4+ 13.Kg1 Ba6 14.Bxa6 Nxa6 15.Qe2 Bc5+ 16.d4 Bxd4+ 17.Nxd4) 8...Qg5 9.Nf5 c6 {White eventually won by checkmate after 23 moves.} * Getting started To run prettier with the PGN plugin, you're going to need node. Install prettier and the plugin using the npm CLI: # Install locally if you intent to use Prettier in a specific folder npm install --save-dev prettier prettier-plugin-pgn # Or globally, which can be handy to format PGN files in any folder npm install --global prettier prettier-plugin-pgn Usage The plugin can be activated in your Prettier configuration file: { "plugins": ["prettier-plugin-pgn"] } Alternatively, it may be declared directly in the CLI, using the --plugin option: npx prettier --plugin="prettier-plugin-pgn" --write "path/to/file.pgn" Features This plugin supports most of the PGN specification. In particular, it supports: * Variations (including nested ones). * Annotations (either NAG, or most commons literal annotations). * Comments (only those inside braces). * PGN files with multiple games are supported. * Whenever possible, the plugin is lenient. It will accept a non canonical PGN game as long as it is unambiguous. The following PGN features are currently not supported by this plugin: * "Rest of line" comments (those starting with a semicolon character and continuing to the end of the line). * Escaped lines using a percent sign character (%). License The package is available as open source under the terms of the MIT License. About A Prettier plugin for formatting PGN files Resources Readme License MIT license Activity Stars 22 stars Watchers 1 watching Forks 0 forks Report repository Releases 2 tags Languages * TypeScript 99.0% * JavaScript 1.0% Footer (c) 2025 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact * Manage cookies * Do not share my personal information You can't perform that action at this time.