prettier-plugin-embed 0.4.9 → 0.4.11

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.
Files changed (35) hide show
  1. package/README.md +736 -124
  2. package/dist/embedded/css/options.d.ts +36 -11
  3. package/dist/embedded/es/options.d.ts +36 -11
  4. package/dist/embedded/glsl/options.d.ts +36 -11
  5. package/dist/embedded/graphql/options.d.ts +36 -10
  6. package/dist/embedded/html/options.d.ts +36 -11
  7. package/dist/embedded/index.d.ts +2 -2
  8. package/dist/embedded/ini/options.d.ts +36 -10
  9. package/dist/embedded/java/options.d.ts +36 -5
  10. package/dist/embedded/json/options.d.ts +37 -11
  11. package/dist/embedded/jsonata/options.d.ts +36 -5
  12. package/dist/embedded/latex/options.d.ts +36 -10
  13. package/dist/embedded/markdown/options.d.ts +36 -11
  14. package/dist/embedded/nginx/options.d.ts +36 -5
  15. package/dist/embedded/noop/options.d.ts +29 -3
  16. package/dist/embedded/pegjs/options.d.ts +36 -5
  17. package/dist/embedded/php/options.d.ts +36 -11
  18. package/dist/embedded/prisma/options.d.ts +36 -5
  19. package/dist/embedded/properties/options.d.ts +36 -10
  20. package/dist/embedded/pug/options.d.ts +36 -5
  21. package/dist/embedded/register.d.ts +2 -2
  22. package/dist/embedded/ruby/options.d.ts +36 -10
  23. package/dist/embedded/sh/options.d.ts +36 -10
  24. package/dist/embedded/sql/options.d.ts +36 -11
  25. package/dist/embedded/toml/options.d.ts +36 -10
  26. package/dist/embedded/ts/options.d.ts +37 -12
  27. package/dist/embedded/types.d.ts +8 -2
  28. package/dist/embedded/utils.d.ts +3 -1
  29. package/dist/embedded/xml/options.d.ts +36 -11
  30. package/dist/embedded/yaml/options.d.ts +36 -10
  31. package/dist/index.js +1631 -1127
  32. package/dist/options.d.ts +509 -11
  33. package/dist/types.d.ts +36 -6
  34. package/dist/utils.d.ts +136 -5
  35. package/package.json +6 -6
package/dist/options.d.ts CHANGED
@@ -1,11 +1,14 @@
1
- import { type AutocompleteStringList, type EmbeddedDefaultIdentifier } from "./embedded/index.js";
2
- type EmbeddedIdentifiers = AutocompleteStringList<EmbeddedDefaultIdentifier>;
1
+ import { type EmbeddedComment, type EmbeddedTag } from "./embedded/index.js";
2
+ type EmbeddedCommentsOrTags = (EmbeddedComment | EmbeddedTag)[];
3
3
  declare const NO_EMBEDDED_IDENTIFICATION_BY_COMMENT = "noEmbeddedIdentificationByComment";
4
4
  declare const NO_EMBEDDED_IDENTIFICATION_BY_TAG = "noEmbeddedIdentificationByTag";
5
5
  declare const PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES = "preserveEmbeddedExteriorWhitespaces";
6
6
  declare const NO_EMBEDDED_MULTI_LINE_INDENTATION = "noEmbeddedMultiLineIndentation";
7
7
  declare const EMBEDDED_OVERRIDES = "embeddedOverrides";
