Add the browser and unpkg field to package.json (#8387)

This commit is contained in:
Georgii Dolzhykov authored and GitHub committed 2020-05-25 14:51:54 +08:00
1 parent d420202df4
commit 47ed9a77e3
2 files changed
+6

No files matched your search

+4
View File
@@ -5,6 +5,8 @@ title: Browser
Run Prettier in the browser with the `standalone.js` UMD bundle shipped in the NPM package (starting in version 1.13). The UMD bundle only formats the code and has no support for config files, ignore files, CLI usage, or automatic loading of plugins.
The [`browser` field](https://github.com/defunctzombie/package-browser-field-spec) in Prettier's `package.json` points to `standalone.js`. That's why you can just `import` or `require` the `prettier` module to access Prettier's API, and your code can stay compatible with both Node and the browser as long as webpack or another bundler that supports the `browser` field is used. This is especially convenient for [plugins](plugins.md).
### `prettier.format(code, options)`
Unlike the `format` function from the [main API](api.md#prettierformatsource--options), this function does not load plugins automatically, so a `plugins` property is required if you want to load plugins. Additionally, the parsers included in the Prettier package won't be loaded automatically, so you need to load them before using them.
@@ -26,6 +28,8 @@ See [Usage](#usage) below for examples.
</script>
```
Note that the [`unpkg` field](https://unpkg.com/#examples) in Prettier's `package.json` points to `standalone.js`, that's why `https://unpkg.com/prettier` can also be used instead of `https://unpkg.com/prettier/standalone.js`.
### ES Modules
```js
+2
View File
@@ -8,6 +8,8 @@
"author": "James Long",
"license": "MIT",
"main": "./index.js",
"browser": "./standalone.js",
"unpkg": "./standalone.js",
"engines": {
"node": ">=10.13.0"
},