@quentinhsu/biome-config 0.3.3 → 0.4.0

package/dist/types/src/generated/biome/no-comment-text-options.d.ts

@@ -0,0 +1,761 @@
+import type { ArrowParentheses, AttributePosition, Bool, BracketSameLine, BracketSpacing, Expand, IndentScriptAndStyle, IndentStyle, IndentWidth, JsTrailingCommas, JsonTrailingCommas, LineEnding, LineWidth, MaxSize, NegatablePredefinedSourceMatcher, NormalizedGlob, OperatorLinebreak, QuoteProperties, QuoteStyle, RuleAssistPlainConfiguration, RuleDomainValue, SelfCloseVoidElements, Semicolons, SortOrder, UseSortedPropertiesOptions, WhitespaceSensitivity } from './schema.ts';
+export interface NoCommentTextOptions {
+}
+export interface NoCompareNegZeroOptions {
+}
+export interface NoConfusingLabelsOptions {
+    /**
+     * A list of (non-confusing) labels that should be allowed
+     */
+    allowedLabels?: string[] | null;
+}
+export interface NoConfusingVoidTypeOptions {
+}
+export interface NoConsoleOptions {
+    /**
+     * Allowed calls on the console object.
+     */
+    allow?: string[] | null;
+}
+export interface NoConstEnumOptions {
+}
+export interface NoConstantBinaryExpressionsOptions {
+}
+export interface NoControlCharactersInRegexOptions {
+}
+export interface NoDebuggerOptions {
+}
+export interface NoDocumentCookieOptions {
+}
+export interface NoDocumentImportInPageOptions {
+}
+export interface NoDoubleEqualsOptions {
+    /**
+     * If `true`, an exception is made when comparing with `null`, as it's often relied on to check
+     * both for `null` or `undefined`.
+     *
+     * If `false`, no such exception will be made.
+     */
+    ignoreNull?: boolean | null;
+}
+export interface NoDuplicateAtImportRulesOptions {
+}
+export interface NoDuplicateCaseOptions {
+}
+export interface NoDuplicateClassMembersOptions {
+}
+export interface NoDuplicateCustomPropertiesOptions {
+}
+export interface NoDuplicateElseIfOptions {
+}
+export interface NoDuplicateFieldsOptions {
+}
+export interface NoDuplicateFontNamesOptions {
+}
+export interface NoDuplicateJsxPropsOptions {
+}
+export interface NoDuplicateObjectKeysOptions {
+}
+export interface NoDuplicateParametersOptions {
+}
+export interface NoDuplicatePropertiesOptions {
+}
+export interface NoDuplicateSelectorsKeyframeBlockOptions {
+}
+export interface NoDuplicateTestHooksOptions {
+}
+export interface NoEmptyBlockOptions {
+}
+export interface NoEmptyBlockStatementsOptions {
+}
+export interface NoEmptyInterfaceOptions {
+}
+export interface NoEvolvingTypesOptions {
+}
+export interface NoExplicitAnyOptions {
+}
+export interface NoExportsInTestOptions {
+}
+export interface NoExtraNonNullAssertionOptions {
+}
+export interface NoFallthroughSwitchClauseOptions {
+}
+export interface NoFocusedTestsOptions {
+}
+export interface NoFunctionAssignOptions {
+}
+export interface NoGlobalAssignOptions {
+}
+export interface NoGlobalIsFiniteOptions {
+}
+export interface NoGlobalIsNanOptions {
+}
+export interface NoHeadImportInDocumentOptions {
+}
+export interface NoImplicitAnyLetOptions {
+}
+export interface NoImportAssignOptions {
+}
+export interface NoImportantInKeyframeOptions {
+}
+export interface NoIrregularWhitespaceOptions {
+}
+export interface NoLabelVarOptions {
+}
+export interface NoMisleadingCharacterClassOptions {
+}
+export interface NoMisleadingInstantiatorOptions {
+}
+export interface NoMisplacedAssertionOptions {
+}
+export interface NoMisrefactoredShorthandAssignOptions {
+}
+export interface NoNonNullAssertedOptionalChainOptions {
+}
+export interface NoOctalEscapeOptions {
+}
+export interface NoPrototypeBuiltinsOptions {
+}
+export interface NoQuickfixBiomeOptions {
+    /**
+     * A list of additional JSON files that should be checked.
+     */
+    additionalPaths?: string[];
+}
+export interface NoReactSpecificPropsOptions {
+}
+export interface NoRedeclareOptions {
+}
+export interface NoRedundantUseStrictOptions {
+}
+export interface NoSelfCompareOptions {
+}
+export interface NoShadowRestrictedNamesOptions {
+}
+export interface NoShorthandPropertyOverridesOptions {
+}
+export interface NoSkippedTestsOptions {
+}
+export interface NoSparseArrayOptions {
+}
+export interface NoSuspiciousSemicolonInJsxOptions {
+}
+export interface NoTemplateCurlyInStringOptions {
+}
+export interface NoThenPropertyOptions {
+}
+export interface NoTsIgnoreOptions {
+}
+export interface NoUnassignedVariablesOptions {
+}
+export interface NoUnknownAtRulesOptions {
+    /**
+     * A list of unknown at-rule names to ignore (case-insensitive).
+     */
+    ignore?: string[];
+}
+export interface NoUnsafeDeclarationMergingOptions {
+}
+export interface NoUnsafeNegationOptions {
+}
+export interface NoUselessEscapeInStringOptions {
+}
+export interface NoUselessRegexBackrefsOptions {
+}
+export interface NoVarOptions {
+}
+export interface NoWithOptions {
+}
+export interface UseAdjacentOverloadSignaturesOptions {
+}
+export interface UseAwaitOptions {
+}
+export interface UseBiomeIgnoreFolderOptions {
+}
+export interface UseDefaultSwitchClauseLastOptions {
+}
+export interface UseErrorMessageOptions {
+}
+export interface UseGetterReturnOptions {
+}
+export interface UseGoogleFontDisplayOptions {
+}
+export interface UseGuardForInOptions {
+}
+export interface UseIsArrayOptions {
+}
+export interface UseIterableCallbackReturnOptions {
+}
+export interface UseNamespaceKeywordOptions {
+}
+export interface UseNumberToFixedDigitsArgumentOptions {
+}
+export interface UseStaticResponseMethodsOptions {
+}
+export interface UseStrictModeOptions {
+}
+export type Glob = string;
+export type PluginConfiguration = string;
+export type VcsClientKind = 'git';
+export type SourceMatcher = NegatablePredefinedSourceMatcher | string;
+export interface UseSortedAttributesOptions {
+    sortOrder?: SortOrder | null;
+}
+export interface UseSortedKeysOptions {
+    sortOrder?: SortOrder | null;
+}
+export interface RuleAssistWithUseSortedPropertiesOptions {
+    level: RuleAssistPlainConfiguration;
+    options: UseSortedPropertiesOptions;
+    [k: string]: unknown;
+}
+/**
+ * Options that changes how the CSS assist behaves
+ */
+export interface CssAssistConfiguration {
+    /**
+     * Control the assist for CSS files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that changes how the CSS linter behaves
+ */
+export interface CssLinterConfiguration {
+    /**
+     * Control the linter for CSS files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that changes how the CSS parser behaves
+ */
+export interface CssParserConfiguration {
+    /**
+     * Allow comments to appear on incorrect lines in `.css` files
+     */
+    allowWrongLineComments?: Bool | null;
+    /**
+     * Enables parsing of CSS Modules specific features.
+     */
+    cssModules?: Bool | null;
+    /**
+     * Enables parsing of Tailwind CSS 4.0 directives and functions.
+     */
+    tailwindDirectives?: Bool | null;
+}
+/**
+ * Options that changes how the GraphQL linter behaves
+ */
+export interface GraphqlAssistConfiguration {
+    /**
+     * Control the formatter for GraphQL files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that change how the GraphQL linter behaves.
+ */
+export interface GraphqlLinterConfiguration {
+    /**
+     * Control the formatter for GraphQL files.
+     */
+    enabled?: Bool | null;
+}
+export interface GritAssistConfiguration {
+    /**
+     * Control the assist functionality for Grit files.
+     */
+    enabled?: Bool | null;
+}
+export interface GritLinterConfiguration {
+    /**
+     * Control the linter for Grit files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that changes how the HTML assist behaves
+ */
+export interface HtmlAssistConfiguration {
+    /**
+     * Control the assist for HTML (and its super languages) files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that changes how the HTML linter behaves
+ */
+export interface HtmlLinterConfiguration {
+    /**
+     * Control the linter for HTML (and its super languages) files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that changes how the HTML parser behaves
+ */
+export interface HtmlParserConfiguration {
+    /**
+     * Enables the parsing of double text expressions such as `{{ expression }}` inside `.html` files
+     */
+    interpolation?: Bool | null;
+}
+/**
+ * Assist options specific to the JavaScript assist
+ */
+export interface JsAssistConfiguration {
+    /**
+     * Control the assist for JavaScript (and its super languages) files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Linter options specific to the JavaScript linter
+ */
+export interface JsLinterConfiguration {
+    /**
+     * Control the linter for JavaScript (and its super languages) files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that changes how the JavaScript parser behaves
+ */
+export interface JsParserConfiguration {
+    /**
+     * Enables parsing of Grit metavariables.
+     * Defaults to `false`.
+     */
+    gritMetavariables?: Bool | null;
+    /**
+     * When enabled, files like `.js`/`.mjs`/`.cjs` may contain JSX syntax.
+     *
+     * Defaults to `true`.
+     */
+    jsxEverywhere?: Bool | null;
+    /**
+     * It enables the experimental and unsafe parsing of parameter decorators
+     *
+     * These decorators belong to an old proposal, and they are subject to change.
+     */
+    unsafeParameterDecoratorsEnabled?: Bool | null;
+}
+/**
+ * Assist options specific to the JSON linter
+ */
+export interface JsonAssistConfiguration {
+    /**
+     * Control the assist for JSON (and its super languages) files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Linter options specific to the JSON linter
+ */
+export interface JsonLinterConfiguration {
+    /**
+     * Control the linter for JSON (and its super languages) files.
+     */
+    enabled?: Bool | null;
+}
+/**
+ * Options that changes how the JSON parser behaves
+ */
+export interface JsonParserConfiguration {
+    /**
+     * Allow parsing comments in `.json` files
+     */
+    allowComments?: Bool | null;
+    /**
+     * Allow parsing trailing commas in `.json` files
+     */
+    allowTrailingCommas?: Bool | null;
+}
+export interface GritFormatterConfiguration {
+    /**
+     * Control the formatter for Grit files.
+     */
+    enabled?: Bool | null;
+    /**
+     * The indent style applied to Grit files.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation applied to Grit files. Default to 2.
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of line ending applied to Grit files.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line applied to Grit files. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+}
+/**
+ * Options that changes how the CSS formatter behaves
+ */
+export interface CssFormatterConfiguration {
+    /**
+     * Control the formatter for CSS (and its super languages) files.
+     */
+    enabled?: Bool | null;
+    /**
+     * The indent style applied to CSS (and its super languages) files.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation applied to CSS (and its super languages) files. Default to 2.
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of line ending applied to CSS (and its super languages) files. `auto` uses CRLF on Windows and LF on other platforms.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line applied to CSS (and its super languages) files. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+    /**
+     * The type of quotes used in CSS code. Defaults to double.
+     */
+    quoteStyle?: QuoteStyle | null;
+}
+/**
+ * The configuration of the filesystem
+ */
+export interface FilesConfiguration {
+    /**
+     * **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.
+     */
+    experimentalScannerIgnores?: string[] | null;
+    /**
+     * Tells Biome to not emit diagnostics when handling files that it doesn't know
+     */
+    ignoreUnknown?: Bool | null;
+    /**
+     * A list of glob patterns. Biome will handle only those files/folders that will
+     * match these patterns.
+     */
+    includes?: NormalizedGlob[] | null;
+    /**
+     * The maximum allowed size for source code files in bytes. Files above
+     * this limit will be ignored for performance reasons. Defaults to 1 MiB
+     */
+    maxSize?: MaxSize | null;
+}
+export interface OverrideFilesConfiguration {
+    /**
+     * File size limit in bytes
+     */
+    maxSize?: MaxSize | null;
+}
+/**
+ * Options that changes how the GraphQL formatter behaves
+ */
+export interface GraphqlFormatterConfiguration {
+    /**
+     * Whether to insert spaces around brackets in object literals. Defaults to true.
+     */
+    bracketSpacing?: BracketSpacing | null;
+    /**
+     * Control the formatter for GraphQL files.
+     */
+    enabled?: Bool | null;
+    /**
+     * The indent style applied to GraphQL files.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation applied to GraphQL files. Default to 2.
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of line ending applied to GraphQL files. `auto` uses CRLF on Windows and LF on other platforms.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line applied to GraphQL files. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+    /**
+     * The type of quotes used in GraphQL code. Defaults to double.
+     */
+    quoteStyle?: QuoteStyle | null;
+}
+/**
+ * Generic options applied to all files
+ */
+export interface FormatterConfiguration {
+    /**
+     * The attribute position style in HTML-ish languages. Defaults to auto.
+     */
+    attributePosition?: AttributePosition | null;
+    /**
+     * Put the `>` of a multi-line HTML or JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
+     */
+    bracketSameLine?: BracketSameLine | null;
+    /**
+     * Whether to insert spaces around brackets in object literals. Defaults to true.
+     */
+    bracketSpacing?: BracketSpacing | null;
+    enabled?: Bool | null;
+    /**
+     * 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".
+     */
+    expand?: Expand | null;
+    /**
+     * Whether formatting should be allowed to proceed if a given file
+     * has syntax errors
+     */
+    formatWithErrors?: Bool | null;
+    /**
+     * A list of glob patterns. The formatter will include files/folders that will
+     * match these patterns.
+     */
+    includes?: NormalizedGlob[] | null;
+    /**
+     * The indent style.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation, 2 by default
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of line ending.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+    /**
+     * Use any `.editorconfig` files to configure the formatter. Configuration
+     * in `biome.json` will override `.editorconfig` configuration.
+     *
+     * Default: `true`.
+     */
+    useEditorconfig?: Bool | null;
+}
+export interface OverrideFormatterConfiguration {
+    /**
+     * The attribute position style.
+     */
+    attributePosition?: AttributePosition | null;
+    /**
+     * Put the `>` of a multi-line HTML or JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
+     */
+    bracketSameLine?: BracketSameLine | null;
+    /**
+     * Whether to insert spaces around brackets in object literals. Defaults to true.
+     */
+    bracketSpacing?: BracketSpacing | null;
+    enabled?: Bool | null;
+    /**
+     * 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".
+     */
+    expand?: Expand | null;
+    /**
+     * Stores whether formatting should be allowed to proceed if a given file
+     * has syntax errors
+     */
+    formatWithErrors?: Bool | null;
+    /**
+     * The size of the indentation, 2 by default (deprecated, use `indent-width`)
+     */
+    indentSize?: IndentWidth | null;
+    /**
+     * The indent style.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation, 2 by default
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of line ending.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+}
+/**
+ * Options that changes how the HTML formatter behaves
+ */
+export interface HtmlFormatterConfiguration {
+    /**
+     * The attribute position style in HTML elements. Defaults to auto.
+     */
+    attributePosition?: AttributePosition | null;
+    /**
+     * Whether to hug the closing bracket of multiline HTML tags to the end of the last line, rather than being alone on the following line. Defaults to false.
+     */
+    bracketSameLine?: BracketSameLine | null;
+    /**
+     * Control the formatter for HTML (and its super languages) files.
+     */
+    enabled?: Bool | null;
+    /**
+     * Whether to indent the `<script>` and `<style>` tags for HTML (and its super languages). Defaults to false.
+     */
+    indentScriptAndStyle?: IndentScriptAndStyle | null;
+    /**
+     * The indent style applied to HTML (and its super languages) files.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation applied to HTML (and its super languages) files. Default to 2.
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of line ending applied to HTML (and its super languages) files. `auto` uses CRLF on Windows and LF on other platforms.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line applied to HTML (and its super languages) files. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+    /**
+     * Whether void elements should be self-closed. Defaults to never.
+     */
+    selfCloseVoidElements?: SelfCloseVoidElements | null;
+    /**
+     * Whether to account for whitespace sensitivity when formatting HTML (and its super languages). Defaults to "css".
+     */
+    whitespaceSensitivity?: WhitespaceSensitivity | null;
+}
+/**
+ * Formatting options specific to the JavaScript files
+ */
+export interface JsFormatterConfiguration {
+    /**
+     * Whether to add non-necessary parentheses to arrow functions. Defaults to "always".
+     */
+    arrowParentheses?: ArrowParentheses | null;
+    /**
+     * The attribute position style in JSX elements. Defaults to auto.
+     */
+    attributePosition?: AttributePosition | null;
+    /**
+     * Whether to hug the closing bracket of multiline HTML/JSX tags to the end of the last line, rather than being alone on the following line. Defaults to false.
+     */
+    bracketSameLine?: BracketSameLine | null;
+    /**
+     * Whether to insert spaces around brackets in object literals. Defaults to true.
+     */
+    bracketSpacing?: BracketSpacing | null;
+    /**
+     * Control the formatter for JavaScript (and its super languages) files.
+     */
+    enabled?: Bool | null;
+    /**
+     * 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".
+     */
+    expand?: Expand | null;
+    /**
+     * The indent style applied to JavaScript (and its super languages) files.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation applied to JavaScript (and its super languages) files. Default to 2.
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of quotes used in JSX. Defaults to double.
+     */
+    jsxQuoteStyle?: QuoteStyle | null;
+    /**
+     * The type of line ending applied to JavaScript (and its super languages) files. `auto` uses CRLF on Windows and LF on other platforms.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line applied to JavaScript (and its super languages) files. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+    /**
+     * When breaking binary expressions into multiple lines, whether to break them before or after the binary operator. Defaults to "after".
+     */
+    operatorLinebreak?: OperatorLinebreak | null;
+    /**
+     * When properties in objects are quoted. Defaults to asNeeded.
+     */
+    quoteProperties?: QuoteProperties | null;
+    /**
+     * The type of quotes used in JavaScript code. Defaults to double.
+     */
+    quoteStyle?: QuoteStyle | null;
+    /**
+     * Whether the formatter prints semicolons for all statements or only in for statements where it is necessary because of ASI.
+     */
+    semicolons?: Semicolons | null;
+    /**
+     * Print trailing commas wherever possible in multi-line comma-separated syntactic structures. Defaults to "all".
+     */
+    trailingCommas?: JsTrailingCommas | null;
+}
+export interface JsonFormatterConfiguration {
+    /**
+     * Whether to insert spaces around brackets in object literals. Defaults to true.
+     */
+    bracketSpacing?: BracketSpacing | null;
+    /**
+     * Control the formatter for JSON (and its super languages) files.
+     */
+    enabled?: Bool | null;
+    /**
+     * 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".
+     */
+    expand?: Expand | null;
+    /**
+     * The indent style applied to JSON (and its super languages) files.
+     */
+    indentStyle?: IndentStyle | null;
+    /**
+     * The size of the indentation applied to JSON (and its super languages) files. Default to 2.
+     */
+    indentWidth?: IndentWidth | null;
+    /**
+     * The type of line ending applied to JSON (and its super languages) files. `auto` uses CRLF on Windows and LF on other platforms.
+     */
+    lineEnding?: LineEnding | null;
+    /**
+     * What's the max width of a line applied to JSON (and its super languages) files. Defaults to 80.
+     */
+    lineWidth?: LineWidth | null;
+    /**
+     * Print trailing commas wherever possible in multi-line comma-separated syntactic structures. Defaults to "none".
+     */
+    trailingCommas?: JsonTrailingCommas | null;
+}
+export interface RuleDomains {
+    [k: string]: RuleDomainValue;
+}