8
8
  export declare const options: {
9
+ /**
10
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
11
+ */
9
12
  readonly noEmbeddedIdentificationByComment: {
10
13
  readonly category: "Embed";
11
14
  readonly type: "string";
@@ -13,8 +16,12 @@ export declare const options: {
13
16
  readonly default: [{
14
17
  readonly value: [];
15
18
  }];
16
- readonly description: "Turns off `` /* identifier */ `...` `` comment-based embedded language identification for the specified identifiers.";
19
+ readonly description: "Turns off `` /* comment */ `...` `` comment-based embedded language identification for the specified identifiers.";
20
+ readonly deprecated: "Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.";
17
21
  };
22
+ /**
23
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
24
+ */
18
25
  readonly noEmbeddedIdentificationByTag: {
19
26
  readonly category: "Embed";
20
27
  readonly type: "string";
@@ -22,7 +29,8 @@ export declare const options: {
22
29
  readonly default: [{
23
30
  readonly value: [];
24
31
  }];
25
- readonly description: "Turns off `` identifier`...` `` tag-based embedded language identification for the specified identifiers.";
32
+ readonly description: "Turns off `` tag`...` `` tag-based embedded language identification for the specified identifiers.";
33
+ readonly deprecated: "Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.";
26
34
  };
27
35
  readonly preserveEmbeddedExteriorWhitespaces: {
28
36
  readonly category: "Embed";
@@ -31,7 +39,7 @@ export declare const options: {
31
39
  readonly default: [{
32
40
  readonly value: [];
33
41
  }];
34
- readonly description: "Preserves leading and trailing whitespaces in the formatting results for the specified identifiers.";
42
+ readonly description: "Preserves leading and trailing whitespaces in the formatting results for the specified comments or tags.";
35
43
  };
36
44
  readonly noEmbeddedMultiLineIndentation: {
37
45
  readonly category: "Embed";
@@ -40,14 +48,14 @@ export declare const options: {
40
48
  readonly default: [{
41
49
  readonly value: [];
42
50
  }];
43
- readonly description: "Turns off auto indentation in the formatting results for the specified identifiers when they are formatted to span multi lines.";
51
+ readonly description: "Turns off auto indentation in the formatting results for the specified comments or tags when they are formatted to span multi lines.";
44
52
  };
45
53
  readonly embeddedOverrides: {
46
54
  readonly category: "Embed";
47
55
  readonly type: "string";
48
56
  readonly array: false;
49
57
  readonly default: undefined;
50
- readonly description: "Option overrides for the specified identifiers. It should either be a stringified JSON or an absolute filepath to the option overrides file.";
58
+ readonly description: "Option overrides for the specified comments or tags. It should either be a stringified JSON or an absolute filepath to the option overrides file.";
51
59
  };
52
60
  readonly embeddedNoopIdentifiers: {
53
61
  readonly category: "Embed";
@@ -57,6 +65,25 @@ export declare const options: {
57
65
  readonly value: [];
58
66
  }];
59
67
  readonly description: "Tag or comment identifiers that prevent their subsequent template literals from being identified as embedded languages and thus from being formatted.";
68
+ readonly deprecated: "Please use `embeddedNoopComments` or `embeddedNoopTags`.";
69
+ };
70
+ readonly embeddedNoopComments: {
71
+ readonly category: "Embed";
72
+ readonly type: "string";
73
+ readonly array: true;
74
+ readonly default: [{
75
+ readonly value: [];
76
+ }];
77
+ readonly description: "Block comments that prevent their subsequent template literals from being identified as embedded languages and thus from being formatted.";
78
+ };
79
+ readonly embeddedNoopTags: {
80
+ readonly category: "Embed";
81
+ readonly type: "string";
82
+ readonly array: true;
83
+ readonly default: [{
84
+ readonly value: [];
85
+ }];
86
+ readonly description: "Tags that prevent their subsequent template literals from being identified as embedded languages and thus from being formatted.";
60
87
  };
61
88
  readonly embeddedCssIdentifiers: {
62
89
  readonly category: "Embed";
@@ -66,6 +93,25 @@ export declare const options: {
66
93
  readonly value: ["css"];
67
94
  }];
68
95
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded CSS language.";
96
+ readonly deprecated: "Please use `embeddedCssComments` or `embeddedCssTags`.";
97
+ };
98
+ readonly embeddedCssComments: {
99
+ readonly category: "Embed";
100
+ readonly type: "string";
101
+ readonly array: true;
102
+ readonly default: [{
103
+ readonly value: [];
104
+ }];
105
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded CSS language.";
106
+ };
107
+ readonly embeddedCssTags: {
108
+ readonly category: "Embed";
109
+ readonly type: "string";
110
+ readonly array: true;
111
+ readonly default: [{
112
+ readonly value: [];
113
+ }];
114
+ readonly description: "Tags that make their subsequent template literals be identified as embedded CSS language.";
69
115
  };
70
116
  readonly embeddedCssParser: {
71
117
  category: string;
@@ -85,6 +131,25 @@ export declare const options: {
85
131
  readonly value: ["js", "jsx", "es", "es6", "mjs", "cjs", "pac", "javascript"];
86
132
  }];
87
133
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded ECMAScript/JavaScript language.";
134
+ readonly deprecated: "Please use `embeddedEsComments` or `embeddedEsTags`.";
135
+ };
136
+ readonly embeddedEsComments: {
137
+ readonly category: "Embed";
138
+ readonly type: "string";
139
+ readonly array: true;
140
+ readonly default: [{
141
+ readonly value: [];
142
+ }];
143
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded ECMAScript/JavaScript language.";
144
+ };
145
+ readonly embeddedEsTags: {
146
+ readonly category: "Embed";
147
+ readonly type: "string";
148
+ readonly array: true;
149
+ readonly default: [{
150
+ readonly value: [];
151
+ }];
152
+ readonly description: "Tags that make their subsequent template literals be identified as embedded ECMAScript/JavaScript language.";
88
153
  };
89
154
  readonly embeddedEsParser: {
90
155
  category: string;
@@ -104,6 +169,25 @@ export declare const options: {
104
169
  readonly value: ["glsl", "shader"];
105
170
  }];
106
171
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded GLSL language. This option requires the `prettier-plugin-glsl` plugin.";
172
+ readonly deprecated: "Please use `embeddedGlslComments` or `embeddedGlslTags`.";
173
+ };
174
+ readonly embeddedGlslComments: {
175
+ readonly category: "Embed";
176
+ readonly type: "string";
177
+ readonly array: true;
178
+ readonly default: [{
179
+ readonly value: [];
180
+ }];
181
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded GLSL language. This option requires the `prettier-plugin-glsl` plugin.";
182
+ };
183
+ readonly embeddedGlslTags: {
184
+ readonly category: "Embed";
185
+ readonly type: "string";
186
+ readonly array: true;
187
+ readonly default: [{
188
+ readonly value: [];
189
+ }];
190
+ readonly description: "Tags that make their subsequent template literals be identified as embedded GLSL language. This option requires the `prettier-plugin-glsl` plugin.";
107
191
  };
108
192
  readonly embeddedGraphqlIdentifiers: {
109
193
  readonly category: "Embed";
@@ -113,6 +197,25 @@ export declare const options: {
113
197
  readonly value: ["graphql", "gql"];
114
198
  }];
115
199
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded GraphQL language.";
200
+ readonly deprecated: "Please use `embeddedGraphqlComments` or `embeddedGraphqlTags`.";
201
+ };
202
+ readonly embeddedGraphqlComments: {
203
+ readonly category: "Embed";
204
+ readonly type: "string";
205
+ readonly array: true;
206
+ readonly default: [{
207
+ readonly value: [];
208
+ }];
209
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded GraphQL language.";
210
+ };
211
+ readonly embeddedGraphqlTags: {
212
+ readonly category: "Embed";
213
+ readonly type: "string";
214
+ readonly array: true;
215
+ readonly default: [{
216
+ readonly value: [];
217
+ }];
218
+ readonly description: "Tags that make their subsequent template literals be identified as embedded GraphQL language.";
116
219
  };
