@timbic/prettier-config 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,5 +1,10 @@
1
1
  # @timbic/prettier-config
2
2
 
3
+ <p>
4
+ <a href="https://www.npmjs.com/package/@timbic/prettier-config"><img src="https://img.shields.io/npm/v/@timbic/prettier-config.svg?logo=nodedotjs" alt="npm package"></a>
5
+ <a href="https://github.com/Timbic/prettier-config"><img src="https://img.shields.io/badge/Github-gray.svg?logo=github" alt="github repo"></a>
6
+ </p>
7
+
3
8
  Extensible prettier configuration for smart developers.
4
9
 
5
10
  ## Usage
package/dist/index.d.ts CHANGED
@@ -12,10 +12,10 @@ export interface Config extends Partial<Options> {
12
12
  }
13
13
  export interface Options {
14
14
  /**
15
- * @see https://prettier.io/docs/options#print-width
16
15
  * Specify the line length that the printer will wrap on.
17
16
  * @default 140
18
17
  *
18
+ * @see https://prettier.io/docs/options#print-width
19
19
  */
20
20
  printWidth: number;
21
21
  /**
@@ -172,9 +172,9 @@ export interface Options {
172
172
  endOfLine: "auto" | "lf" | "crlf" | "cr";
173
173
  /**
174
174
  * Change when properties in objects are quoted.
175
+ * @default "consistent"
175
176
  *
176
177
  * @see https://prettier.io/docs/options#quote-props
177
- * @default "consistent"
178
178
  */
179
179
  quoteProps: "as-needed" | "consistent" | "preserve";
180
180
  /**
@@ -227,27 +227,14 @@ export interface Options {
227
227
  /**
228
228
  * Returns a Prettier config preset with the Timbic defaults, merged with any
229
229
  * user-provided options.
230
- *
231
- * @param options - Optional configuration to override the Timbic defaults.
232
- * @returns The merged Prettier config object.
233
- *
234
230
  * @example
235
231
  * ```ts
236
232
  * export default withTimbic({
237
233
  * singleQuote: true,
238
234
  * });
239
235
  * ```
240
- * Returns the default config with `singleQuote` overridden to `true`:
241
- * ```ts
242
- * {
243
- * arrowParens: "always",
244
- * bracketSameLine: false,
245
- * bracketSpacing: true,
246
- * checkIgnorePragma: false,
247
- * singleQuote: true,
248
- * // ...other options
249
- * }
250
- * ```
236
+ *
237
+ * Returns the default config with `singleQuote` overridden to `true`
251
238
  */
252
239
  export default function withTimbic(options?: Config): Config;
253
240
  //#endregion
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@timbic/prettier-config",
3
3
  "type": "module",
4
- "version": "1.2.1",
4
+ "version": "1.2.3",
5
5
  "private": false,
6
6
  "description": "Timbic's prettier configuration",
7
7
  "author": "Timur Bikmuhametov <tim.bic22@gmail.com>",
@@ -29,12 +29,12 @@
29
29
  "prettier": "^3.0.0"
30
30
  },
31
31
  "devDependencies": {
32
- "@timbic/eslint-config": "1.2.0",
33
- "@types/node": "26.4.1",
32
+ "@timbic/eslint-config": "1.2.1",
33
+ "@types/node": "26.5.1",
34
34
  "bumpp": "12.3.0",
35
- "eslint": "10.9.1",
35
+ "eslint": "10.10.0",
36
36
  "husky": "9.1.7",
37
- "lint-staged": "17.4.1",
37
+ "lint-staged": "17.5.1",
38
38
  "prettier": "3.9.6",
39
39
  "tsdown": "0.23.0",
40
40
  "typescript": "6.0.3"