jabberhams / vsprettier

A Visual Studio integration of Prettier code formatter

JavaScript Prettier

Download this extension from the Marketplace or get the CI build.

---

Prettier is an opinionated JavaScript formatter inspired by refmt with advanced support for language features from ES2017, JSX, TypeScript and Flow. It removes all original styling and ensures that all outputted JavaScript conforms to a consistent style.

See the change log for changes and road map.

Features

• Prettifies JavaScript or TypeScript files
• Uses Prettier node module
  • If a version of Prettier can be found installed via npm locally (relative to the current file), it will be used.
  • If no local Prettier installation is found, the extension falls back to an embedded Prettier.
• Reads the standard Prettier configuration file

Prettify

This extension calls the Prettier node module behind the scenes to format any JavaScript document to its standards.

For example, take the following code:

foo(arg1, arg2, arg3, arg4);

That looks like the right way to format it. However, we've all run into this situation:

foo(reallyLongArg(), omgSoManyParameters(), IShouldRefactorThis(), isThereSeriouslyAnotherOne());

Suddenly our previous format for calling function breaks down because this is too long. What you would probably do is this instead:

foo(
  reallyLongArg(),
  omgSoManyParameters(),
  IShouldRefactorThis(),
  isThereSeriouslyAnotherOne()
);

Invoke the command from the context menu in the JavaScript editor.

FAQ

Updating from 1.1 to 2.0

Depending on your Visual Studio Configuration, you might experience that 2.0's output differs from the one you got with 1.1.

Most likely it is the tab size that has been changed from 4 spaces to 2. Please read the configuration section below on details how to get 4 spaces as tabsize.

Configuration via .prettierrc

It is quite easy to setup Prettier to format a little bit differently, like having 4 spaces instead of 2 spaces per tab.

The easiest way is to create a .prettierrc file in your project root.

Here is an example containing the two most common settings that people want to change: tabWidth is how many spaces it uses for indentation, and printWidth is how long a line can be before it breaks down:

  {
    "tabWidth": 4,
    "printWidth": 100
  }

Read more about Prettier configuration options here.

Settings

Access extension settings within Visual Studio via Tools >>> Options, Prettier.

1. Format on Save
   • If true, run Prettier whenever a JavaScript file is saved.
   • (Try setting to true. This is where the magic happens, instantly snapping your code into place! Never fret with whitespace again!)
2. Prettier version for embedded usage:
   • If your solution does not have a local version of Prettier installed via npm, the extension will attempt to download and use the version noted here.
   • Extension will download a requested version once and reuse that now embedded Prettier install until the setting requests another version.
   • If the version declared cannot be found via npm, the extension will revert to 2.2.1, a known good Prettier version.
   • NOTE: To preserve legacy behavior, note that previous 2.x versions of this extension used Prettier 1.12.1.

Can it use my bundled version of Prettier?

Yes, the plugin will search for a locally (relative to the open file) installed Prettier version before falling back to its own version.

It does not currently support using a globally installed version of Prettier, and will use its embedded version instead.

Contribute

Check out the contribution guidelines if you want to contribute to this project.

For cloning and building this project yourself, make sure to install the Extensibility Tools 2015 extension for Visual Studio which enables some features used by this project.

License

Apache 2.0