117
220
  readonly embeddedHtmlIdentifiers: {
118
221
  readonly category: "Embed";
@@ -122,6 +225,25 @@ export declare const options: {
122
225
  readonly value: ["html", "xhtml"];
123
226
  }];
124
227
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded HTML language.";
228
+ readonly deprecated: "Please use `embeddedHtmlComments` or `embeddedHtmlTags`.";
229
+ };
230
+ readonly embeddedHtmlComments: {
231
+ readonly category: "Embed";
232
+ readonly type: "string";
233
+ readonly array: true;
234
+ readonly default: [{
235
+ readonly value: [];
236
+ }];
237
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded HTML language.";
238
+ };
239
+ readonly embeddedHtmlTags: {
240
+ readonly category: "Embed";
241
+ readonly type: "string";
242
+ readonly array: true;
243
+ readonly default: [{
244
+ readonly value: [];
245
+ }];
246
+ readonly description: "Tags that make their subsequent template literals be identified as embedded HTML language.";
125
247
  };
126
248
  readonly embeddedHtmlParser: {
127
249
  category: string;
@@ -141,6 +263,25 @@ export declare const options: {
141
263
  readonly value: ["ini", "cfg", "pro"];
142
264
  }];
143
265
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded INI language. This option requires the `prettier-plugin-ini` plugin.";
266
+ readonly deprecated: "Please use `embeddedIniComments` or `embeddedIniTags`.";
267
+ };
268
+ readonly embeddedIniComments: {
269
+ readonly category: "Embed";
270
+ readonly type: "string";
271
+ readonly array: true;
272
+ readonly default: [{
273
+ readonly value: [];
274
+ }];
275
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded INI language. This option requires the `prettier-plugin-ini` plugin.";
276
+ };
277
+ readonly embeddedIniTags: {
278
+ readonly category: "Embed";
279
+ readonly type: "string";
280
+ readonly array: true;
281
+ readonly default: [{
282
+ readonly value: [];
283
+ }];
284
+ readonly description: "Tags that make their subsequent template literals be identified as embedded INI language. This option requires the `prettier-plugin-ini` plugin.";
144
285
  };
