Skip to content

Commit f5fc01c

Browse files
committed
Refine examples for @reduxjs/prettier-config
1 parent b02e396 commit f5fc01c

File tree

1 file changed

+31
-8
lines changed

1 file changed

+31
-8
lines changed

packages/configs/prettier/src/index.mts

Lines changed: 31 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,27 @@ import type { Config } from 'prettier'
44
* Prettier configuration tailored for internal Redux projects.
55
*
66
* @example
7-
* <caption>__ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
7+
* <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
88
*
9-
* ```js
9+
* ```ts
1010
* import { reduxPrettierConfig } from '@reduxjs/prettier-config'
1111
*
1212
* export default reduxPrettierConfig
1313
* ```
1414
*
1515
* @example
16-
* <caption>__CommonJS (CJS) usage inside a file like `prettier.config.cjs`__</caption>
16+
* <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
1717
*
18-
* ```js
18+
* ```ts
19+
* const { reduxPrettierConfig } = require('@reduxjs/prettier-config')
20+
*
21+
* module.exports = reduxPrettierConfig
22+
* ```
23+
*
24+
* @example
25+
* <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
26+
*
27+
* ```ts
1928
* module.exports = (async () =>
2029
* (await import('@reduxjs/prettier-config')).reduxPrettierConfig)()
2130
* ```
@@ -38,8 +47,9 @@ export const reduxPrettierConfig: Config = {
3847
* @returns An augmented version of the default {@linkcode reduxPrettierConfig}, incorporating any provided overrides.
3948
*
4049
* @example
41-
* <caption>__ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
42-
* ```js
50+
* <caption>#### __ECMAScript Modules (ESM) usage inside a file like `prettier.config.mjs`__</caption>
51+
*
52+
* ```ts
4353
* import { createPrettierConfig } from '@reduxjs/prettier-config'
4454
*
4555
* export default createPrettierConfig({
@@ -49,8 +59,21 @@ export const reduxPrettierConfig: Config = {
4959
* ```
5060
*
5161
* @example
52-
* <caption>__CommonJS (CJS) usage inside a file like `prettier.config.cjs`__</caption>
53-
* ```js
62+
* <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using `require`)__</caption>
63+
*
64+
* ```ts
65+
* const { createPrettierConfig } = require('@reduxjs/prettier-config')
66+
*
67+
* module.exports = createPrettierConfig({
68+
* arrowParens: 'avoid',
69+
* // ...Other additional overrides
70+
* })
71+
* ```
72+
*
73+
* @example
74+
* <caption>#### __CommonJS (CJS) usage inside a file like `prettier.config.cjs` (using dynamic import)__</caption>
75+
*
76+
* ```ts
5477
* module.exports = (async () =>
5578
* (await import('@reduxjs/prettier-config')).createPrettierConfig({
5679
* arrowParens: 'avoid',

0 commit comments

Comments
 (0)