Skip to content

Commit de57013

Browse files
update README to include info about presets
1 parent 4a4a3bb commit de57013

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,28 @@ Since esformatter is available as a command-line tool, it can be used in any edi
193193
See [doc/config.md](./doc/config.md).
194194

195195

196+
## Presets
197+
198+
Presets are reusable config files that can `require` other presets/plugins and
199+
override configs.
200+
201+
```js
202+
{
203+
// presets are used as "base settings"
204+
"extends": [
205+
"preset:foobar", // load "esformatter-preset-foobar" from "./node_modules"
206+
"./lorem_ipsum.json" // load relative config file
207+
],
208+
209+
// you can still override any setting from the preset if needed
210+
"indent": {
211+
"value": " "
212+
}
213+
}
214+
```
215+
216+
For more info see [presets.md](./doc/presets.md)
217+
196218
## Pipe other CLI tools
197219

198220
Since we don't expect everyone to write plugins that only works with

0 commit comments

Comments
 (0)