145
286
  readonly embeddedJavaIdentifiers: {
146
287
  readonly category: "Embed";
@@ -150,6 +291,25 @@ export declare const options: {
150
291
  readonly value: ["java"];
151
292
  }];
152
293
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Java language. This option requires the `prettier-plugin-java` plugin.";
294
+ readonly deprecated: "Please use `embeddedJavaComments` or `embeddedJavaTags`.";
295
+ };
296
+ readonly embeddedJavaComments: {
297
+ readonly category: "Embed";
298
+ readonly type: "string";
299
+ readonly array: true;
300
+ readonly default: [{
301
+ readonly value: [];
302
+ }];
303
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Java language. This option requires the `prettier-plugin-java` plugin.";
304
+ };
305
+ readonly embeddedJavaTags: {
306
+ readonly category: "Embed";
307
+ readonly type: "string";
308
+ readonly array: true;
309
+ readonly default: [{
310
+ readonly value: [];
311
+ }];
312
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Java language. This option requires the `prettier-plugin-java` plugin.";
153
313
  };
154
314
  readonly embeddedJsonIdentifiers: {
155
315
  readonly category: "Embed";
@@ -159,6 +319,25 @@ export declare const options: {
159
319
  readonly value: ["json", "jsonl"];
160
320
  }];
161
321
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded JSON language.";
322
+ readonly deprecated: "Please use `embeddedJsonComments` or `embeddedJsonTags`.";
323
+ };
324
+ readonly embeddedJsonComments: {
325
+ readonly category: "Embed";
326
+ readonly type: "string";
327
+ readonly array: true;
328
+ readonly default: [{
329
+ readonly value: [];
330
+ }];
331
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded JSON language.";
332
+ };
333
+ readonly embeddedJsonTags: {
334
+ readonly category: "Embed";
335
+ readonly type: "string";
336
+ readonly array: true;
337
+ readonly default: [{
338
+ readonly value: [];
339
+ }];
340
+ readonly description: "Tags that make their subsequent template literals be identified as embedded JSON language.";
162
341
  };
163
342
  readonly embeddedJsonParser: {
164
343
  category: string;
@@ -178,6 +357,28 @@ export declare const options: {
178
357
  readonly value: ["jsonata"];
179
358
  }];
180
359
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded JSONata language. This option requires the `@stedi/prettier-plugin-jsonata` plugin.";
360
+ readonly deprecated: "Please use `embeddedJsonataComments` or `embeddedJsonataTags`.";
361
+ };
362
+ /**
363
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
364
+ */
365
+ readonly embeddedJsonataComments: {
366
+ readonly category: "Embed";
367
+ readonly type: "string";
368
+ readonly array: true;
369
+ readonly default: [{
370
+ readonly value: [];
371
+ }];
372
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded JSONata language. This option requires the `@stedi/prettier-plugin-jsonata` plugin.";
373
+ };
374
+ readonly embeddedJsonataTags: {
375
+ readonly category: "Embed";
376
+ readonly type: "string";
377
+ readonly array: true;
378
+ readonly default: [{
379
+ readonly value: [];
380
+ }];
381
+ readonly description: "Tags that make their subsequent template literals be identified as embedded JSONata language. This option requires the `@stedi/prettier-plugin-jsonata` plugin.";
181
382
  };
182
383
  readonly embeddedLatexIdentifiers: {
183
384
  readonly category: "Embed";
@@ -187,6 +388,25 @@ export declare const options: {
187
388
  readonly value: ["latex", "tex", "aux", "cls", "bbl", "bib", "toc", "sty"];
188
389
  }];
