projen 0.98.32 → 0.98.34

package/lib/javascript/biome/biome-config.d.ts

@@ -89,7 +89,8 @@ export interface BiomeConfiguration {
      */
     readonly plugins?: string[];
     /**
-     * Indicates whether this configuration file is at the root of a Biome project. By default, this is `true`.
+     * Indicates whether this configuration file is at the root of a Biome
+     * project. By default, this is `true`.
      *
      * @schema BiomeConfiguration#root
      */
@@ -123,7 +124,8 @@ export interface AssistConfiguration {
      */
     readonly enabled?: boolean;
     /**
-     * A list of glob patterns. Biome will include files/folders that will match these patterns.
+     * A list of glob patterns. Biome will include files/folders that will
+     * match these patterns.
      *
      * @schema AssistConfiguration#includes
      */
@@ -183,9 +185,11 @@ export declare function toJson_CssConfiguration(obj: CssConfiguration | undefine
  */
 export interface FilesConfiguration {
     /**
-     * **Deprecated:** Please use _force-ignore syntax_ in `files.includes` instead: <https://biomejs.dev/reference/configuration/#filesincludes>
+     * **Deprecated:** Please use _force-ignore syntax_ in `files.includes`
+     * instead: <https://biomejs.dev/reference/configuration/#filesincludes>
      *
-     * Set of file and folder names that should be unconditionally ignored by Biome's scanner.
+     * Set of file and folder names that should be unconditionally ignored by
+     * Biome's scanner.
      *
      * @schema FilesConfiguration#experimentalScannerIgnores
      */
@@ -197,13 +201,15 @@ export interface FilesConfiguration {
      */
     readonly ignoreUnknown?: boolean;
     /**
-     * A list of glob patterns. Biome will handle only those files/folders that will match these patterns.
+     * A list of glob patterns. Biome will handle only those files/folders that will
+     * match these patterns.
      *
      * @schema FilesConfiguration#includes
      */
     readonly includes?: string[];
     /**
-     * The maximum allowed size for source code files in bytes. Files above this limit will be ignored for performance reasons. Defaults to 1 MiB
+     * The maximum allowed size for source code files in bytes. Files above
+     * this limit will be ignored for performance reasons. Defaults to 1 MiB
      *
      * @default 1 MiB
      * @schema FilesConfiguration#maxSize
@@ -246,20 +252,27 @@ export interface FormatterConfiguration {
      */
     readonly enabled?: boolean;
     /**
-     * Whether to expand arrays and objects on multiple lines. When set to `auto`, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to `always`, these literals are formatted on multiple lines, regardless of length of the list. When set to `never`, these literals are formatted on a single line if it fits in the line. When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
+     * Whether to expand arrays and objects on multiple lines.
+     * When set to `auto`, object literals are formatted on multiple lines if the first property has a newline,
+     * and array literals are formatted on a single line if it fits in the line.
+     * When set to `always`, these literals are formatted on multiple lines, regardless of length of the list.
+     * When set to `never`, these literals are formatted on a single line if it fits in the line.
+     * When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
      *
      * @default auto".
      * @schema FormatterConfiguration#expand
      */
     readonly expand?: Expand;
     /**
-     * Whether formatting should be allowed to proceed if a given file has syntax errors
+     * Whether formatting should be allowed to proceed if a given file
+     * has syntax errors
      *
      * @schema FormatterConfiguration#formatWithErrors
      */
     readonly formatWithErrors?: boolean;
     /**
-     * A list of glob patterns. The formatter will include files/folders that will match these patterns.
+     * A list of glob patterns. The formatter will include files/folders that will
+     * match these patterns.
      *
      * @schema FormatterConfiguration#includes
      */
@@ -290,7 +303,8 @@ export interface FormatterConfiguration {
      */
     readonly lineWidth?: number;
     /**
-     * Use any `.editorconfig` files to configure the formatter. Configuration in `biome.json` will override `.editorconfig` configuration.
+     * Use any `.editorconfig` files to configure the formatter. Configuration
+     * in `biome.json` will override `.editorconfig` configuration.
      *
      * Default: `true`.
      *
@@ -506,7 +520,8 @@ export interface LinterConfiguration {
      */
     readonly enabled?: boolean;
     /**
-     * A list of glob patterns. The analyzer will handle only those files/folders that will match these patterns.
+     * A list of glob patterns. The analyzer will handle only those files/folders that will
+     * match these patterns.
      *
      * @schema LinterConfiguration#includes
      */
@@ -570,7 +585,8 @@ export interface OverridePattern {
      */
     readonly html?: HtmlConfiguration;
     /**
-     * A list of glob patterns. Biome will include files/folders that will match these patterns.
+     * A list of glob patterns. Biome will include files/folders that will
+     * match these patterns.
      *
      * @schema OverridePattern#includes
      */
@@ -630,15 +646,19 @@ export interface VcsConfiguration {
      */
     readonly enabled?: boolean;
     /**
-     * The folder where Biome should check for VCS files. By default, Biome will use the same folder where `biome.json` was found.
+     * The folder where Biome should check for VCS files. By default, Biome will use the same
+     * folder where `biome.json` was found.
      *
-     * If Biome can't find the configuration, it will attempt to use the current working directory. If no current working directory can't be found, Biome won't use the VCS integration, and a diagnostic will be emitted
+     * If Biome can't find the configuration, it will attempt to use the current working directory.
+     * If no current working directory can't be found, Biome won't use the VCS integration, and a diagnostic
+     * will be emitted
      *
      * @schema VcsConfiguration#root
      */
     readonly root?: string;
     /**
-     * Whether Biome should use the VCS ignore file. When [true], Biome will ignore the files specified in the ignore file.
+     * Whether Biome should use the VCS ignore file. When [true], Biome will ignore the files
+     * specified in the ignore file.
      *
      * @schema VcsConfiguration#useIgnoreFile
      */
@@ -799,33 +819,34 @@ export declare enum AttributePosition {
  * @schema Expand
  */
 export declare enum Expand {
-    /** auto */
+    /** Objects are expanded when the first property has a leading newline. Arrays are always
+  expanded if they are shorter than the line width. (auto) */
     AUTO = "auto",
-    /** always */
+    /** Objects and arrays are always expanded. (always) */
     ALWAYS = "always",
-    /** never */
+    /** Objects and arrays are never expanded, if they are shorter than the line width. (never) */
     NEVER = "never"
 }
 /**
  * @schema IndentStyle
  */
 export declare enum IndentStyle {
-    /** tab */
+    /** Indent with Tab (tab) */
     TAB = "tab",
-    /** space */
+    /** Indent with Space (space) */
     SPACE = "space"
 }
 /**
  * @schema LineEnding
  */
 export declare enum LineEnding {
-    /** lf */
+    /** Line Feed only (\n), common on Linux and macOS as well as inside git repos (lf) */
     LF = "lf",
-    /** crlf */
+    /** Carriage Return + Line Feed characters (\r\n), common on Windows (crlf) */
     CRLF = "crlf",
-    /** cr */
+    /** Carriage Return character only (\r), used very rarely (cr) */
     CR = "cr",
-    /** auto */
+    /** Automatically use CRLF on Windows and LF on other platforms (auto) */
     AUTO = "auto"
 }
 /**
@@ -1188,7 +1209,12 @@ export interface JsFormatterConfiguration {
      */
     readonly enabled?: boolean;
     /**
-     * Whether to expand arrays and objects on multiple lines. When set to `auto`, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to `always`, these literals are formatted on multiple lines, regardless of length of the list. When set to `never`, these literals are formatted on a single line if it fits in the line. When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
+     * Whether to expand arrays and objects on multiple lines.
+     * When set to `auto`, object literals are formatted on multiple lines if the first property has a newline,
+     * and array literals are formatted on a single line if it fits in the line.
+     * When set to `always`, these literals are formatted on multiple lines, regardless of length of the list.
+     * When set to `never`, these literals are formatted on a single line if it fits in the line.
+     * When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
      *
      * @default auto".
      * @schema JsFormatterConfiguration#expand
@@ -1260,7 +1286,7 @@ export interface JsFormatterConfiguration {
      * @default all".
      * @schema JsFormatterConfiguration#trailingCommas
      */
-    readonly trailingCommas?: TrailingCommas;
+    readonly trailingCommas?: JsTrailingCommas;
 }
 /**
  * Converts an object of type 'JsFormatterConfiguration' to JSON representation.
@@ -1273,9 +1299,18 @@ export declare function toJson_JsFormatterConfiguration(obj: JsFormatterConfigur
  * @schema JsxRuntime
  */
 export declare enum JsxRuntime {
-    /** transparent */
+    /** Indicates a modern or native JSX environment, that doesn't require
+  special handling by Biome. (transparent) */
     TRANSPARENT = "transparent",
-    /** reactClassic */
+    /** Indicates a classic React environment that requires the `React` import.
+  
+  Corresponds to the `react` value for the `jsx` option in TypeScript's
+  `tsconfig.json`.
+  
+  This option should only be necessary if you cannot upgrade to a React
+  version that supports the new JSX runtime. For more information about
+  the old vs. new JSX runtime, please see:
+  <https://legacy.reactjs.org/blog/2020/09/22/introducing-the-new-jsx-transform.html> (reactClassic) */
     REACT_CLASSIC = "reactClassic"
 }
 /**
@@ -1303,7 +1338,8 @@ export declare function toJson_JsLinterConfiguration(obj: JsLinterConfiguration
  */
 export interface JsParserConfiguration {
     /**
-     * Enables parsing of Grit metavariables. Defaults to `false`.
+     * Enables parsing of Grit metavariables.
+     * Defaults to `false`.
      *
      * @default false`.
      * @schema JsParserConfiguration#gritMetavariables
@@ -1368,7 +1404,12 @@ export interface JsonFormatterConfiguration {
      */
     readonly enabled?: boolean;
     /**
-     * Whether to expand arrays and objects on multiple lines. When set to `auto`, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to `always`, these literals are formatted on multiple lines, regardless of length of the list. When set to `never`, these literals are formatted on a single line if it fits in the line. When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
+     * Whether to expand arrays and objects on multiple lines.
+     * When set to `auto`, object literals are formatted on multiple lines if the first property has a newline,
+     * and array literals are formatted on a single line if it fits in the line.
+     * When set to `always`, these literals are formatted on multiple lines, regardless of length of the list.
+     * When set to `never`, these literals are formatted on a single line if it fits in the line.
+     * When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
      *
      * @default auto".
      * @schema JsonFormatterConfiguration#expand
@@ -1406,7 +1447,7 @@ export interface JsonFormatterConfiguration {
      * @default none".
      * @schema JsonFormatterConfiguration#trailingCommas
      */
-    readonly trailingCommas?: TrailingCommas2;
+    readonly trailingCommas?: JsonTrailingCommas;
 }
 /**
  * Converts an object of type 'JsonFormatterConfiguration' to JSON representation.
@@ -1459,11 +1500,11 @@ export declare function toJson_JsonParserConfiguration(obj: JsonParserConfigurat
  * @schema RuleDomainValue
  */
 export declare enum RuleDomainValue {
-    /** all */
+    /** Enables all the rules that belong to this domain (all) */
     ALL = "all",
-    /** none */
+    /** Disables all the rules that belong to this domain (none) */
     NONE = "none",
-    /** recommended */
+    /** Enables only the recommended rules for this domain (recommended) */
     RECOMMENDED = "recommended"
 }
 /**
@@ -1580,14 +1621,20 @@ export interface OverrideFormatterConfiguration {
      */
     readonly enabled?: boolean;
     /**
-     * Whether to expand arrays and objects on multiple lines. When set to `auto`, object literals are formatted on multiple lines if the first property has a newline, and array literals are formatted on a single line if it fits in the line. When set to `always`, these literals are formatted on multiple lines, regardless of length of the list. When set to `never`, these literals are formatted on a single line if it fits in the line. When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
+     * Whether to expand arrays and objects on multiple lines.
+     * When set to `auto`, object literals are formatted on multiple lines if the first property has a newline,
+     * and array literals are formatted on a single line if it fits in the line.
+     * When set to `always`, these literals are formatted on multiple lines, regardless of length of the list.
+     * When set to `never`, these literals are formatted on a single line if it fits in the line.
+     * When formatting `package.json`, Biome will use `always` unless configured otherwise. Defaults to "auto".
      *
      * @default auto".
      * @schema OverrideFormatterConfiguration#expand
      */
     readonly expand?: Expand;
     /**
-     * Stores whether formatting should be allowed to proceed if a given file has syntax errors
+     * Stores whether formatting should be allowed to proceed if a given file
+     * has syntax errors
      *
      * @schema OverrideFormatterConfiguration#formatWithErrors
      */
@@ -1676,6 +1723,7 @@ export declare enum VcsClientKind {
 export interface Source {
     /**
      * Provides a code action to sort the imports and exports in the file using a built-in or custom order.
+     * See <https://biomejs.dev/assist/actions/organize-imports>
      *
      * @schema Source#organizeImports
      */
@@ -1688,18 +1736,21 @@ export interface Source {
     readonly recommended?: boolean;
     /**
      * Enforce attribute sorting in JSX elements.
+     * See <https://biomejs.dev/assist/actions/use-sorted-attributes>
      *
      * @schema Source#useSortedAttributes
      */
     readonly useSortedAttributes?: any;
     /**
      * Sort the keys of a JSON object in natural order.
+     * See <https://biomejs.dev/assist/actions/use-sorted-keys>
      *
      * @schema Source#useSortedKeys
      */
     readonly useSortedKeys?: any;
     /**
      * Enforce ordering of CSS properties and nested rules.
+     * See <https://biomejs.dev/assist/actions/use-sorted-properties>
      *
      * @schema Source#useSortedProperties
      */
@@ -1725,9 +1776,9 @@ export declare enum QuoteStyle {
  * @schema SelfCloseVoidElements
  */
 export declare enum SelfCloseVoidElements {
-    /** never */
+    /** The `/` inside void elements is removed by the formatter (never) */
     NEVER = "never",
-    /** always */
+    /** The `/` inside void elements is always added (always) */
     ALWAYS = "always"
 }
 /**
@@ -1735,22 +1786,45 @@ export declare enum SelfCloseVoidElements {
  *
  * The following two cases won't produce the same output:
  *
- * |                |      html      |    output    | | -------------- | :------------: | :----------: | | with spaces    | `1<b> 2 </b>3` | 1<b> 2 </b>3 | | without spaces |  `1<b>2</b>3`  |  1<b>2</b>3  |
+ * |                |      html      |    output    |
+ * | -------------- | :------------: | :----------: |
+ * | with spaces    | `1<b> 2 </b>3` | 1<b> 2 </b>3 |
+ * | without spaces |  `1<b>2</b>3`  |  1<b>2</b>3  |
  *
  * This happens because whitespace is significant in inline elements.
  *
- * As a consequence of this, the formatter must format blocks that look like this (assume a small line width, <20): ```html <span>really long content</span> ``` as this, where the content hugs the tags: ```html <span >really long content</span > ```
+ * As a consequence of this, the formatter must format blocks that look like this (assume a small line width, <20):
+ * ```html
+ * <span>really long content</span>
+ * ```
+ * as this, where the content hugs the tags:
+ * ```html
+ * <span
+ * >really long content</span
+ * >
+ * ```
  *
  * Note that this is only necessary for inline elements. Block elements do not have this restriction.
  *
  * @schema WhitespaceSensitivity
  */
 export declare enum WhitespaceSensitivity {
-    /** css */
+    /** The formatter considers whitespace significant for elements that have an "inline" display style by default in
+  browser's user agent style sheets. (css) */
     CSS = "css",
-    /** strict */
+    /** Leading and trailing whitespace in content is considered significant for all elements.
+  
+  The formatter should leave at least one whitespace character if whitespace is present.
+  Otherwise, if there is no whitespace, it should not add any after `>` or before `<`. In other words, if there's no whitespace, the text content should hug the tags.
+  
+  Example of text hugging the tags:
+  ```html
+  <b
+      >content</b
+  >
+  ``` (strict) */
     STRICT = "strict",
-    /** ignore */
+    /** Whitespace is considered insignificant. The formatter is free to remove or add whitespace as it sees fit. (ignore) */
     IGNORE = "ignore"
 }
 /**
@@ -1766,9 +1840,9 @@ export declare enum ArrowParentheses {
  * @schema OperatorLinebreak
  */
 export declare enum OperatorLinebreak {
-    /** after */
+    /** The operator is placed after the expression (after) */
     AFTER = "after",
-    /** before */
+    /** The operator is placed before the expression (before) */
     BEFORE = "before"
 }
 /**
@@ -1790,11 +1864,11 @@ export declare enum Semicolons {
     AS_NEEDED = "asNeeded"
 }
 /**
- * Print trailing commas wherever possible in multi-line comma-separated syntactic structures.
+ * Print trailing commas wherever possible in multi-line comma-separated syntactic structures for JavaScript/TypeScript files.
  *
- * @schema TrailingCommas
+ * @schema JsTrailingCommas
  */
-export declare enum TrailingCommas {
+export declare enum JsTrailingCommas {
     /** all */
     ALL = "all",
     /** es5 */
@@ -1803,9 +1877,11 @@ export declare enum TrailingCommas {
     NONE = "none"
 }
 /**
- * @schema TrailingCommas2
+ * Print trailing commas wherever possible in multi-line comma-separated syntactic structures for JSON files.
+ *
+ * @schema JsonTrailingCommas
  */
-export declare enum TrailingCommas2 {
+export declare enum JsonTrailingCommas {
     /** none */
     NONE = "none",
     /** all */