@@ -4,18 +4,27 @@ import type { Config } from 'prettier'
4
4
* Prettier configuration tailored for internal Redux projects.
5
5
*
6
6
* @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>
8
8
*
9
- * ```js
9
+ * ```ts
10
10
* import { reduxPrettierConfig } from '@reduxjs/prettier-config'
11
11
*
12
12
* export default reduxPrettierConfig
13
13
* ```
14
14
*
15
15
* @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>
17
17
*
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
19
28
* module.exports = (async () =>
20
29
* (await import('@reduxjs/prettier-config')).reduxPrettierConfig)()
21
30
* ```
@@ -38,8 +47,9 @@ export const reduxPrettierConfig: Config = {
38
47
* @returns An augmented version of the default {@linkcode reduxPrettierConfig}, incorporating any provided overrides.
39
48
*
40
49
* @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
43
53
* import { createPrettierConfig } from '@reduxjs/prettier-config'
44
54
*
45
55
* export default createPrettierConfig({
@@ -49,8 +59,21 @@ export const reduxPrettierConfig: Config = {
49
59
* ```
50
60
*
51
61
* @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
54
77
* module.exports = (async () =>
55
78
* (await import('@reduxjs/prettier-config')).createPrettierConfig({
56
79
* arrowParens: 'avoid',
0 commit comments