189
390
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded LaTeX language. This option requires the `prettier-plugin-latex` plugin.";
391
+ readonly deprecated: "Please use `embeddedLatexComments` or `embeddedLatexTags`.";
392
+ };
393
+ readonly embeddedLatexComments: {
394
+ readonly category: "Embed";
395
+ readonly type: "string";
396
+ readonly array: true;
397
+ readonly default: [{
398
+ readonly value: [];
399
+ }];
400
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded LaTeX language. This option requires the `prettier-plugin-latex` plugin.";
401
+ };
402
+ readonly embeddedLatexTags: {
403
+ readonly category: "Embed";
404
+ readonly type: "string";
405
+ readonly array: true;
406
+ readonly default: [{
407
+ readonly value: [];
408
+ }];
409
+ readonly description: "Tags that make their subsequent template literals be identified as embedded LaTeX language. This option requires the `prettier-plugin-latex` plugin.";
190
410
  };
191
411
  readonly embeddedMarkdownIdentifiers: {
192
412
  readonly category: "Embed";
@@ -196,6 +416,25 @@ export declare const options: {
196
416
  readonly value: ["md", "markdown"];
197
417
  }];
198
418
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Markdown language.";
419
+ readonly deprecated: "Please use `embeddedMarkdownComments` or `embeddedMarkdownTags`.";
420
+ };
421
+ readonly embeddedMarkdownComments: {
422
+ readonly category: "Embed";
423
+ readonly type: "string";
424
+ readonly array: true;
425
+ readonly default: [{
426
+ readonly value: [];
427
+ }];
428
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Markdown language.";
429
+ };
430
+ readonly embeddedMarkdownTags: {
431
+ readonly category: "Embed";
432
+ readonly type: "string";
433
+ readonly array: true;
434
+ readonly default: [{
435
+ readonly value: [];
436
+ }];
437
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Markdown language.";
199
438
  };
200
439
  readonly embeddedMarkdownParser: {
201
440
  category: string;
@@ -215,6 +454,25 @@ export declare const options: {
215
454
  readonly value: ["nginx"];
216
455
  }];
217
456
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded NGINX language. This option requires the `prettier-plugin-nginx` plugin.";
457
+ readonly deprecated: "Please use `embeddedNginxComments` or `embeddedNginxTags`.";
458
+ };
459
+ readonly embeddedNginxComments: {
460
+ readonly category: "Embed";
461
+ readonly type: "string";
462
+ readonly array: true;
463
+ readonly default: [{
464
+ readonly value: [];
465
+ }];
466
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded NGINX language. This option requires the `prettier-plugin-nginx` plugin.";
467
+ };
468
+ readonly embeddedNginxTags: {
469
+ readonly category: "Embed";
470
+ readonly type: "string";
471
+ readonly array: true;
472
+ readonly default: [{
473
+ readonly value: [];
474
+ }];
475
+ readonly description: "Tags that make their subsequent template literals be identified as embedded NGINX language. This option requires the `prettier-plugin-nginx` plugin.";
218
476
  };
219
477
  readonly embeddedPegjsIdentifiers: {
220
478
  readonly category: "Embed";
@@ -224,6 +482,27 @@ export declare const options: {
224
482
  readonly value: ["pegjs", "peggy", "peg"];
225
483
  }];
226
484
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Pegjs language. This option requires the `prettier-plugin-pegjs` plugin.";
485
+ readonly deprecated: "Please use `embeddedPegjsComments` or `embeddedPegjsTags`.";
486
+ }; /**
487
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
488
+ */
489
+ readonly embeddedPegjsComments: {
490
+ readonly category: "Embed";
491
+ readonly type: "string";
492
+ readonly array: true;
493
+ readonly default: [{
494
+ readonly value: [];
495
+ }];
496
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Pegjs language. This option requires the `prettier-plugin-pegjs` plugin.";
497
+ };
498
+ readonly embeddedPegjsTags: {
499
+ readonly category: "Embed";
500
+ readonly type: "string";
501
+ readonly array: true;
502
+ readonly default: [{
503
+ readonly value: [];
504
+ }];
505
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Pegjs language. This option requires the `prettier-plugin-pegjs` plugin.";
227
506
  };
228
507
  readonly embeddedTsIdentifiers: {
229
508
  readonly category: "Embed";
@@ -233,6 +512,25 @@ export declare const options: {
233
512
  readonly value: ["ts", "tsx", "cts", "mts", "typescript"];
234
513
  }];
