Not everyone will want to use the Prettier VS Code extension. When working with other developers as a team, it can be challenging to keep the formatting of the code clean constantly. Using the above config, Prettier will not format TypeScript code on paste or save but it will format code on paste or save for any other language that it understands. "" :, "editor.formatOnPaste" : true, "editor.formatOnSave" : true , An understanding of ESLint and a working configuration (see " How to use ESLint with TypeScript" for an example)įirst thing's first, we'll install Prettier as a dev dependency.An existing codebase (if you need to get setup, you can follow " How to Setup a TypeScript + Node.js Project first and then come back to this article).A code editor installed (VS Code is the champ, don't me).Decide on the formatting configuration that best suits your style.Set up Prettier for a TypeScript or JavaScript project.Goals for this blog postĪt the end of this post, you should be able to:
Prettier performs the auto-formatting based on the ESLint rules.Using Prettier with ESLintĬombining both ESLint and Prettier, the responsibility division is this: We get the most benefit out of Prettier when we combine it with ESLint though. Prettier can be configured to format your code (makes it look prettier 😉) after you save a file or manually tell it to, and by default, it comes configured with a set of common code cleanliness rules. ESLint can kind of format code too, but it's mostly intended to sniff out when we're not following the mandated coding conventions. Prettier is an opinionated (yet fully configurable) code formatter. Here's where Prettier, particularly the VS Code extension for Prettier, comes in.
This is great, but it can get pretty annoying having to re-run npm run lint everytime we want lint (and optionally fix) our code. In the previous article in this series, " How to use ESLint with TypeScript", we learned how add ESLint to our project and configure it to determine if our code was adhering to our project's coding conventions.
This post is a part of the Clean Code Tooling series.
0 kommentar(er)