235
514
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded TypeScript language.";
515
+ readonly deprecated: "Please use `embeddedTsComments` or `embeddedTsTags`.";
516
+ };
517
+ readonly embeddedTsComments: {
518
+ readonly category: "Embed";
519
+ readonly type: "string";
520
+ readonly array: true;
521
+ readonly default: [{
522
+ readonly value: [];
523
+ }];
524
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded TypeScript language.";
525
+ };
526
+ readonly embeddedTsTags: {
527
+ readonly category: "Embed";
528
+ readonly type: "string";
529
+ readonly array: true;
530
+ readonly default: [{
531
+ readonly value: [];
532
+ }];
533
+ readonly description: "Tags that make their subsequent template literals be identified as embedded TypeScript language.";
236
534
  };
237
535
  readonly embeddedTsParser: {
238
536
  category: string;
@@ -252,6 +550,25 @@ export declare const options: {
252
550
  readonly value: ["php", "php5"];
253
551
  }];
254
552
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.";
553
+ readonly deprecated: "Please use `embeddedPhpComments` or `embeddedPhpTags`.";
554
+ };
555
+ readonly embeddedPhpComments: {
556
+ readonly category: "Embed";
557
+ readonly type: "string";
558
+ readonly array: true;
559
+ readonly default: [{
560
+ readonly value: [];
561
+ }];
562
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.";
563
+ };
564
+ readonly embeddedPhpTags: {
565
+ readonly category: "Embed";
566
+ readonly type: "string";
567
+ readonly array: true;
568
+ readonly default: [{
569
+ readonly value: [];
570
+ }];
571
+ readonly description: "Tags that make their subsequent template literals be identified as embedded PHP language. This option requires the `@prettier/plugin-php` plugin.";
255
572
  };
256
573
  readonly embeddedPrismaIdentifiers: {
257
574
  readonly category: "Embed";
@@ -261,6 +578,25 @@ export declare const options: {
261
578
  readonly value: ["prisma"];
262
579
  }];
263
580
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Prisma language. This option requires the `prettier-plugin-prisma` plugin.";
581
+ readonly deprecated: "Please use `embeddedPrismaComments` or `embeddedPrismaTags`.";
582
+ };
583
+ readonly embeddedPrismaComments: {
584
+ readonly category: "Embed";
585
+ readonly type: "string";
586
+ readonly array: true;
587
+ readonly default: [{
588
+ readonly value: [];
589
+ }];
590
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Prisma language. This option requires the `prettier-plugin-prisma` plugin.";
591
+ };
592
+ readonly embeddedPrismaTags: {
593
+ readonly category: "Embed";
594
+ readonly type: "string";
595
+ readonly array: true;
596
+ readonly default: [{
597
+ readonly value: [];
598
+ }];
599
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Prisma language. This option requires the `prettier-plugin-prisma` plugin.";
264
600
  };
265
601
  readonly embeddedPropertiesIdentifiers: {
266
602
  readonly category: "Embed";
@@ -270,6 +606,27 @@ export declare const options: {
270
606
  readonly value: ["properties"];
271
607
  }];
272
608
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Properties language. This option requires the `prettier-plugin-properties` plugin.";
609
+ readonly deprecated: "Please use `embeddedPropertiesComments` or `embeddedPropertiesTags`.";
610
+ }; /**
611
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
612
+ */
613
+ readonly embeddedPropertiesComments: {
614
+ readonly category: "Embed";
615
+ readonly type: "string";
616
+ readonly array: true;
617
+ readonly default: [{
618
+ readonly value: [];
619
+ }];
620
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Properties language. This option requires the `prettier-plugin-properties` plugin.";
621
+ };
622
+ readonly embeddedPropertiesTags: {
623
+ readonly category: "Embed";
624
+ readonly type: "string";
625
+ readonly array: true;
626
+ readonly default: [{
627
+ readonly value: [];
628
+ }];
629
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Properties language. This option requires the `prettier-plugin-properties` plugin.";
273
630
  };
274
631
  readonly embeddedPugIdentifiers: {
275
632
  readonly category: "Embed";
@@ -279,6 +636,25 @@ export declare const options: {
279
636
  readonly value: ["pug", "jade"];
280
637
  }];
281
638
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Pug language. This option requires the `@prettier/plugin-pug` plugin.";
639
+ readonly deprecated: "Please use `embeddedPugComments` or `embeddedPugTags`.";
640
+ };
641
+ readonly embeddedPugComments: {
642
+ readonly category: "Embed";
643
+ readonly type: "string";
644
+ readonly array: true;
645
+ readonly default: [{
646
+ readonly value: [];
647
+ }];
648
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Pug language. This option requires the `@prettier/plugin-pug` plugin.";
649
+ };
650
+ readonly embeddedPugTags: {
651
+ readonly category: "Embed";
652
+ readonly type: "string";
653
+ readonly array: true;
654
+ readonly default: [{
655
+ readonly value: [];
656
+ }];
657
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Pug language. This option requires the `@prettier/plugin-pug` plugin.";
282
658
  };
283
659
  readonly embeddedRubyIdentifiers: {
284
660
  readonly category: "Embed";
@@ -288,6 +664,25 @@ export declare const options: {
288
664
  readonly value: ["ruby"];
289
665
  }];
290
666
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Ruby language. This option requires the `@prettier/plugin-ruby` plugin.";
667
+ readonly deprecated: "Please use `embeddedRubyComments` or `embeddedRubyTags`.";
668
+ };
669
+ readonly embeddedRubyComments: {
670
+ readonly category: "Embed";
671
+ readonly type: "string";
672
+ readonly array: true;
673
+ readonly default: [{
674
+ readonly value: [];
675
+ }];
676
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Ruby language. This option requires the `@prettier/plugin-ruby` plugin.";
677
+ };
678
+ readonly embeddedRubyTags: {
679
+ readonly category: "Embed";
680
+ readonly type: "string";
681
+ readonly array: true;
682
+ readonly default: [{
683
+ readonly value: [];
684
+ }];
685
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Ruby language. This option requires the `@prettier/plugin-ruby` plugin.";
291
686
  };
292
687
  readonly embeddedRubyParser: {
293
688
  category: string;
@@ -307,6 +702,25 @@ export declare const options: {
307
702
  readonly value: ["sh"];
308
703
  }];
309
704
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded Shell language. This option requires the `prettier-plugin-sh` plugin.";
705
+ readonly deprecated: "Please use `embeddedShComments` or `embeddedShTags`.";
706
+ };
707
+ readonly embeddedShComments: {
708
+ readonly category: "Embed";
709
+ readonly type: "string";
710
+ readonly array: true;
711
+ readonly default: [{
712
+ readonly value: [];
713
+ }];
714
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded Shell language. This option requires the `prettier-plugin-sh` plugin.";
715
+ };
716
+ readonly embeddedShTags: {
717
+ readonly category: "Embed";
718
+ readonly type: "string";
719
+ readonly array: true;
720
+ readonly default: [{
721
+ readonly value: [];
722
+ }];
723
+ readonly description: "Tags that make their subsequent template literals be identified as embedded Shell language. This option requires the `prettier-plugin-sh` plugin.";
310
724
  };
311
725
  readonly embeddedSqlIdentifiers: {
312
726
  readonly category: "Embed";
@@ -316,6 +730,25 @@ export declare const options: {
316
730
  readonly value: ["sql"];
317
731
  }];
318
732
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded SQL language. This option requires the `prettier-plugin-sql` plugin or the `prettier-plugin-sql-cst` plugin.";
733
+ readonly deprecated: "Please use `embeddedSqlComments` or `embeddedSqlTags`.";
734
+ };
735
+ readonly embeddedSqlComments: {
736
+ readonly category: "Embed";
737
+ readonly type: "string";
738
+ readonly array: true;
739
+ readonly default: [{
740
+ readonly value: [];
741
+ }];
742
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded SQL language. This option requires the `prettier-plugin-sql` plugin or the `prettier-plugin-sql-cst` plugin.";
743
+ };
744
+ readonly embeddedSqlTags: {
745
+ readonly category: "Embed";
746
+ readonly type: "string";
747
+ readonly array: true;
748
+ readonly default: [{
749
+ readonly value: [];
750
+ }];
751
+ readonly description: "Tags that make their subsequent template literals be identified as embedded SQL language. This option requires the `prettier-plugin-sql` plugin or the `prettier-plugin-sql-cst` plugin.";
319
752
  };
320
753
  readonly embeddedSqlPlugin: {
321
754
  category: string;
@@ -345,6 +778,25 @@ export declare const options: {
345
778
  readonly value: ["toml"];
346
779
  }];
347
780
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded TOML language. This option requires the `prettier-plugin-toml` plugin.";
781
+ readonly deprecated: "Please use `embeddedTomlComments` or `embeddedTomlTags`.";
782
+ };
783
+ readonly embeddedTomlComments: {
784
+ readonly category: "Embed";
785
+ readonly type: "string";
786
+ readonly array: true;
787
+ readonly default: [{
788
+ readonly value: [];
789
+ }];
790
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded TOML language. This option requires the `prettier-plugin-toml` plugin.";
791
+ };
792
+ readonly embeddedTomlTags: {
793
+ readonly category: "Embed";
794
+ readonly type: "string";
795
+ readonly array: true;
796
+ readonly default: [{
797
+ readonly value: [];
798
+ }];
799
+ readonly description: "Tags that make their subsequent template literals be identified as embedded TOML language. This option requires the `prettier-plugin-toml` plugin.";
348
800
  };
349
801
  readonly embeddedXmlIdentifiers: {
350
802
  readonly category: "Embed";
@@ -354,6 +806,27 @@ export declare const options: {
354
806
  readonly value: ["xml", "opml", "rss", "svg"];
355
807
  }];
356
808
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded XML language. This option requires the `@prettier/plugin-xml` plugin.";
809
+ readonly deprecated: "Please use `embeddedXmlComments` or `embeddedXmlTags`.";
810
+ }; /**
811
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
812
+ */
813
+ readonly embeddedXmlComments: {
814
+ readonly category: "Embed";
815
+ readonly type: "string";
816
+ readonly array: true;
817
+ readonly default: [{
818
+ readonly value: [];
819
+ }];
820
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded XML language. This option requires the `@prettier/plugin-xml` plugin.";
821
+ };
822
+ readonly embeddedXmlTags: {
823
+ readonly category: "Embed";
824
+ readonly type: "string";
825
+ readonly array: true;
826
+ readonly default: [{
827
+ readonly value: [];
828
+ }];
829
+ readonly description: "Tags that make their subsequent template literals be identified as embedded XML language. This option requires the `@prettier/plugin-xml` plugin.";
357
830
  };
358
831
  readonly __embeddedXmlFragmentRecoverIndex: {
359
832
  readonly category: "Embed";
@@ -372,13 +845,38 @@ export declare const options: {
372
845
  readonly value: ["yaml", "yml"];
373
846
  }];
374
847
  readonly description: "Tag or comment identifiers that make their subsequent template literals be identified as embedded YAML language.";
848
+ readonly deprecated: "Please use `embeddedYamlComments` or `embeddedYamlTags`.";
849
+ };
850
+ readonly embeddedYamlComments: {
851
+ readonly category: "Embed";
852
+ readonly type: "string";
853
+ readonly array: true;
854
+ readonly default: [{
855
+ readonly value: [];
856
+ }];
857
+ readonly description: "Block comments that make their subsequent template literals be identified as embedded YAML language.";
858
+ };
859
+ readonly embeddedYamlTags: {
860
+ readonly category: "Embed";
861
+ readonly type: "string";
862
+ readonly array: true;
863
+ readonly default: [{
864
+ readonly value: [];
865
+ }];
866
+ readonly description: "Tags that make their subsequent template literals be identified as embedded YAML language.";
375
867
  };
376
868
  };
377
869
  export interface PluginEmbedLanguageAgnosticOptions {
378
- [NO_EMBEDDED_IDENTIFICATION_BY_COMMENT]?: EmbeddedIdentifiers;
379
- [NO_EMBEDDED_IDENTIFICATION_BY_TAG]?: EmbeddedIdentifiers;
380
- [PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES]?: EmbeddedIdentifiers;
381
- [NO_EMBEDDED_MULTI_LINE_INDENTATION]?: EmbeddedIdentifiers;
870
+ /**
871
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
872
+ */
873
+ [NO_EMBEDDED_IDENTIFICATION_BY_COMMENT]?: EmbeddedCommentsOrTags;
874
+ /**
875
+ * @deprecated Please use `embedded<Language>Comments` or `embedded<Language>Tags` to configure each embedded language, and you won't need this option anymore.
876
+ */
877
+ [NO_EMBEDDED_IDENTIFICATION_BY_TAG]?: EmbeddedCommentsOrTags;
878
+ [PRESERVE_EMBEDDED_EXTERIOR_WHITESPACES]?: EmbeddedCommentsOrTags;
879
+ [NO_EMBEDDED_MULTI_LINE_INDENTATION]?: EmbeddedCommentsOrTags;
382
880
  [EMBEDDED_OVERRIDES]?: string;
383
881
  }
384
882
  declare module "./embedded/types.js" {