`javascript.biome.biome_config` Submodule

Protocols

IA11y

Implemented By: projen.javascript.biome.biome_config.IA11y

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noAccessKey`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that the accessKey attribute is not used on any HTML element.
`noAriaHiddenOnFocusable`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that aria-hidden="true" is not set on focusable elements.
`noAriaUnsupportedElements`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that elements that do not support ARIA roles, states, and properties do not have those attributes.
`noAutofocus`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that autoFocus prop is not used on elements.
`noBlankTarget`	`string \| projen.javascript.biome.biome_config.IRuleWithAllowDomainOptions`	Disallow target="_blank" attribute without rel="noreferrer".
`noDistractingElements`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforces that no distracting elements are used.
`noHeaderScope`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	The scope prop should be used only on <th> elements.
`noInteractiveElementToNoninteractiveRole`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that non-interactive ARIA roles are not assigned to interactive HTML elements.
`noLabelWithoutControl`	`string \| projen.javascript.biome.biome_config.IRuleWithNoLabelWithoutControlOptions`	Enforce that a label element or component has a text label and an associated input.
`noNoninteractiveElementToInteractiveRole`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that interactive ARIA roles are not assigned to non-interactive HTML elements.
`noNoninteractiveTabindex`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that tabIndex is not assigned to non-interactive HTML elements.
`noPositiveTabindex`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prevent the usage of positive integers on tabIndex property.
`noRedundantAlt`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce img alt prop does not contain the word "image", "picture", or "photo".
`noRedundantRoles`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce explicit role property is not the same as implicit/default role property on an element.
`noSvgWithoutTitle`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforces the usage of the title element for the svg element.
`recommended`	`boolean`	It enables the recommended rules for this group.
`useAltText`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that all elements that require alternative text have meaningful information to relay back to the end user.
`useAnchorContent`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that anchors have content and that the content is accessible to screen readers.
`useAriaActivedescendantWithTabindex`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce that tabIndex is assigned to non-interactive HTML elements with aria-activedescendant.
`useAriaPropsForRole`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that elements with ARIA roles must have all required ARIA attributes for that role.
`useButtonType`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforces the usage of the attribute type for the element button.
`useFocusableInteractive`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Elements with an interactive role and interaction handlers must be focusable.
`useGenericFontNames`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow a missing generic family keyword within font families.
`useHeadingContent`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that heading elements (h1, h2, etc.) have content and that the content is accessible to screen readers. Accessible means that it is not hidden using the aria-hidden prop.
`useHtmlLang`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that html element has lang attribute.
`useIframeTitle`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforces the usage of the attribute title for the element iframe.
`useKeyWithClickEvents`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce onClick is accompanied by at least one of the following: onKeyUp, onKeyDown, onKeyPress.
`useKeyWithMouseEvents`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce onMouseOver / onMouseOut are accompanied by onFocus / onBlur.
`useMediaCaption`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforces that audio and video elements must have a track for captions.
`useSemanticElements`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	It detects the use of role attributes in JSX elements and suggests using semantic elements instead.
`useValidAnchor`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that all anchors are valid, and they are navigable elements.
`useValidAriaProps`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Ensures that ARIA properties aria-* are all valid.
`useValidAriaRole`	`string \| projen.javascript.biome.biome_config.IRuleWithValidAriaRoleOptions`	Elements with ARIA roles must use a valid, non-abstract ARIA role.
`useValidAriaValues`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that ARIA state and property values are valid.
`useValidLang`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Ensure that the attribute passed to the lang attribute is a correct ISO language and/or country.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noAccessKey`^Optional

public readonly noAccessKey: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that the accessKey attribute is not used on any HTML element.

`noAriaHiddenOnFocusable`^Optional

public readonly noAriaHiddenOnFocusable: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that aria-hidden="true" is not set on focusable elements.

`noAriaUnsupportedElements`^Optional

public readonly noAriaUnsupportedElements: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that elements that do not support ARIA roles, states, and properties do not have those attributes.

`noAutofocus`^Optional

public readonly noAutofocus: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that autoFocus prop is not used on elements.

`noBlankTarget`^Optional

public readonly noBlankTarget: string | IRuleWithAllowDomainOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithAllowDomainOptions

Disallow target="_blank" attribute without rel="noreferrer".

`noDistractingElements`^Optional

public readonly noDistractingElements: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforces that no distracting elements are used.

`noHeaderScope`^Optional

public readonly noHeaderScope: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

The scope prop should be used only on <th> elements.

`noInteractiveElementToNoninteractiveRole`^Optional

public readonly noInteractiveElementToNoninteractiveRole: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that non-interactive ARIA roles are not assigned to interactive HTML elements.

`noLabelWithoutControl`^Optional

public readonly noLabelWithoutControl: string | IRuleWithNoLabelWithoutControlOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoLabelWithoutControlOptions

Enforce that a label element or component has a text label and an associated input.

`noNoninteractiveElementToInteractiveRole`^Optional

public readonly noNoninteractiveElementToInteractiveRole: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that interactive ARIA roles are not assigned to non-interactive HTML elements.

`noNoninteractiveTabindex`^Optional

public readonly noNoninteractiveTabindex: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that tabIndex is not assigned to non-interactive HTML elements.

`noPositiveTabindex`^Optional

public readonly noPositiveTabindex: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prevent the usage of positive integers on tabIndex property.

`noRedundantAlt`^Optional

public readonly noRedundantAlt: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce img alt prop does not contain the word "image", "picture", or "photo".

`noRedundantRoles`^Optional

public readonly noRedundantRoles: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce explicit role property is not the same as implicit/default role property on an element.

`noSvgWithoutTitle`^Optional

public readonly noSvgWithoutTitle: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforces the usage of the title element for the svg element.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

`useAltText`^Optional

public readonly useAltText: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that all elements that require alternative text have meaningful information to relay back to the end user.

`useAnchorContent`^Optional

public readonly useAnchorContent: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that anchors have content and that the content is accessible to screen readers.

`useAriaActivedescendantWithTabindex`^Optional

public readonly useAriaActivedescendantWithTabindex: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce that tabIndex is assigned to non-interactive HTML elements with aria-activedescendant.

`useAriaPropsForRole`^Optional

public readonly useAriaPropsForRole: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that elements with ARIA roles must have all required ARIA attributes for that role.

`useButtonType`^Optional

public readonly useButtonType: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforces the usage of the attribute type for the element button.

`useFocusableInteractive`^Optional

public readonly useFocusableInteractive: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Elements with an interactive role and interaction handlers must be focusable.

`useGenericFontNames`^Optional

public readonly useGenericFontNames: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow a missing generic family keyword within font families.

`useHeadingContent`^Optional

public readonly useHeadingContent: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that heading elements (h1, h2, etc.) have content and that the content is accessible to screen readers. Accessible means that it is not hidden using the aria-hidden prop.

`useHtmlLang`^Optional

public readonly useHtmlLang: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that html element has lang attribute.

`useIframeTitle`^Optional

public readonly useIframeTitle: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforces the usage of the attribute title for the element iframe.

`useKeyWithClickEvents`^Optional

public readonly useKeyWithClickEvents: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce onClick is accompanied by at least one of the following: onKeyUp, onKeyDown, onKeyPress.

`useKeyWithMouseEvents`^Optional

public readonly useKeyWithMouseEvents: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce onMouseOver / onMouseOut are accompanied by onFocus / onBlur.

`useMediaCaption`^Optional

public readonly useMediaCaption: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforces that audio and video elements must have a track for captions.

`useSemanticElements`^Optional

public readonly useSemanticElements: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

It detects the use of role attributes in JSX elements and suggests using semantic elements instead.

`useValidAnchor`^Optional

public readonly useValidAnchor: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that all anchors are valid, and they are navigable elements.

`useValidAriaProps`^Optional

public readonly useValidAriaProps: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Ensures that ARIA properties aria-* are all valid.

`useValidAriaRole`^Optional

public readonly useValidAriaRole: string | IRuleWithValidAriaRoleOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithValidAriaRoleOptions

Elements with ARIA roles must use a valid, non-abstract ARIA role.

`useValidAriaValues`^Optional

public readonly useValidAriaValues: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that ARIA state and property values are valid.

`useValidLang`^Optional

public readonly useValidLang: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Ensure that the attribute passed to the lang attribute is a correct ISO language and/or country.

IActions

Implemented By: projen.javascript.biome.biome_config.IActions

Properties

Name	Type	Description
`source`	`projen.javascript.biome.biome_config.ISource`	No description.

`source`^Optional

public readonly source: ISource;

Type: projen.javascript.biome.biome_config.ISource

IAllowDomainOptions

Implemented By: projen.javascript.biome.biome_config.IAllowDomainOptions

Properties

Name	Type	Description
`allowDomains`	`string[]`	List of domains to allow `target="_blank"` without `rel="noreferrer"`.

`allowDomains`^Optional

public readonly allowDomains: string[];

Type: string[]

List of domains to allow target="_blank" without rel="noreferrer".

IAssistsConfiguration

Implemented By: projen.javascript.biome.biome_config.IAssistsConfiguration

Properties

Name	Type	Description
`actions`	`projen.javascript.biome.biome_config.IActions`	Whether Biome should fail in CLI if the assists were not applied to the code.
`enabled`	`boolean`	Whether Biome should enable assists via LSP.
`ignore`	`string[]`	A list of Unix shell style patterns.
`include`	`string[]`	A list of Unix shell style patterns.

`actions`^Optional

public readonly actions: IActions;

Type: projen.javascript.biome.biome_config.IActions

Whether Biome should fail in CLI if the assists were not applied to the code.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Whether Biome should enable assists via LSP.

`ignore`^Optional

public readonly ignore: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will ignore files/folders that will match these patterns.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will include files/folders that will match these patterns.

IComplexity

Implemented By: projen.javascript.biome.biome_config.IComplexity

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noBannedTypes`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow primitive type aliases and misleading types.
`noEmptyTypeParameters`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow empty type parameters in type aliases and interfaces.
`noExcessiveCognitiveComplexity`	`string \| projen.javascript.biome.biome_config.IRuleWithComplexityOptions`	Disallow functions that exceed a given Cognitive Complexity score.
`noExcessiveNestedTestSuites`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	This rule enforces a maximum depth to nested describe() in test files.
`noExtraBooleanCast`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary boolean casts.
`noForEach`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prefer for...of statement instead of Array.forEach.
`noMultipleSpacesInRegularExpressionLiterals`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unclear usage of consecutive space characters in regular expression literals.
`noStaticOnlyClass`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	This rule reports when a class has no non-static members, such as for a class used exclusively as a static namespace.
`noThisInStatic`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow this and super in static contexts.
`noUselessCatch`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary catch clauses.
`noUselessConstructor`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary constructors.
`noUselessEmptyExport`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow empty exports that don't change anything in a module file.
`noUselessFragments`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary fragments.
`noUselessLabel`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary labels.
`noUselessLoneBlockStatements`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary nested block statements.
`noUselessRename`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow renaming import, export, and destructured assignments to the same name.
`noUselessStringConcat`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary concatenation of string or template literals.
`noUselessSwitchCase`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow useless case in switch statements.
`noUselessTernary`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow ternary operators when simpler alternatives exist.
`noUselessThisAlias`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow useless this aliasing.
`noUselessTypeConstraint`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow using any or unknown as type constraint.
`noUselessUndefinedInitialization`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow initializing variables to undefined.
`noVoid`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of void operators, which is not a familiar operator.
`noWith`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow with statements in non-strict contexts.
`recommended`	`boolean`	It enables the recommended rules for this group.
`useArrowFunction`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use arrow functions over function expressions.
`useDateNow`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use Date.now() to get the number of milliseconds since the Unix Epoch.
`useFlatMap`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Promotes the use of .flatMap() when map().flat() are used together.
`useLiteralKeys`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the usage of a literal access to properties over computed property access.
`useOptionalChain`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce using concise optional chain instead of chained logical expressions.
`useRegexLiterals`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the use of the regular expression literals instead of the RegExp constructor if possible.
`useSimpleNumberKeys`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow number literal object member names which are not base10 or uses underscore as separator.
`useSimplifiedLogicExpression`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Discard redundant terms from logical expressions.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noBannedTypes`^Optional

public readonly noBannedTypes: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow primitive type aliases and misleading types.

`noEmptyTypeParameters`^Optional

public readonly noEmptyTypeParameters: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow empty type parameters in type aliases and interfaces.

`noExcessiveCognitiveComplexity`^Optional

public readonly noExcessiveCognitiveComplexity: string | IRuleWithComplexityOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithComplexityOptions

Disallow functions that exceed a given Cognitive Complexity score.

`noExcessiveNestedTestSuites`^Optional

public readonly noExcessiveNestedTestSuites: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

This rule enforces a maximum depth to nested describe() in test files.

`noExtraBooleanCast`^Optional

public readonly noExtraBooleanCast: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary boolean casts.

`noForEach`^Optional

public readonly noForEach: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prefer for...of statement instead of Array.forEach.

`noMultipleSpacesInRegularExpressionLiterals`^Optional

public readonly noMultipleSpacesInRegularExpressionLiterals: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unclear usage of consecutive space characters in regular expression literals.

`noStaticOnlyClass`^Optional

public readonly noStaticOnlyClass: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

This rule reports when a class has no non-static members, such as for a class used exclusively as a static namespace.

`noThisInStatic`^Optional

public readonly noThisInStatic: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow this and super in static contexts.

`noUselessCatch`^Optional

public readonly noUselessCatch: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary catch clauses.

`noUselessConstructor`^Optional

public readonly noUselessConstructor: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary constructors.

`noUselessEmptyExport`^Optional

public readonly noUselessEmptyExport: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow empty exports that don't change anything in a module file.

`noUselessFragments`^Optional

public readonly noUselessFragments: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary fragments.

`noUselessLabel`^Optional

public readonly noUselessLabel: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary labels.

`noUselessLoneBlockStatements`^Optional

public readonly noUselessLoneBlockStatements: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary nested block statements.

`noUselessRename`^Optional

public readonly noUselessRename: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow renaming import, export, and destructured assignments to the same name.

`noUselessStringConcat`^Optional

public readonly noUselessStringConcat: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary concatenation of string or template literals.

`noUselessSwitchCase`^Optional

public readonly noUselessSwitchCase: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow useless case in switch statements.

`noUselessTernary`^Optional

public readonly noUselessTernary: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow ternary operators when simpler alternatives exist.

`noUselessThisAlias`^Optional

public readonly noUselessThisAlias: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow useless this aliasing.

`noUselessTypeConstraint`^Optional

public readonly noUselessTypeConstraint: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow using any or unknown as type constraint.

`noUselessUndefinedInitialization`^Optional

public readonly noUselessUndefinedInitialization: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow initializing variables to undefined.

`noVoid`^Optional

public readonly noVoid: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of void operators, which is not a familiar operator.

`noWith`^Optional

public readonly noWith: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow with statements in non-strict contexts.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

`useArrowFunction`^Optional

public readonly useArrowFunction: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use arrow functions over function expressions.

`useDateNow`^Optional

public readonly useDateNow: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use Date.now() to get the number of milliseconds since the Unix Epoch.

`useFlatMap`^Optional

public readonly useFlatMap: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Promotes the use of .flatMap() when map().flat() are used together.

`useLiteralKeys`^Optional

public readonly useLiteralKeys: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the usage of a literal access to properties over computed property access.

`useOptionalChain`^Optional

public readonly useOptionalChain: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce using concise optional chain instead of chained logical expressions.

`useRegexLiterals`^Optional

public readonly useRegexLiterals: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the use of the regular expression literals instead of the RegExp constructor if possible.

`useSimpleNumberKeys`^Optional

public readonly useSimpleNumberKeys: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow number literal object member names which are not base10 or uses underscore as separator.

`useSimplifiedLogicExpression`^Optional

public readonly useSimplifiedLogicExpression: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Discard redundant terms from logical expressions.

IComplexityOptions

Implemented By: projen.javascript.biome.biome_config.IComplexityOptions

Options for the rule noExcessiveCognitiveComplexity.

Properties

Name	Type	Description
`maxAllowedComplexity`	`number`	The maximum complexity score that we allow.

`maxAllowedComplexity`^Optional

public readonly maxAllowedComplexity: number;

Type: number

The maximum complexity score that we allow.

Anything higher is considered excessive.

IConfiguration

Implemented By: projen.javascript.biome.biome_config.IConfiguration

The configuration that is contained inside the file biome.json.

Properties

Name	Type	Description
`assists`	`projen.javascript.biome.biome_config.IAssistsConfiguration`	Specific configuration for assists.
`css`	`projen.javascript.biome.biome_config.ICssConfiguration`	Specific configuration for the Css language.
`extends`	`string[]`	A list of paths to other JSON files, used to extends the current configuration.
`files`	`projen.javascript.biome.biome_config.IFilesConfiguration`	The configuration of the filesystem.
`formatter`	`projen.javascript.biome.biome_config.IFormatterConfiguration`	The configuration of the formatter.
`graphql`	`projen.javascript.biome.biome_config.IGraphqlConfiguration`	Specific configuration for the GraphQL language.
`javascript`	`projen.javascript.biome.biome_config.IJavascriptConfiguration`	Specific configuration for the JavaScript language.
`json`	`projen.javascript.biome.biome_config.IJsonConfiguration`	Specific configuration for the Json language.
`linter`	`projen.javascript.biome.biome_config.ILinterConfiguration`	The configuration for the linter.
`organizeImports`	`projen.javascript.biome.biome_config.IOrganizeImports`	The configuration of the import sorting.
`overrides`	`projen.javascript.biome.biome_config.IOverridePattern[]`	A list of granular patterns that should be applied only to a sub set of files.
`vcs`	`projen.javascript.biome.biome_config.IVcsConfiguration`	The configuration of the VCS integration.

`assists`^Optional

public readonly assists: IAssistsConfiguration;

Type: projen.javascript.biome.biome_config.IAssistsConfiguration

Specific configuration for assists.

`css`^Optional

public readonly css: ICssConfiguration;

Type: projen.javascript.biome.biome_config.ICssConfiguration

Specific configuration for the Css language.

`extends`^Optional

public readonly extends: string[];

Type: string[]

A list of paths to other JSON files, used to extends the current configuration.

`files`^Optional

public readonly files: IFilesConfiguration;

Type: projen.javascript.biome.biome_config.IFilesConfiguration

The configuration of the filesystem.

`formatter`^Optional

public readonly formatter: IFormatterConfiguration;

Type: projen.javascript.biome.biome_config.IFormatterConfiguration

The configuration of the formatter.

`graphql`^Optional

public readonly graphql: IGraphqlConfiguration;

Type: projen.javascript.biome.biome_config.IGraphqlConfiguration

Specific configuration for the GraphQL language.

`javascript`^Optional

public readonly javascript: IJavascriptConfiguration;

Type: projen.javascript.biome.biome_config.IJavascriptConfiguration

Specific configuration for the JavaScript language.

`json`^Optional

public readonly json: IJsonConfiguration;

Type: projen.javascript.biome.biome_config.IJsonConfiguration

Specific configuration for the Json language.

`linter`^Optional

public readonly linter: ILinterConfiguration;

Type: projen.javascript.biome.biome_config.ILinterConfiguration

The configuration for the linter.

`organizeImports`^Optional

public readonly organizeImports: IOrganizeImports;

Type: projen.javascript.biome.biome_config.IOrganizeImports

The configuration of the import sorting.

`overrides`^Optional

public readonly overrides: IOverridePattern[];

Type: projen.javascript.biome.biome_config.IOverridePattern[]

A list of granular patterns that should be applied only to a sub set of files.

`vcs`^Optional

public readonly vcs: IVcsConfiguration;

Type: projen.javascript.biome.biome_config.IVcsConfiguration

The configuration of the VCS integration.

IConsistentArrayTypeOptions

Implemented By: projen.javascript.biome.biome_config.IConsistentArrayTypeOptions

Properties

Name	Type	Description
`syntax`	`string`	No description.

`syntax`^Optional

public readonly syntax: string;

Type: string

IConsistentMemberAccessibilityOptions

Implemented By: projen.javascript.biome.biome_config.IConsistentMemberAccessibilityOptions

Properties

Name	Type	Description
`accessibility`	`string`	No description.

`accessibility`^Optional

public readonly accessibility: string;

Type: string

IConvention

Implemented By: projen.javascript.biome.biome_config.IConvention

Properties

Name	Type	Description
`formats`	`string[]`	String cases to enforce.
`match`	`string`	Regular expression to enforce.
`selector`	`projen.javascript.biome.biome_config.ISelector`	Declarations concerned by this convention.

`formats`^Optional

public readonly formats: string[];

Type: string[]

String cases to enforce.

`match`^Optional

public readonly match: string;

Type: string

Regular expression to enforce.

`selector`^Optional

public readonly selector: ISelector;

Type: projen.javascript.biome.biome_config.ISelector

Declarations concerned by this convention.

ICorrectness

Implemented By: projen.javascript.biome.biome_config.ICorrectness

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noChildrenProp`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevent passing of children as props.
`noConstantCondition`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow constant expressions in conditions.
`noConstantMathMinMaxClamp`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of Math.min and Math.max to clamp a value where the result itself is constant.
`noConstAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prevents from having const variables being re-assigned.
`noConstructorReturn`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow returning a value from a constructor.
`noEmptyCharacterClassInRegex`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow empty character classes in regular expression literals.
`noEmptyPattern`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallows empty destructuring patterns.
`noFlatMapIdentity`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow to use unnecessary callback on flatMap.
`noGlobalObjectCalls`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow calling global object properties as functions.
`noInnerDeclarations`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow function and var declarations that are accessible outside their block.
`noInvalidBuiltinInstantiation`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Ensure that builtins are correctly instantiated.
`noInvalidConstructorSuper`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevents the incorrect use of super() inside classes.
`noInvalidDirectionInLinearGradient`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow non-standard direction values for linear gradient functions.
`noInvalidGridAreas`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallows invalid named grid areas in CSS Grid Layouts.
`noInvalidNewBuiltin`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow new operators with global non-constructor functions.
`noInvalidPositionAtImportRule`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of.
`noInvalidUseBeforeDeclaration`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of variables and function parameters before their declaration.
`noNewSymbol`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow new operators with the Symbol object.
`noNodejsModules`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Forbid the use of Node.js builtin modules.
`noNonoctalDecimalEscape`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow \8 and \9 escape sequences in string literals.
`noPrecisionLoss`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow literal numbers that lose precision.
`noRenderReturnValue`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevent the usage of the return value of React.render.
`noSelfAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow assignments where both sides are exactly the same.
`noSetterReturn`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow returning a value from a setter.
`noStringCaseMismatch`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow comparison of expressions modifying the string case with non-compliant value.
`noSwitchDeclarations`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow lexical declarations in switch clauses.
`noUndeclaredDependencies`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of dependencies that aren't specified in the package.json.
`noUndeclaredVariables`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevents the usage of variables that haven't been declared inside the document.
`noUnknownFunction`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unknown CSS value functions.
`noUnknownMediaFeatureName`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unknown media feature names.
`noUnknownProperty`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unknown properties.
`noUnknownUnit`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unknown CSS units.
`noUnmatchableAnbSelector`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unmatchable An+B selectors.
`noUnnecessaryContinue`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Avoid using unnecessary continue.
`noUnreachable`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unreachable code.
`noUnreachableSuper`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Ensures the super() constructor is called exactly once on every code path in a class constructor before this is accessed if the class has a superclass.
`noUnsafeFinally`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow control flow statements in finally blocks.
`noUnsafeOptionalChaining`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of optional chaining in contexts where the undefined value is not allowed.
`noUnusedFunctionParameters`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unused function parameters.
`noUnusedImports`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unused imports.
`noUnusedLabels`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unused labels.
`noUnusedPrivateClassMembers`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unused private class members.
`noUnusedVariables`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unused variables.
`noVoidElementsWithChildren`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	This rules prevents void elements (AKA self-closing elements) from having children.
`noVoidTypeReturn`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow returning a value from a function with the return type 'void'.
`recommended`	`boolean`	It enables the recommended rules for this group.
`useArrayLiterals`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow Array constructors.
`useExhaustiveDependencies`	`string \| projen.javascript.biome.biome_config.IRuleWithUseExhaustiveDependenciesOptions`	Enforce all dependencies are correctly specified in a React hook.
`useHookAtTopLevel`	`string \| projen.javascript.biome.biome_config.IRuleWithDeprecatedHooksOptions`	Enforce that all React hooks are being called from the Top Level component functions.
`useImportExtensions`	`string \| projen.javascript.biome.biome_config.IRuleWithUseImportExtensionsOptions`	Enforce file extensions for relative imports.
`useIsNan`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Require calls to isNaN() when checking for NaN.
`useJsxKeyInIterable`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow missing key props in iterators/collection literals.
`useValidForDirection`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce "for" loop update clause moving the counter in the right direction.
`useYield`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Require generator functions to contain yield.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noChildrenProp`^Optional

public readonly noChildrenProp: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevent passing of children as props.

`noConstantCondition`^Optional

public readonly noConstantCondition: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow constant expressions in conditions.

`noConstantMathMinMaxClamp`^Optional

public readonly noConstantMathMinMaxClamp: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of Math.min and Math.max to clamp a value where the result itself is constant.

`noConstAssign`^Optional

public readonly noConstAssign: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prevents from having const variables being re-assigned.

`noConstructorReturn`^Optional

public readonly noConstructorReturn: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow returning a value from a constructor.

`noEmptyCharacterClassInRegex`^Optional

public readonly noEmptyCharacterClassInRegex: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow empty character classes in regular expression literals.

`noEmptyPattern`^Optional

public readonly noEmptyPattern: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallows empty destructuring patterns.

`noFlatMapIdentity`^Optional

public readonly noFlatMapIdentity: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow to use unnecessary callback on flatMap.

`noGlobalObjectCalls`^Optional

public readonly noGlobalObjectCalls: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow calling global object properties as functions.

`noInnerDeclarations`^Optional

public readonly noInnerDeclarations: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow function and var declarations that are accessible outside their block.

`noInvalidBuiltinInstantiation`^Optional

public readonly noInvalidBuiltinInstantiation: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Ensure that builtins are correctly instantiated.

`noInvalidConstructorSuper`^Optional

public readonly noInvalidConstructorSuper: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevents the incorrect use of super() inside classes.

It also checks whether a call super() is missing from classes that extends other constructors.

`noInvalidDirectionInLinearGradient`^Optional

public readonly noInvalidDirectionInLinearGradient: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow non-standard direction values for linear gradient functions.

`noInvalidGridAreas`^Optional

public readonly noInvalidGridAreas: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallows invalid named grid areas in CSS Grid Layouts.

`noInvalidNewBuiltin`^Optional

public readonly noInvalidNewBuiltin: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow new operators with global non-constructor functions.

`noInvalidPositionAtImportRule`^Optional

public readonly noInvalidPositionAtImportRule: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of.

`noInvalidUseBeforeDeclaration`^Optional

public readonly noInvalidUseBeforeDeclaration: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of variables and function parameters before their declaration.

`noNewSymbol`^Optional

public readonly noNewSymbol: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow new operators with the Symbol object.

`noNodejsModules`^Optional

public readonly noNodejsModules: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Forbid the use of Node.js builtin modules.

`noNonoctalDecimalEscape`^Optional

public readonly noNonoctalDecimalEscape: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow \8 and \9 escape sequences in string literals.

`noPrecisionLoss`^Optional

public readonly noPrecisionLoss: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow literal numbers that lose precision.

`noRenderReturnValue`^Optional

public readonly noRenderReturnValue: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevent the usage of the return value of React.render.

`noSelfAssign`^Optional

public readonly noSelfAssign: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow assignments where both sides are exactly the same.

`noSetterReturn`^Optional

public readonly noSetterReturn: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow returning a value from a setter.

`noStringCaseMismatch`^Optional

public readonly noStringCaseMismatch: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow comparison of expressions modifying the string case with non-compliant value.

`noSwitchDeclarations`^Optional

public readonly noSwitchDeclarations: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow lexical declarations in switch clauses.

`noUndeclaredDependencies`^Optional

public readonly noUndeclaredDependencies: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of dependencies that aren't specified in the package.json.

`noUndeclaredVariables`^Optional

public readonly noUndeclaredVariables: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevents the usage of variables that haven't been declared inside the document.

`noUnknownFunction`^Optional

public readonly noUnknownFunction: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unknown CSS value functions.

`noUnknownMediaFeatureName`^Optional

public readonly noUnknownMediaFeatureName: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unknown media feature names.

`noUnknownProperty`^Optional

public readonly noUnknownProperty: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unknown properties.

`noUnknownUnit`^Optional

public readonly noUnknownUnit: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unknown CSS units.

`noUnmatchableAnbSelector`^Optional

public readonly noUnmatchableAnbSelector: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unmatchable An+B selectors.

`noUnnecessaryContinue`^Optional

public readonly noUnnecessaryContinue: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Avoid using unnecessary continue.

`noUnreachable`^Optional

public readonly noUnreachable: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unreachable code.

`noUnreachableSuper`^Optional

public readonly noUnreachableSuper: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Ensures the super() constructor is called exactly once on every code path in a class constructor before this is accessed if the class has a superclass.

`noUnsafeFinally`^Optional

public readonly noUnsafeFinally: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow control flow statements in finally blocks.

`noUnsafeOptionalChaining`^Optional

public readonly noUnsafeOptionalChaining: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of optional chaining in contexts where the undefined value is not allowed.

`noUnusedFunctionParameters`^Optional

public readonly noUnusedFunctionParameters: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unused function parameters.

`noUnusedImports`^Optional

public readonly noUnusedImports: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unused imports.

`noUnusedLabels`^Optional

public readonly noUnusedLabels: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unused labels.

`noUnusedPrivateClassMembers`^Optional

public readonly noUnusedPrivateClassMembers: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unused private class members.

`noUnusedVariables`^Optional

public readonly noUnusedVariables: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unused variables.

`noVoidElementsWithChildren`^Optional

public readonly noVoidElementsWithChildren: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

This rules prevents void elements (AKA self-closing elements) from having children.

`noVoidTypeReturn`^Optional

public readonly noVoidTypeReturn: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow returning a value from a function with the return type 'void'.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

`useArrayLiterals`^Optional

public readonly useArrayLiterals: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow Array constructors.

`useExhaustiveDependencies`^Optional

public readonly useExhaustiveDependencies: string | IRuleWithUseExhaustiveDependenciesOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithUseExhaustiveDependenciesOptions

Enforce all dependencies are correctly specified in a React hook.

`useHookAtTopLevel`^Optional

public readonly useHookAtTopLevel: string | IRuleWithDeprecatedHooksOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithDeprecatedHooksOptions

Enforce that all React hooks are being called from the Top Level component functions.

`useImportExtensions`^Optional

public readonly useImportExtensions: string | IRuleWithUseImportExtensionsOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithUseImportExtensionsOptions

Enforce file extensions for relative imports.

`useIsNan`^Optional

public readonly useIsNan: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Require calls to isNaN() when checking for NaN.

`useJsxKeyInIterable`^Optional

public readonly useJsxKeyInIterable: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow missing key props in iterators/collection literals.

`useValidForDirection`^Optional

public readonly useValidForDirection: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce "for" loop update clause moving the counter in the right direction.

`useYield`^Optional

public readonly useYield: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Require generator functions to contain yield.

ICssAssists

Implemented By: projen.javascript.biome.biome_config.ICssAssists

Options that changes how the CSS assists behaves.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the assists for CSS files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the assists for CSS files.

ICssConfiguration

Implemented By: projen.javascript.biome.biome_config.ICssConfiguration

Options applied to CSS files.

Properties

Name	Type	Description
`assists`	`projen.javascript.biome.biome_config.ICssAssists`	CSS assists options.
`formatter`	`projen.javascript.biome.biome_config.ICssFormatter`	CSS formatter options.
`linter`	`projen.javascript.biome.biome_config.ICssLinter`	CSS linter options.
`parser`	`projen.javascript.biome.biome_config.ICssParser`	CSS parsing options.

`assists`^Optional

public readonly assists: ICssAssists;

Type: projen.javascript.biome.biome_config.ICssAssists

CSS assists options.

`formatter`^Optional

public readonly formatter: ICssFormatter;

Type: projen.javascript.biome.biome_config.ICssFormatter

CSS formatter options.

`linter`^Optional

public readonly linter: ICssLinter;

Type: projen.javascript.biome.biome_config.ICssLinter

CSS linter options.

`parser`^Optional

public readonly parser: ICssParser;

Type: projen.javascript.biome.biome_config.ICssParser

CSS parsing options.

ICssFormatter

Implemented By: projen.javascript.biome.biome_config.ICssFormatter

Options that changes how the CSS formatter behaves.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the formatter for CSS (and its super languages) files.
`indentStyle`	`string`	The indent style applied to CSS (and its super languages) files.
`indentWidth`	`number`	The size of the indentation applied to CSS (and its super languages) files.
`lineEnding`	`string`	The type of line ending applied to CSS (and its super languages) files.
`lineWidth`	`number`	What's the max width of a line applied to CSS (and its super languages) files.
`quoteStyle`	`string`	The type of quotes used in CSS code.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the formatter for CSS (and its super languages) files.

`indentStyle`^Optional

public readonly indentStyle: string;

Type: string

The indent style applied to CSS (and its super languages) files.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The size of the indentation applied to CSS (and its super languages) files.

Default to 2.

`lineEnding`^Optional

public readonly lineEnding: string;

Type: string

The type of line ending applied to CSS (and its super languages) files.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

What's the max width of a line applied to CSS (and its super languages) files.

Defaults to 80.

`quoteStyle`^Optional

public readonly quoteStyle: string;

Type: string

The type of quotes used in CSS code.

Defaults to double.

ICssLinter

Implemented By: projen.javascript.biome.biome_config.ICssLinter

Options that changes how the CSS linter behaves.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the linter for CSS files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the linter for CSS files.

ICssParser

Implemented By: projen.javascript.biome.biome_config.ICssParser

Options that changes how the CSS parser behaves.

Properties

Name	Type	Description
`allowWrongLineComments`	`boolean`	Allow comments to appear on incorrect lines in `.css` files.
`cssModules`	`boolean`	Enables parsing of CSS Modules specific features.

`allowWrongLineComments`^Optional

public readonly allowWrongLineComments: boolean;

Type: boolean

Allow comments to appear on incorrect lines in .css files.

`cssModules`^Optional

public readonly cssModules: boolean;

Type: boolean

Enables parsing of CSS Modules specific features.

ICustomRestrictedTypeOptions

Implemented By: projen.javascript.biome.biome_config.ICustomRestrictedTypeOptions

Properties

Name	Type	Description
`message`	`string`	No description.
`use`	`string`	No description.

`message`^Optional

public readonly message: string;

Type: string

`use`^Optional

public readonly use: string;

Type: string

IDeprecatedHooksOptions

Implemented By: projen.javascript.biome.biome_config.IDeprecatedHooksOptions

Options for the useHookAtTopLevel rule have been deprecated, since we now use the React hook naming convention to determine whether a function is a hook.

IFilenamingConventionOptions

Implemented By: projen.javascript.biome.biome_config.IFilenamingConventionOptions

Rule's options.

Properties

Name	Type	Description
`filenameCases`	`string[]`	Allowed cases for file names.
`requireAscii`	`boolean`	If `false`, then non-ASCII characters are allowed.
`strictCase`	`boolean`	If `false`, then consecutive uppercase are allowed in camel and pascal cases.

`filenameCases`^Optional

public readonly filenameCases: string[];

Type: string[]

Allowed cases for file names.

`requireAscii`^Optional

public readonly requireAscii: boolean;

Type: boolean

If false, then non-ASCII characters are allowed.

`strictCase`^Optional

public readonly strictCase: boolean;

Type: boolean

If false, then consecutive uppercase are allowed in camel and pascal cases.

This does not affect other [Case].

IFilesConfiguration

Implemented By: projen.javascript.biome.biome_config.IFilesConfiguration

The configuration of the filesystem.

Properties

Name	Type	Description
`ignore`	`string[]`	A list of Unix shell style patterns.
`ignoreUnknown`	`boolean`	Tells Biome to not emit diagnostics when handling files that doesn't know.
`include`	`string[]`	A list of Unix shell style patterns.
`maxSize`	`number`	The maximum allowed size for source code files in bytes.

`ignore`^Optional

public readonly ignore: string[];

Type: string[]

A list of Unix shell style patterns.

Biome will ignore files/folders that will match these patterns.

`ignoreUnknown`^Optional

public readonly ignoreUnknown: boolean;

Type: boolean

Tells Biome to not emit diagnostics when handling files that doesn't know.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of Unix shell style patterns.

Biome will handle only those files/folders that will match these patterns.

`maxSize`^Optional

public readonly maxSize: number;

Type: number

The maximum allowed size for source code files in bytes.

Files above this limit will be ignored for performance reasons. Defaults to 1 MiB

IFormatterConfiguration

Implemented By: projen.javascript.biome.biome_config.IFormatterConfiguration

Generic options applied to all files.

Properties

Name	Type	Description
`attributePosition`	`string`	The attribute position style in HTMLish languages.
`bracketSpacing`	`boolean`	Whether to insert spaces around brackets in object literals.
`enabled`	`boolean`	No description.
`formatWithErrors`	`boolean`	Stores whether formatting should be allowed to proceed if a given file has syntax errors.
`ignore`	`string[]`	A list of Unix shell style patterns.
`include`	`string[]`	A list of Unix shell style patterns.
`indentSize`	`number`	The size of the indentation, 2 by default (deprecated, use `indent-width`).
`indentStyle`	`string`	The indent style.
`indentWidth`	`number`	The size of the indentation, 2 by default.
`lineEnding`	`string`	The type of line ending.
`lineWidth`	`number`	What's the max width of a line.
`useEditorconfig`	`boolean`	Use any `.editorconfig` files to configure the formatter. Configuration in `biome.json` will override `.editorconfig` configuration. Default: false.

`attributePosition`^Optional

public readonly attributePosition: string;

Type: string

The attribute position style in HTMLish languages.

By default auto.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Whether to insert spaces around brackets in object literals.

Defaults to true.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

`formatWithErrors`^Optional

public readonly formatWithErrors: boolean;

Type: boolean

Stores whether formatting should be allowed to proceed if a given file has syntax errors.

`ignore`^Optional

public readonly ignore: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will ignore files/folders that will match these patterns.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will include files/folders that will match these patterns.

`indentSize`^Optional

public readonly indentSize: number;

Type: number

The size of the indentation, 2 by default (deprecated, use indent-width).

`indentStyle`^Optional

public readonly indentStyle: string;

Type: string

The indent style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The size of the indentation, 2 by default.

`lineEnding`^Optional

public readonly lineEnding: string;

Type: string

The type of line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

What's the max width of a line.

Defaults to 80.

`useEditorconfig`^Optional

public readonly useEditorconfig: boolean;

Type: boolean

Use any .editorconfig files to configure the formatter. Configuration in biome.json will override .editorconfig configuration. Default: false.

IGraphqlConfiguration

Implemented By: projen.javascript.biome.biome_config.IGraphqlConfiguration

Options applied to GraphQL files.

Properties

Name	Type	Description
`formatter`	`projen.javascript.biome.biome_config.IGraphqlFormatter`	GraphQL formatter options.
`linter`	`projen.javascript.biome.biome_config.IGraphqlLinter`	No description.

`formatter`^Optional

public readonly formatter: IGraphqlFormatter;

Type: projen.javascript.biome.biome_config.IGraphqlFormatter

GraphQL formatter options.

`linter`^Optional

public readonly linter: IGraphqlLinter;

Type: projen.javascript.biome.biome_config.IGraphqlLinter

IGraphqlFormatter

Implemented By: projen.javascript.biome.biome_config.IGraphqlFormatter

Options that changes how the GraphQL formatter behaves.

Properties

Name	Type	Description
`bracketSpacing`	`boolean`	Whether to insert spaces around brackets in object literals.
`enabled`	`boolean`	Control the formatter for GraphQL files.
`indentStyle`	`string`	The indent style applied to GraphQL files.
`indentWidth`	`number`	The size of the indentation applied to GraphQL files.
`lineEnding`	`string`	The type of line ending applied to GraphQL files.
`lineWidth`	`number`	What's the max width of a line applied to GraphQL files.
`quoteStyle`	`string`	The type of quotes used in GraphQL code.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Whether to insert spaces around brackets in object literals.

Defaults to true.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the formatter for GraphQL files.

`indentStyle`^Optional

public readonly indentStyle: string;

Type: string

The indent style applied to GraphQL files.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The size of the indentation applied to GraphQL files.

Default to 2.

`lineEnding`^Optional

public readonly lineEnding: string;

Type: string

The type of line ending applied to GraphQL files.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

What's the max width of a line applied to GraphQL files.

Defaults to 80.

`quoteStyle`^Optional

public readonly quoteStyle: string;

Type: string

The type of quotes used in GraphQL code.

Defaults to double.

IGraphqlLinter

Implemented By: projen.javascript.biome.biome_config.IGraphqlLinter

Options that changes how the GraphQL linter behaves.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the formatter for GraphQL files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the formatter for GraphQL files.

IHook

Implemented By: projen.javascript.biome.biome_config.IHook

Properties

Name	Type	Description
`closureIndex`	`number`	The "position" of the closure function, starting from zero.
`dependenciesIndex`	`number`	The "position" of the array of dependencies, starting from zero.
`name`	`string`	The name of the hook.
`stableResult`	`boolean \| number[]`	Whether the result of the hook is stable.

`closureIndex`^Optional

public readonly closureIndex: number;

Type: number

The "position" of the closure function, starting from zero.

For example, for React's useEffect() hook, the closure index is 0.

`dependenciesIndex`^Optional

public readonly dependenciesIndex: number;

Type: number

The "position" of the array of dependencies, starting from zero.

For example, for React's useEffect() hook, the dependencies index is 1.

`name`^Optional

public readonly name: string;

Type: string

The name of the hook.

`stableResult`^Optional

public readonly stableResult: boolean | number[];

Type: boolean | number[]

Whether the result of the hook is stable.

Set to true to mark the identity of the hook's return value as stable, or use a number/an array of numbers to mark the "positions" in the return array as stable.

For example, for React's useRef() hook the value would be true, while for useState() it would be [1].

IJavascriptAssists

Implemented By: projen.javascript.biome.biome_config.IJavascriptAssists

Linter options specific to the JavaScript linter.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the linter for JavaScript (and its super languages) files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the linter for JavaScript (and its super languages) files.

IJavascriptConfiguration

Implemented By: projen.javascript.biome.biome_config.IJavascriptConfiguration

A set of options applied to the JavaScript files.

Properties

Name	Type	Description
`assists`	`projen.javascript.biome.biome_config.IJavascriptAssists`	Assists options.
`formatter`	`projen.javascript.biome.biome_config.IJavascriptFormatter`	Formatting options.
`globals`	`string[]`	A list of global bindings that should be ignored by the analyzers.
`jsxRuntime`	`string`	Indicates the type of runtime or transformation used for interpreting JSX.
`linter`	`projen.javascript.biome.biome_config.IJavascriptLinter`	Linter options.
`organizeImports`	`projen.javascript.biome.biome_config.IJavascriptOrganizeImports`	No description.
`parser`	`projen.javascript.biome.biome_config.IJavascriptParser`	Parsing options.

`assists`^Optional

public readonly assists: IJavascriptAssists;

Type: projen.javascript.biome.biome_config.IJavascriptAssists

Assists options.

`formatter`^Optional

public readonly formatter: IJavascriptFormatter;

Type: projen.javascript.biome.biome_config.IJavascriptFormatter

Formatting options.

`globals`^Optional

public readonly globals: string[];

Type: string[]

A list of global bindings that should be ignored by the analyzers.

If defined here, they should not emit diagnostics.

`jsxRuntime`^Optional

public readonly jsxRuntime: string;

Type: string

Indicates the type of runtime or transformation used for interpreting JSX.

`linter`^Optional

public readonly linter: IJavascriptLinter;

Type: projen.javascript.biome.biome_config.IJavascriptLinter

Linter options.

`organizeImports`^Optional

public readonly organizeImports: IJavascriptOrganizeImports;

Type: projen.javascript.biome.biome_config.IJavascriptOrganizeImports

`parser`^Optional

public readonly parser: IJavascriptParser;

Type: projen.javascript.biome.biome_config.IJavascriptParser

Parsing options.

IJavascriptFormatter

Implemented By: projen.javascript.biome.biome_config.IJavascriptFormatter

Formatting options specific to the JavaScript files.

Properties

Name	Type	Description
`arrowParentheses`	`string`	Whether to add non-necessary parentheses to arrow functions.
`attributePosition`	`string`	The attribute position style in jsx elements.
`bracketSameLine`	`boolean`	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.
`bracketSpacing`	`boolean`	Whether to insert spaces around brackets in object literals.
`enabled`	`boolean`	Control the formatter for JavaScript (and its super languages) files.
`indentSize`	`number`	The size of the indentation applied to JavaScript (and its super languages) files.
`indentStyle`	`string`	The indent style applied to JavaScript (and its super languages) files.
`indentWidth`	`number`	The size of the indentation applied to JavaScript (and its super languages) files.
`jsxQuoteStyle`	`string`	The type of quotes used in JSX.
`lineEnding`	`string`	The type of line ending applied to JavaScript (and its super languages) files.
`lineWidth`	`number`	What's the max width of a line applied to JavaScript (and its super languages) files.
`quoteProperties`	`string`	When properties in objects are quoted.
`quoteStyle`	`string`	The type of quotes used in JavaScript code.
`semicolons`	`string`	Whether the formatter prints semicolons for all statements or only in for statements where it is necessary because of ASI.
`trailingComma`	`string`	Print trailing commas wherever possible in multi-line comma-separated syntactic structures.
`trailingCommas`	`string`	Print trailing commas wherever possible in multi-line comma-separated syntactic structures.

`arrowParentheses`^Optional

public readonly arrowParentheses: string;

Type: string

Whether to add non-necessary parentheses to arrow functions.

Defaults to "always".

`attributePosition`^Optional

public readonly attributePosition: string;

Type: string

The attribute position style in jsx elements.

Defaults to auto.

`bracketSameLine`^Optional

public readonly bracketSameLine: boolean;

Type: boolean

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.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Whether to insert spaces around brackets in object literals.

Defaults to true.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the formatter for JavaScript (and its super languages) files.

`indentSize`^Optional

public readonly indentSize: number;

Type: number

The size of the indentation applied to JavaScript (and its super languages) files.

Default to 2.

`indentStyle`^Optional

public readonly indentStyle: string;

Type: string

The indent style applied to JavaScript (and its super languages) files.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The size of the indentation applied to JavaScript (and its super languages) files.

Default to 2.

`jsxQuoteStyle`^Optional

public readonly jsxQuoteStyle: string;

Type: string

The type of quotes used in JSX.

Defaults to double.

`lineEnding`^Optional

public readonly lineEnding: string;

Type: string

The type of line ending applied to JavaScript (and its super languages) files.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

What's the max width of a line applied to JavaScript (and its super languages) files.

Defaults to 80.

`quoteProperties`^Optional

public readonly quoteProperties: string;

Type: string

When properties in objects are quoted.

Defaults to asNeeded.

`quoteStyle`^Optional

public readonly quoteStyle: string;

Type: string

The type of quotes used in JavaScript code.

Defaults to double.

`semicolons`^Optional

public readonly semicolons: string;

Type: string

Whether the formatter prints semicolons for all statements or only in for statements where it is necessary because of ASI.

`trailingComma`^Optional

public readonly trailingComma: string;

Type: string

Print trailing commas wherever possible in multi-line comma-separated syntactic structures.

Defaults to "all".

`trailingCommas`^Optional

public readonly trailingCommas: string;

Type: string

Print trailing commas wherever possible in multi-line comma-separated syntactic structures.

Defaults to "all".

IJavascriptLinter

Implemented By: projen.javascript.biome.biome_config.IJavascriptLinter

Linter options specific to the JavaScript linter.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the linter for JavaScript (and its super languages) files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the linter for JavaScript (and its super languages) files.

IJavascriptOrganizeImports

Implemented By: projen.javascript.biome.biome_config.IJavascriptOrganizeImports

IJavascriptParser

Implemented By: projen.javascript.biome.biome_config.IJavascriptParser

Options that changes how the JavaScript parser behaves.

Properties

Name	Type	Description
`unsafeParameterDecoratorsEnabled`	`boolean`	It enables the experimental and unsafe parsing of parameter decorators.

`unsafeParameterDecoratorsEnabled`^Optional

public readonly unsafeParameterDecoratorsEnabled: boolean;

Type: boolean

It enables the experimental and unsafe parsing of parameter decorators.

These decorators belong to an old proposal, and they are subject to change.

IJsonAssists

Implemented By: projen.javascript.biome.biome_config.IJsonAssists

Linter options specific to the JSON linter.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the linter for JSON (and its super languages) files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the linter for JSON (and its super languages) files.

IJsonConfiguration

Implemented By: projen.javascript.biome.biome_config.IJsonConfiguration

Options applied to JSON files.

Properties

Name	Type	Description
`assists`	`projen.javascript.biome.biome_config.IJsonAssists`	Assists options.
`formatter`	`projen.javascript.biome.biome_config.IJsonFormatter`	Formatting options.
`linter`	`projen.javascript.biome.biome_config.IJsonLinter`	Linting options.
`parser`	`projen.javascript.biome.biome_config.IJsonParser`	Parsing options.

`assists`^Optional

public readonly assists: IJsonAssists;

Type: projen.javascript.biome.biome_config.IJsonAssists

Assists options.

`formatter`^Optional

public readonly formatter: IJsonFormatter;

Type: projen.javascript.biome.biome_config.IJsonFormatter

Formatting options.

`linter`^Optional

public readonly linter: IJsonLinter;

Type: projen.javascript.biome.biome_config.IJsonLinter

Linting options.

`parser`^Optional

public readonly parser: IJsonParser;

Type: projen.javascript.biome.biome_config.IJsonParser

Parsing options.

IJsonFormatter

Implemented By: projen.javascript.biome.biome_config.IJsonFormatter

Properties

Name	Type	Description
`enabled`	`boolean`	Control the formatter for JSON (and its super languages) files.
`indentSize`	`number`	The size of the indentation applied to JSON (and its super languages) files.
`indentStyle`	`string`	The indent style applied to JSON (and its super languages) files.
`indentWidth`	`number`	The size of the indentation applied to JSON (and its super languages) files.
`lineEnding`	`string`	The type of line ending applied to JSON (and its super languages) files.
`lineWidth`	`number`	What's the max width of a line applied to JSON (and its super languages) files.
`trailingCommas`	`string`	Print trailing commas wherever possible in multi-line comma-separated syntactic structures.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the formatter for JSON (and its super languages) files.

`indentSize`^Optional

public readonly indentSize: number;

Type: number

The size of the indentation applied to JSON (and its super languages) files.

Default to 2.

`indentStyle`^Optional

public readonly indentStyle: string;

Type: string

The indent style applied to JSON (and its super languages) files.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The size of the indentation applied to JSON (and its super languages) files.

Default to 2.

`lineEnding`^Optional

public readonly lineEnding: string;

Type: string

The type of line ending applied to JSON (and its super languages) files.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

What's the max width of a line applied to JSON (and its super languages) files.

Defaults to 80.

`trailingCommas`^Optional

public readonly trailingCommas: string;

Type: string

Print trailing commas wherever possible in multi-line comma-separated syntactic structures.

Defaults to "none".

IJsonLinter

Implemented By: projen.javascript.biome.biome_config.IJsonLinter

Linter options specific to the JSON linter.

Properties

Name	Type	Description
`enabled`	`boolean`	Control the linter for JSON (and its super languages) files.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Control the linter for JSON (and its super languages) files.

IJsonParser

Implemented By: projen.javascript.biome.biome_config.IJsonParser

Options that changes how the JSON parser behaves.

Properties

Name	Type	Description
`allowComments`	`boolean`	Allow parsing comments in `.json` files.
`allowTrailingCommas`	`boolean`	Allow parsing trailing commas in `.json` files.

`allowComments`^Optional

public readonly allowComments: boolean;

Type: boolean

Allow parsing comments in .json files.

`allowTrailingCommas`^Optional

public readonly allowTrailingCommas: boolean;

Type: boolean

Allow parsing trailing commas in .json files.

ILinterConfiguration

Implemented By: projen.javascript.biome.biome_config.ILinterConfiguration

Properties

Name	Type	Description
`enabled`	`boolean`	if `false`, it disables the feature and the linter won't be executed.
`ignore`	`string[]`	A list of Unix shell style patterns.
`include`	`string[]`	A list of Unix shell style patterns.
`rules`	`projen.javascript.biome.biome_config.IRules`	List of rules.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

if false, it disables the feature and the linter won't be executed.

true by default

`ignore`^Optional

public readonly ignore: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will ignore files/folders that will match these patterns.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will include files/folders that will match these patterns.

`rules`^Optional

public readonly rules: IRules;

Type: projen.javascript.biome.biome_config.IRules

List of rules.

INamingConventionOptions

Implemented By: projen.javascript.biome.biome_config.INamingConventionOptions

Rule's options.

Properties

Name	Type	Description
`conventions`	`projen.javascript.biome.biome_config.IConvention[]`	Custom conventions.
`enumMemberCase`	`string`	Allowed cases for TypeScript `enum` member names.
`requireAscii`	`boolean`	If `false`, then non-ASCII characters are allowed.
`strictCase`	`boolean`	If `false`, then consecutive uppercase are allowed in camel and pascal cases.

`conventions`^Optional

public readonly conventions: IConvention[];

Type: projen.javascript.biome.biome_config.IConvention[]

Custom conventions.

`enumMemberCase`^Optional

public readonly enumMemberCase: string;

Type: string

Allowed cases for TypeScript enum member names.

`requireAscii`^Optional

public readonly requireAscii: boolean;

Type: boolean

If false, then non-ASCII characters are allowed.

`strictCase`^Optional

public readonly strictCase: boolean;

Type: boolean

If false, then consecutive uppercase are allowed in camel and pascal cases.

This does not affect other [Case].

INoConsoleOptions

Implemented By: projen.javascript.biome.biome_config.INoConsoleOptions

Properties

Name	Type	Description
`allow`	`string[]`	Allowed calls on the console object.

`allow`^Required

public readonly allow: string[];

Type: string[]

Allowed calls on the console object.

INoDoubleEqualsOptions

Implemented By: projen.javascript.biome.biome_config.INoDoubleEqualsOptions

Rule's options.

Properties

Name	Type	Description
`ignoreNull`	`boolean`	If `true`, an exception is made when comparing with `null`, as it's often relied on to check both for `null` or `undefined`.

`ignoreNull`^Optional

public readonly ignoreNull: boolean;

Type: boolean

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.

INoLabelWithoutControlOptions

Implemented By: projen.javascript.biome.biome_config.INoLabelWithoutControlOptions

Properties

Name	Type	Description
`inputComponents`	`string[]`	Array of component names that should be considered the same as an `input` element.
`labelAttributes`	`string[]`	Array of attributes that should be treated as the `label` accessible text content.
`labelComponents`	`string[]`	Array of component names that should be considered the same as a `label` element.

`inputComponents`^Optional

public readonly inputComponents: string[];

Type: string[]

Array of component names that should be considered the same as an input element.

`labelAttributes`^Optional

public readonly labelAttributes: string[];

Type: string[]

Array of attributes that should be treated as the label accessible text content.

`labelComponents`^Optional

public readonly labelComponents: string[];

Type: string[]

Array of component names that should be considered the same as a label element.

INoRestrictedTypesOptions

Implemented By: projen.javascript.biome.biome_config.INoRestrictedTypesOptions

Properties

Name	Type	Description
`types`	`{[ key: string ]: string \| projen.javascript.biome.biome_config.ICustomRestrictedTypeOptions}`	No description.

`types`^Optional

public readonly types: {[ key: string ]: string | ICustomRestrictedTypeOptions};

Type: {[ key: string ]: string | projen.javascript.biome.biome_config.ICustomRestrictedTypeOptions}

INoSecretsOptions

Implemented By: projen.javascript.biome.biome_config.INoSecretsOptions

Properties

Name	Type	Description
`entropyThreshold`	`number`	Set entropy threshold (default is 41).

`entropyThreshold`^Optional

public readonly entropyThreshold: number;

Type: number

Set entropy threshold (default is 41).

INursery

Implemented By: projen.javascript.biome.biome_config.INursery

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noCommonJs`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow use of CommonJs module system in favor of ESM style imports.
`noDescendingSpecificity`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow a lower specificity selector from coming after a higher specificity selector.
`noDocumentCookie`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow direct assignments to document.cookie.
`noDocumentImportInPage`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevents importing next/document outside of pages/_document.jsx in Next.js projects.
`noDuplicateCustomProperties`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate custom properties within declaration blocks.
`noDuplicatedFields`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	No duplicated fields in GraphQL operations.
`noDuplicateElseIf`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate conditions in if-else-if chains.
`noDuplicateProperties`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate properties within declaration blocks.
`noDynamicNamespaceImportAccess`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow accessing namespace imports dynamically.
`noEnum`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow TypeScript enum.
`noExportedImports`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow exporting an imported variable.
`noHeadElement`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevent usage of <head> element in a Next.js project.
`noHeadImportInDocument`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevent using the next/head module in pages/_document.js on Next.js projects.
`noImgElement`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevent usage of <img> element in a Next.js project.
`noIrregularWhitespace`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallows the use of irregular whitespace characters.
`noMissingVarFunction`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow missing var function for css variables.
`noNestedTernary`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow nested ternary expressions.
`noOctalEscape`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow octal escape sequences in string literals.
`noProcessEnv`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of process.env.
`noRestrictedImports`	`string \| projen.javascript.biome.biome_config.IRuleWithRestrictedImportsOptions`	Disallow specified modules when loaded by import or require.
`noRestrictedTypes`	`string \| projen.javascript.biome.biome_config.IRuleWithNoRestrictedTypesOptions`	Disallow user defined types.
`noSecrets`	`string \| projen.javascript.biome.biome_config.IRuleWithNoSecretsOptions`	Disallow usage of sensitive data such as API keys and tokens.
`noStaticElementInteractions`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that static, visible elements (such as <div>) that have click handlers use the valid role attribute.
`noSubstr`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the use of String.slice() over String.substr() and String.substring().
`noTemplateCurlyInString`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow template literal placeholder syntax in regular strings.
`noUnknownPseudoClass`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unknown pseudo-class selectors.
`noUnknownPseudoElement`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unknown pseudo-element selectors.
`noUnknownTypeSelector`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unknown type selectors.
`noUselessEscapeInRegex`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow unnecessary escape sequence in regular expression literals.
`noUselessStringRaw`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unnecessary String.raw function in template string literals without any escape sequence.
`noValueAtRule`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow use of.
`recommended`	`boolean`	It enables the recommended rules for this group.
`useAdjacentOverloadSignatures`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of overload signatures that are not next to each other.
`useAriaPropsSupportedByRole`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce that ARIA properties are valid for the roles that are supported by the element.
`useAtIndex`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use at() instead of integer index access.
`useCollapsedIf`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce using single if instead of nested if clauses.
`useComponentExportOnlyModules`	`string \| projen.javascript.biome.biome_config.IRuleWithUseComponentExportOnlyModulesOptions`	Enforce declaring components only within modules that export React Components exclusively.
`useConsistentCurlyBraces`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	This rule enforces consistent use of curly braces inside JSX attributes and JSX children.
`useConsistentMemberAccessibility`	`string \| projen.javascript.biome.biome_config.IRuleWithConsistentMemberAccessibilityOptions`	Require consistent accessibility modifiers on class properties and methods.
`useDeprecatedReason`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Require specifying the reason argument when using.
`useExplicitType`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Require explicit return types on functions and class methods.
`useGoogleFontDisplay`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforces the use of a recommended display strategy with Google Fonts.
`useGuardForIn`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Require for-in loops to include an if statement.
`useImportRestrictions`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallows package private imports.
`useSortedClasses`	`string \| projen.javascript.biome.biome_config.IRuleWithUtilityClassSortingOptions`	Enforce the sorting of CSS utility classes.
`useStrictMode`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the use of the directive "use strict" in script files.
`useTrimStartEnd`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the use of String.trimStart() and String.trimEnd() over String.trimLeft() and String.trimRight().
`useValidAutocomplete`	`string \| projen.javascript.biome.biome_config.IRuleWithUseValidAutocompleteOptions`	Use valid values for the autocomplete attribute on input elements.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noCommonJs`^Optional

public readonly noCommonJs: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow use of CommonJs module system in favor of ESM style imports.

`noDescendingSpecificity`^Optional

public readonly noDescendingSpecificity: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow a lower specificity selector from coming after a higher specificity selector.

`noDocumentCookie`^Optional

public readonly noDocumentCookie: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow direct assignments to document.cookie.

`noDocumentImportInPage`^Optional

public readonly noDocumentImportInPage: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevents importing next/document outside of pages/_document.jsx in Next.js projects.

`noDuplicateCustomProperties`^Optional

public readonly noDuplicateCustomProperties: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate custom properties within declaration blocks.

`noDuplicatedFields`^Optional

public readonly noDuplicatedFields: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

No duplicated fields in GraphQL operations.

`noDuplicateElseIf`^Optional

public readonly noDuplicateElseIf: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate conditions in if-else-if chains.

`noDuplicateProperties`^Optional

public readonly noDuplicateProperties: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate properties within declaration blocks.

`noDynamicNamespaceImportAccess`^Optional

public readonly noDynamicNamespaceImportAccess: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow accessing namespace imports dynamically.

`noEnum`^Optional

public readonly noEnum: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow TypeScript enum.

`noExportedImports`^Optional

public readonly noExportedImports: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow exporting an imported variable.

`noHeadElement`^Optional

public readonly noHeadElement: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevent usage of <head> element in a Next.js project.

`noHeadImportInDocument`^Optional

public readonly noHeadImportInDocument: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevent using the next/head module in pages/_document.js on Next.js projects.

`noImgElement`^Optional

public readonly noImgElement: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevent usage of <img> element in a Next.js project.

`noIrregularWhitespace`^Optional

public readonly noIrregularWhitespace: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallows the use of irregular whitespace characters.

`noMissingVarFunction`^Optional

public readonly noMissingVarFunction: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow missing var function for css variables.

`noNestedTernary`^Optional

public readonly noNestedTernary: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow nested ternary expressions.

`noOctalEscape`^Optional

public readonly noOctalEscape: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow octal escape sequences in string literals.

`noProcessEnv`^Optional

public readonly noProcessEnv: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of process.env.

`noRestrictedImports`^Optional

public readonly noRestrictedImports: string | IRuleWithRestrictedImportsOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithRestrictedImportsOptions

Disallow specified modules when loaded by import or require.

`noRestrictedTypes`^Optional

public readonly noRestrictedTypes: string | IRuleWithNoRestrictedTypesOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoRestrictedTypesOptions

Disallow user defined types.

`noSecrets`^Optional

public readonly noSecrets: string | IRuleWithNoSecretsOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoSecretsOptions

Disallow usage of sensitive data such as API keys and tokens.

`noStaticElementInteractions`^Optional

public readonly noStaticElementInteractions: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that static, visible elements (such as <div>) that have click handlers use the valid role attribute.

`noSubstr`^Optional

public readonly noSubstr: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the use of String.slice() over String.substr() and String.substring().

`noTemplateCurlyInString`^Optional

public readonly noTemplateCurlyInString: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow template literal placeholder syntax in regular strings.

`noUnknownPseudoClass`^Optional

public readonly noUnknownPseudoClass: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unknown pseudo-class selectors.

`noUnknownPseudoElement`^Optional

public readonly noUnknownPseudoElement: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unknown pseudo-element selectors.

`noUnknownTypeSelector`^Optional

public readonly noUnknownTypeSelector: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unknown type selectors.

`noUselessEscapeInRegex`^Optional

public readonly noUselessEscapeInRegex: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow unnecessary escape sequence in regular expression literals.

`noUselessStringRaw`^Optional

public readonly noUselessStringRaw: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unnecessary String.raw function in template string literals without any escape sequence.

`noValueAtRule`^Optional

public readonly noValueAtRule: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow use of.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

`useAdjacentOverloadSignatures`^Optional

public readonly useAdjacentOverloadSignatures: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of overload signatures that are not next to each other.

`useAriaPropsSupportedByRole`^Optional

public readonly useAriaPropsSupportedByRole: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce that ARIA properties are valid for the roles that are supported by the element.

`useAtIndex`^Optional

public readonly useAtIndex: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use at() instead of integer index access.

`useCollapsedIf`^Optional

public readonly useCollapsedIf: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce using single if instead of nested if clauses.

`useComponentExportOnlyModules`^Optional

public readonly useComponentExportOnlyModules: string | IRuleWithUseComponentExportOnlyModulesOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithUseComponentExportOnlyModulesOptions

Enforce declaring components only within modules that export React Components exclusively.

`useConsistentCurlyBraces`^Optional

public readonly useConsistentCurlyBraces: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

This rule enforces consistent use of curly braces inside JSX attributes and JSX children.

`useConsistentMemberAccessibility`^Optional

public readonly useConsistentMemberAccessibility: string | IRuleWithConsistentMemberAccessibilityOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithConsistentMemberAccessibilityOptions

Require consistent accessibility modifiers on class properties and methods.

`useDeprecatedReason`^Optional

Deprecated: directive

public readonly useDeprecatedReason: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Require specifying the reason argument when using.

`useExplicitType`^Optional

public readonly useExplicitType: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Require explicit return types on functions and class methods.

`useGoogleFontDisplay`^Optional

public readonly useGoogleFontDisplay: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforces the use of a recommended display strategy with Google Fonts.

`useGuardForIn`^Optional

public readonly useGuardForIn: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Require for-in loops to include an if statement.

`useImportRestrictions`^Optional

public readonly useImportRestrictions: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallows package private imports.

`useSortedClasses`^Optional

public readonly useSortedClasses: string | IRuleWithUtilityClassSortingOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithUtilityClassSortingOptions

Enforce the sorting of CSS utility classes.

`useStrictMode`^Optional

public readonly useStrictMode: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the use of the directive "use strict" in script files.

`useTrimStartEnd`^Optional

public readonly useTrimStartEnd: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the use of String.trimStart() and String.trimEnd() over String.trimLeft() and String.trimRight().

`useValidAutocomplete`^Optional

public readonly useValidAutocomplete: string | IRuleWithUseValidAutocompleteOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithUseValidAutocompleteOptions

Use valid values for the autocomplete attribute on input elements.

IOrganizeImports

Implemented By: projen.javascript.biome.biome_config.IOrganizeImports

Properties

Name	Type	Description
`enabled`	`boolean`	Enables the organization of imports.
`ignore`	`string[]`	A list of Unix shell style patterns.
`include`	`string[]`	A list of Unix shell style patterns.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Enables the organization of imports.

`ignore`^Optional

public readonly ignore: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will ignore files/folders that will match these patterns.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will include files/folders that will match these patterns.

IOverrideFormatterConfiguration

Implemented By: projen.javascript.biome.biome_config.IOverrideFormatterConfiguration

Properties

Name	Type	Description
`attributePosition`	`string`	The attribute position style.
`bracketSpacing`	`boolean`	Whether to insert spaces around brackets in object literals.
`enabled`	`boolean`	No description.
`formatWithErrors`	`boolean`	Stores whether formatting should be allowed to proceed if a given file has syntax errors.
`indentSize`	`number`	The size of the indentation, 2 by default (deprecated, use `indent-width`).
`indentStyle`	`string`	The indent style.
`indentWidth`	`number`	The size of the indentation, 2 by default.
`lineEnding`	`string`	The type of line ending.
`lineWidth`	`number`	What's the max width of a line.

`attributePosition`^Optional

public readonly attributePosition: string;

Type: string

The attribute position style.

`bracketSpacing`^Optional

public readonly bracketSpacing: boolean;

Type: boolean

Whether to insert spaces around brackets in object literals.

Defaults to true.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

`formatWithErrors`^Optional

public readonly formatWithErrors: boolean;

Type: boolean

Stores whether formatting should be allowed to proceed if a given file has syntax errors.

`indentSize`^Optional

public readonly indentSize: number;

Type: number

The size of the indentation, 2 by default (deprecated, use indent-width).

`indentStyle`^Optional

public readonly indentStyle: string;

Type: string

The indent style.

`indentWidth`^Optional

public readonly indentWidth: number;

Type: number

The size of the indentation, 2 by default.

`lineEnding`^Optional

public readonly lineEnding: string;

Type: string

The type of line ending.

`lineWidth`^Optional

public readonly lineWidth: number;

Type: number

What's the max width of a line.

Defaults to 80.

IOverrideLinterConfiguration

Implemented By: projen.javascript.biome.biome_config.IOverrideLinterConfiguration

Properties

Name	Type	Description
`enabled`	`boolean`	if `false`, it disables the feature and the linter won't be executed.
`rules`	`projen.javascript.biome.biome_config.IRules`	List of rules.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

if false, it disables the feature and the linter won't be executed.

true by default

`rules`^Optional

public readonly rules: IRules;

Type: projen.javascript.biome.biome_config.IRules

List of rules.

IOverrideOrganizeImportsConfiguration

Implemented By: projen.javascript.biome.biome_config.IOverrideOrganizeImportsConfiguration

Properties

Name	Type	Description
`enabled`	`boolean`	if `false`, it disables the feature and the linter won't be executed.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

if false, it disables the feature and the linter won't be executed.

true by default

IOverridePattern

Implemented By: projen.javascript.biome.biome_config.IOverridePattern

Properties

Name	Type	Description
`css`	`projen.javascript.biome.biome_config.ICssConfiguration`	Specific configuration for the Css language.
`formatter`	`projen.javascript.biome.biome_config.IOverrideFormatterConfiguration`	Specific configuration for the Json language.
`graphql`	`projen.javascript.biome.biome_config.IGraphqlConfiguration`	Specific configuration for the Graphql language.
`ignore`	`string[]`	A list of Unix shell style patterns.
`include`	`string[]`	A list of Unix shell style patterns.
`javascript`	`projen.javascript.biome.biome_config.IJavascriptConfiguration`	Specific configuration for the JavaScript language.
`json`	`projen.javascript.biome.biome_config.IJsonConfiguration`	Specific configuration for the Json language.
`linter`	`projen.javascript.biome.biome_config.IOverrideLinterConfiguration`	Specific configuration for the Json language.
`organizeImports`	`projen.javascript.biome.biome_config.IOverrideOrganizeImportsConfiguration`	Specific configuration for the Json language.

`css`^Optional

public readonly css: ICssConfiguration;

Type: projen.javascript.biome.biome_config.ICssConfiguration

Specific configuration for the Css language.

`formatter`^Optional

public readonly formatter: IOverrideFormatterConfiguration;

Type: projen.javascript.biome.biome_config.IOverrideFormatterConfiguration

Specific configuration for the Json language.

`graphql`^Optional

public readonly graphql: IGraphqlConfiguration;

Type: projen.javascript.biome.biome_config.IGraphqlConfiguration

Specific configuration for the Graphql language.

`ignore`^Optional

public readonly ignore: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will ignore files/folders that will match these patterns.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of Unix shell style patterns.

The formatter will include files/folders that will match these patterns.

`javascript`^Optional

public readonly javascript: IJavascriptConfiguration;

Type: projen.javascript.biome.biome_config.IJavascriptConfiguration

Specific configuration for the JavaScript language.

`json`^Optional

public readonly json: IJsonConfiguration;

Type: projen.javascript.biome.biome_config.IJsonConfiguration

Specific configuration for the Json language.

`linter`^Optional

public readonly linter: IOverrideLinterConfiguration;

Type: projen.javascript.biome.biome_config.IOverrideLinterConfiguration

Specific configuration for the Json language.

`organizeImports`^Optional

public readonly organizeImports: IOverrideOrganizeImportsConfiguration;

Type: projen.javascript.biome.biome_config.IOverrideOrganizeImportsConfiguration

Specific configuration for the Json language.

IPerformance

Implemented By: projen.javascript.biome.biome_config.IPerformance

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noAccumulatingSpread`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of spread (...) syntax on accumulators.
`noBarrelFile`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of barrel file.
`noDelete`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of the delete operator.
`noReExportAll`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Avoid re-export all.
`recommended`	`boolean`	It enables the recommended rules for this group.
`useTopLevelRegex`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Require regex literals to be declared at the top level.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noAccumulatingSpread`^Optional

public readonly noAccumulatingSpread: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of spread (...) syntax on accumulators.

`noBarrelFile`^Optional

public readonly noBarrelFile: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of barrel file.

`noDelete`^Optional

public readonly noDelete: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of the delete operator.

`noReExportAll`^Optional

public readonly noReExportAll: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Avoid re-export all.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

`useTopLevelRegex`^Optional

public readonly useTopLevelRegex: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Require regex literals to be declared at the top level.

IRestrictedGlobalsOptions

Implemented By: projen.javascript.biome.biome_config.IRestrictedGlobalsOptions

Options for the rule noRestrictedGlobals.

Properties

Name	Type	Description
`deniedGlobals`	`string[]`	A list of names that should trigger the rule.

`deniedGlobals`^Optional

public readonly deniedGlobals: string[];

Type: string[]

A list of names that should trigger the rule.

IRestrictedImportsOptions

Implemented By: projen.javascript.biome.biome_config.IRestrictedImportsOptions

Options for the rule noRestrictedImports.

Properties

Name	Type	Description
`paths`	`{[ key: string ]: string}`	A list of names that should trigger the rule.

`paths`^Optional

public readonly paths: {[ key: string ]: string};

Type: {[ key: string ]: string}

A list of names that should trigger the rule.

IRules

Implemented By: projen.javascript.biome.biome_config.IRules

Properties

Name	Type	Description
`a11y`	`projen.javascript.biome.biome_config.IA11y`	No description.
`all`	`boolean`	It enables ALL rules.
`complexity`	`projen.javascript.biome.biome_config.IComplexity`	No description.
`correctness`	`projen.javascript.biome.biome_config.ICorrectness`	No description.
`nursery`	`projen.javascript.biome.biome_config.INursery`	No description.
`performance`	`projen.javascript.biome.biome_config.IPerformance`	No description.
`recommended`	`boolean`	It enables the lint rules recommended by Biome.
`security`	`projen.javascript.biome.biome_config.ISecurity`	No description.
`style`	`projen.javascript.biome.biome_config.IStyle`	No description.
`suspicious`	`projen.javascript.biome.biome_config.ISuspicious`	No description.

`a11y`^Optional

public readonly a11y: IA11y;

Type: projen.javascript.biome.biome_config.IA11y

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules.

The rules that belong to nursery won't be enabled.

`complexity`^Optional

public readonly complexity: IComplexity;

Type: projen.javascript.biome.biome_config.IComplexity

`correctness`^Optional

public readonly correctness: ICorrectness;

Type: projen.javascript.biome.biome_config.ICorrectness

`nursery`^Optional

public readonly nursery: INursery;

Type: projen.javascript.biome.biome_config.INursery

`performance`^Optional

public readonly performance: IPerformance;

Type: projen.javascript.biome.biome_config.IPerformance

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the lint rules recommended by Biome.

true by default.

`security`^Optional

public readonly security: ISecurity;

Type: projen.javascript.biome.biome_config.ISecurity

`style`^Optional

public readonly style: IStyle;

Type: projen.javascript.biome.biome_config.IStyle

`suspicious`^Optional

public readonly suspicious: ISuspicious;

Type: projen.javascript.biome.biome_config.ISuspicious

IRuleWithAllowDomainOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithAllowDomainOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.IAllowDomainOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: IAllowDomainOptions;

Type: projen.javascript.biome.biome_config.IAllowDomainOptions

Rule's options.

IRuleWithComplexityOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithComplexityOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IComplexityOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IComplexityOptions;

Type: projen.javascript.biome.biome_config.IComplexityOptions

Rule's options.

IRuleWithConsistentArrayTypeOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithConsistentArrayTypeOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.IConsistentArrayTypeOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: IConsistentArrayTypeOptions;

Type: projen.javascript.biome.biome_config.IConsistentArrayTypeOptions

Rule's options.

IRuleWithConsistentMemberAccessibilityOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithConsistentMemberAccessibilityOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IConsistentMemberAccessibilityOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IConsistentMemberAccessibilityOptions;

Type: projen.javascript.biome.biome_config.IConsistentMemberAccessibilityOptions

Rule's options.

IRuleWithDeprecatedHooksOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithDeprecatedHooksOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IDeprecatedHooksOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IDeprecatedHooksOptions;

Type: projen.javascript.biome.biome_config.IDeprecatedHooksOptions

Rule's options.

IRuleWithFilenamingConventionOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithFilenamingConventionOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IFilenamingConventionOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IFilenamingConventionOptions;

Type: projen.javascript.biome.biome_config.IFilenamingConventionOptions

Rule's options.

IRuleWithFixNoOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

IRuleWithNamingConventionOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithNamingConventionOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.INamingConventionOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: INamingConventionOptions;

Type: projen.javascript.biome.biome_config.INamingConventionOptions

Rule's options.

IRuleWithNoConsoleOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithNoConsoleOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.INoConsoleOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: INoConsoleOptions;

Type: projen.javascript.biome.biome_config.INoConsoleOptions

Rule's options.

IRuleWithNoDoubleEqualsOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithNoDoubleEqualsOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.INoDoubleEqualsOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: INoDoubleEqualsOptions;

Type: projen.javascript.biome.biome_config.INoDoubleEqualsOptions

Rule's options.

IRuleWithNoLabelWithoutControlOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithNoLabelWithoutControlOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.INoLabelWithoutControlOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: INoLabelWithoutControlOptions;

Type: projen.javascript.biome.biome_config.INoLabelWithoutControlOptions

Rule's options.

IRuleWithNoOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithNoOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

IRuleWithNoRestrictedTypesOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithNoRestrictedTypesOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.INoRestrictedTypesOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: INoRestrictedTypesOptions;

Type: projen.javascript.biome.biome_config.INoRestrictedTypesOptions

Rule's options.

IRuleWithNoSecretsOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithNoSecretsOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.INoSecretsOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: INoSecretsOptions;

Type: projen.javascript.biome.biome_config.INoSecretsOptions

Rule's options.

IRuleWithRestrictedGlobalsOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithRestrictedGlobalsOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IRestrictedGlobalsOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IRestrictedGlobalsOptions;

Type: projen.javascript.biome.biome_config.IRestrictedGlobalsOptions

Rule's options.

IRuleWithRestrictedImportsOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithRestrictedImportsOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IRestrictedImportsOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IRestrictedImportsOptions;

Type: projen.javascript.biome.biome_config.IRestrictedImportsOptions

Rule's options.

IRuleWithUseComponentExportOnlyModulesOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithUseComponentExportOnlyModulesOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IUseComponentExportOnlyModulesOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IUseComponentExportOnlyModulesOptions;

Type: projen.javascript.biome.biome_config.IUseComponentExportOnlyModulesOptions

Rule's options.

IRuleWithUseExhaustiveDependenciesOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithUseExhaustiveDependenciesOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IUseExhaustiveDependenciesOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IUseExhaustiveDependenciesOptions;

Type: projen.javascript.biome.biome_config.IUseExhaustiveDependenciesOptions

Rule's options.

IRuleWithUseImportExtensionsOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithUseImportExtensionsOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.IUseImportExtensionsOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: IUseImportExtensionsOptions;

Type: projen.javascript.biome.biome_config.IUseImportExtensionsOptions

Rule's options.

IRuleWithUseValidAutocompleteOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithUseValidAutocompleteOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`options`	`projen.javascript.biome.biome_config.IUseValidAutocompleteOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`options`^Optional

public readonly options: IUseValidAutocompleteOptions;

Type: projen.javascript.biome.biome_config.IUseValidAutocompleteOptions

Rule's options.

IRuleWithUtilityClassSortingOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithUtilityClassSortingOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.IUtilityClassSortingOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: IUtilityClassSortingOptions;

Type: projen.javascript.biome.biome_config.IUtilityClassSortingOptions

Rule's options.

IRuleWithValidAriaRoleOptions

Implemented By: projen.javascript.biome.biome_config.IRuleWithValidAriaRoleOptions

Properties

Name	Type	Description
`level`	`string`	The severity of the emitted diagnostics by the rule.
`fix`	`string`	The kind of the code actions emitted by the rule.
`options`	`projen.javascript.biome.biome_config.IValidAriaRoleOptions`	Rule's options.

`level`^Required

public readonly level: string;

Type: string

The severity of the emitted diagnostics by the rule.

`fix`^Optional

public readonly fix: string;

Type: string

The kind of the code actions emitted by the rule.

`options`^Optional

public readonly options: IValidAriaRoleOptions;

Type: projen.javascript.biome.biome_config.IValidAriaRoleOptions

Rule's options.

ISecurity

Implemented By: projen.javascript.biome.biome_config.ISecurity

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noDangerouslySetInnerHtml`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevent the usage of dangerous JSX props.
`noDangerouslySetInnerHtmlWithChildren`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Report when a DOM element or a component uses both children and dangerouslySetInnerHTML prop.
`noGlobalEval`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of global eval().
`recommended`	`boolean`	It enables the recommended rules for this group.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noDangerouslySetInnerHtml`^Optional

public readonly noDangerouslySetInnerHtml: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevent the usage of dangerous JSX props.

`noDangerouslySetInnerHtmlWithChildren`^Optional

public readonly noDangerouslySetInnerHtmlWithChildren: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Report when a DOM element or a component uses both children and dangerouslySetInnerHTML prop.

`noGlobalEval`^Optional

public readonly noGlobalEval: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of global eval().

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

ISelector

Implemented By: projen.javascript.biome.biome_config.ISelector

Properties

Name	Type	Description
`kind`	`string`	Declaration kind.
`modifiers`	`string[]`	Modifiers used on the declaration.
`scope`	`string`	Scope of the declaration.

`kind`^Optional

public readonly kind: string;

Type: string

Declaration kind.

`modifiers`^Optional

public readonly modifiers: string[];

Type: string[]

Modifiers used on the declaration.

`scope`^Optional

public readonly scope: string;

Type: string

Scope of the declaration.

ISource

Implemented By: projen.javascript.biome.biome_config.ISource

A list of rules that belong to this group.

Properties

Name	Type	Description
`sortJsxProps`	`string`	Enforce props sorting in JSX elements.
`useSortedKeys`	`string`	Sorts the keys of a JSON object in natural order.

`sortJsxProps`^Optional

public readonly sortJsxProps: string;

Type: string

Enforce props sorting in JSX elements.

`useSortedKeys`^Optional

public readonly useSortedKeys: string;

Type: string

Sorts the keys of a JSON object in natural order.

IStyle

Implemented By: projen.javascript.biome.biome_config.IStyle

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noArguments`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of arguments.
`noCommaOperator`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow comma operator.
`noDefaultExport`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow default exports.
`noDoneCallback`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow using a callback in asynchronous tests and hooks.
`noImplicitBoolean`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow implicit true values on JSX boolean attributes.
`noInferrableTypes`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow type annotations for variables, parameters, and class properties initialized with a literal expression.
`noNamespace`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of TypeScript's namespaces.
`noNamespaceImport`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of namespace imports.
`noNegationElse`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow negation in the condition of an if statement if it has an else clause.
`noNonNullAssertion`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow non-null assertions using the !
`noParameterAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow reassigning function parameters.
`noParameterProperties`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the use of parameter properties in class constructors.
`noRestrictedGlobals`	`string \| projen.javascript.biome.biome_config.IRuleWithRestrictedGlobalsOptions`	This rule allows you to specify global variable names that you don’t want to use in your application.
`noShoutyConstants`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of constants which its value is the upper-case version of its name.
`noUnusedTemplateLiteral`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow template literals if interpolation and special-character handling are not needed.
`noUselessElse`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow else block when the if block breaks early.
`noVar`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of var.
`noYodaExpression`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of yoda expressions.
`recommended`	`boolean`	It enables the recommended rules for this group.
`useAsConstAssertion`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the use of as const over literal type and type annotation.
`useBlockStatements`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Requires following curly brace conventions.
`useCollapsedElseIf`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce using else if instead of nested if in else clauses.
`useConsistentArrayType`	`string \| projen.javascript.biome.biome_config.IRuleWithConsistentArrayTypeOptions`	Require consistently using either T[] or Array<T>.
`useConsistentBuiltinInstantiation`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the use of new for all builtins, except String, Number and Boolean.
`useConst`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Require const declarations for variables that are only assigned once.
`useDefaultParameterLast`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce default function parameters and optional function parameters to be last.
`useDefaultSwitchClause`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Require the default clause in switch statements.
`useEnumInitializers`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Require that each enum member value be explicitly initialized.
`useExplicitLengthCheck`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce explicitly comparing the length, size, byteLength or byteOffset property of a value.
`useExponentiationOperator`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of Math.pow in favor of the ** operator.
`useExportType`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Promotes the use of export type for types.
`useFilenamingConvention`	`string \| projen.javascript.biome.biome_config.IRuleWithFilenamingConventionOptions`	Enforce naming conventions for JavaScript and TypeScript filenames.
`useForOf`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	This rule recommends a for-of loop when in a for loop, the index used to extract an item from the iterated array.
`useFragmentSyntax`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	This rule enforces the use of <>...</> over <Fragment>...</Fragment>.
`useImportType`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Promotes the use of import type for types.
`useLiteralEnumMembers`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Require all enum members to be literal values.
`useNamingConvention`	`string \| projen.javascript.biome.biome_config.IRuleWithNamingConventionOptions`	Enforce naming conventions for everything across a codebase.
`useNodeAssertStrict`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Promotes the usage of node:assert/strict over node:assert.
`useNodejsImportProtocol`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforces using the node: protocol for Node.js builtin modules.
`useNumberNamespace`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use the Number properties instead of global ones.
`useNumericLiterals`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow parseInt() and Number.parseInt() in favor of binary, octal, and hexadecimal literals.
`useSelfClosingElements`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prevent extra closing tags for components without children.
`useShorthandArrayType`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	When expressing array types, this rule promotes the usage of T[] shorthand instead of Array<T>.
`useShorthandAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Require assignment operator shorthand where possible.
`useShorthandFunctionType`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce using function types instead of object type with call signatures.
`useSingleCaseStatement`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforces switch clauses have a single statement, emits a quick fix wrapping the statements in a block.
`useSingleVarDeclarator`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow multiple variable declarations in the same variable statement.
`useTemplate`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prefer template literals over string concatenation.
`useThrowNewError`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Require new when throwing an error.
`useThrowOnlyError`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow throwing non-Error values.
`useWhile`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce the use of while loops instead of for loops when the initializer and update expressions are not needed.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noArguments`^Optional

public readonly noArguments: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of arguments.

`noCommaOperator`^Optional

public readonly noCommaOperator: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow comma operator.

`noDefaultExport`^Optional

public readonly noDefaultExport: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow default exports.

`noDoneCallback`^Optional

public readonly noDoneCallback: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow using a callback in asynchronous tests and hooks.

`noImplicitBoolean`^Optional

public readonly noImplicitBoolean: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow implicit true values on JSX boolean attributes.

`noInferrableTypes`^Optional

public readonly noInferrableTypes: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow type annotations for variables, parameters, and class properties initialized with a literal expression.

`noNamespace`^Optional

public readonly noNamespace: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of TypeScript's namespaces.

`noNamespaceImport`^Optional

public readonly noNamespaceImport: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of namespace imports.

`noNegationElse`^Optional

public readonly noNegationElse: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow negation in the condition of an if statement if it has an else clause.

`noNonNullAssertion`^Optional

public readonly noNonNullAssertion: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow non-null assertions using the !

postfix operator.

`noParameterAssign`^Optional

public readonly noParameterAssign: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow reassigning function parameters.

`noParameterProperties`^Optional

public readonly noParameterProperties: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the use of parameter properties in class constructors.

`noRestrictedGlobals`^Optional

public readonly noRestrictedGlobals: string | IRuleWithRestrictedGlobalsOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithRestrictedGlobalsOptions

This rule allows you to specify global variable names that you don’t want to use in your application.

`noShoutyConstants`^Optional

public readonly noShoutyConstants: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of constants which its value is the upper-case version of its name.

`noUnusedTemplateLiteral`^Optional

public readonly noUnusedTemplateLiteral: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow template literals if interpolation and special-character handling are not needed.

`noUselessElse`^Optional

public readonly noUselessElse: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow else block when the if block breaks early.

`noVar`^Optional

public readonly noVar: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of var.

`noYodaExpression`^Optional

public readonly noYodaExpression: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of yoda expressions.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

`useAsConstAssertion`^Optional

public readonly useAsConstAssertion: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the use of as const over literal type and type annotation.

`useBlockStatements`^Optional

public readonly useBlockStatements: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Requires following curly brace conventions.

`useCollapsedElseIf`^Optional

public readonly useCollapsedElseIf: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce using else if instead of nested if in else clauses.

`useConsistentArrayType`^Optional

public readonly useConsistentArrayType: string | IRuleWithConsistentArrayTypeOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithConsistentArrayTypeOptions

Require consistently using either T[] or Array<T>.

`useConsistentBuiltinInstantiation`^Optional

public readonly useConsistentBuiltinInstantiation: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the use of new for all builtins, except String, Number and Boolean.

`useConst`^Optional

public readonly useConst: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Require const declarations for variables that are only assigned once.

`useDefaultParameterLast`^Optional

public readonly useDefaultParameterLast: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce default function parameters and optional function parameters to be last.

`useDefaultSwitchClause`^Optional

public readonly useDefaultSwitchClause: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Require the default clause in switch statements.

`useEnumInitializers`^Optional

public readonly useEnumInitializers: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Require that each enum member value be explicitly initialized.

`useExplicitLengthCheck`^Optional

public readonly useExplicitLengthCheck: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce explicitly comparing the length, size, byteLength or byteOffset property of a value.

`useExponentiationOperator`^Optional

public readonly useExponentiationOperator: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of Math.pow in favor of the ** operator.

`useExportType`^Optional

public readonly useExportType: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Promotes the use of export type for types.

`useFilenamingConvention`^Optional

public readonly useFilenamingConvention: string | IRuleWithFilenamingConventionOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFilenamingConventionOptions

Enforce naming conventions for JavaScript and TypeScript filenames.

`useForOf`^Optional

public readonly useForOf: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

This rule recommends a for-of loop when in a for loop, the index used to extract an item from the iterated array.

`useFragmentSyntax`^Optional

public readonly useFragmentSyntax: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

This rule enforces the use of <>...</> over <Fragment>...</Fragment>.

`useImportType`^Optional

public readonly useImportType: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Promotes the use of import type for types.

`useLiteralEnumMembers`^Optional

public readonly useLiteralEnumMembers: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Require all enum members to be literal values.

`useNamingConvention`^Optional

public readonly useNamingConvention: string | IRuleWithNamingConventionOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNamingConventionOptions

Enforce naming conventions for everything across a codebase.

`useNodeAssertStrict`^Optional

public readonly useNodeAssertStrict: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Promotes the usage of node:assert/strict over node:assert.

`useNodejsImportProtocol`^Optional

public readonly useNodejsImportProtocol: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforces using the node: protocol for Node.js builtin modules.

`useNumberNamespace`^Optional

public readonly useNumberNamespace: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use the Number properties instead of global ones.

`useNumericLiterals`^Optional

public readonly useNumericLiterals: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow parseInt() and Number.parseInt() in favor of binary, octal, and hexadecimal literals.

`useSelfClosingElements`^Optional

public readonly useSelfClosingElements: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prevent extra closing tags for components without children.

`useShorthandArrayType`^Optional

public readonly useShorthandArrayType: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

When expressing array types, this rule promotes the usage of T[] shorthand instead of Array<T>.

`useShorthandAssign`^Optional

public readonly useShorthandAssign: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Require assignment operator shorthand where possible.

`useShorthandFunctionType`^Optional

public readonly useShorthandFunctionType: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce using function types instead of object type with call signatures.

`useSingleCaseStatement`^Optional

public readonly useSingleCaseStatement: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforces switch clauses have a single statement, emits a quick fix wrapping the statements in a block.

`useSingleVarDeclarator`^Optional

public readonly useSingleVarDeclarator: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow multiple variable declarations in the same variable statement.

`useTemplate`^Optional

public readonly useTemplate: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prefer template literals over string concatenation.

`useThrowNewError`^Optional

public readonly useThrowNewError: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Require new when throwing an error.

`useThrowOnlyError`^Optional

public readonly useThrowOnlyError: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow throwing non-Error values.

`useWhile`^Optional

public readonly useWhile: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce the use of while loops instead of for loops when the initializer and update expressions are not needed.

ISuggestedExtensionMapping

Implemented By: projen.javascript.biome.biome_config.ISuggestedExtensionMapping

Properties

Name	Type	Description
`component`	`string`	Extension that should be used for component file imports.
`module`	`string`	Extension that should be used for module imports.

`component`^Optional

public readonly component: string;

Type: string

Extension that should be used for component file imports.

`module`^Optional

public readonly module: string;

Type: string

Extension that should be used for module imports.

ISuspicious

Implemented By: projen.javascript.biome.biome_config.ISuspicious

A list of rules that belong to this group.

Properties

Name	Type	Description
`all`	`boolean`	It enables ALL rules for this group.
`noApproximativeNumericConstant`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use standard constants instead of approximated literals.
`noArrayIndexKey`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Discourage the usage of Array index in keys.
`noAssignInExpressions`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow assignments in expressions.
`noAsyncPromiseExecutor`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallows using an async function as a Promise executor.
`noCatchAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow reassigning exceptions in catch clauses.
`noClassAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow reassigning class members.
`noCommentText`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prevent comments from being inserted as text nodes.
`noCompareNegZero`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow comparing against -0.
`noConfusingLabels`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow labeled statements that are not loops.
`noConfusingVoidType`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow void type outside of generic or return types.
`noConsole`	`string \| projen.javascript.biome.biome_config.IRuleWithNoConsoleOptions`	Disallow the use of console.
`noConsoleLog`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of console.log.
`noConstEnum`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow TypeScript const enum.
`noControlCharactersInRegex`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevents from having control characters and some escape sequences that match control characters in regular expressions.
`noDebugger`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the use of debugger.
`noDoubleEquals`	`string \| projen.javascript.biome.biome_config.IRuleWithNoDoubleEqualsOptions`	Require the use of === and !==.
`noDuplicateAtImportRules`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate.
`noDuplicateCase`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate case labels.
`noDuplicateClassMembers`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate class members.
`noDuplicateFontNames`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate names within font families.
`noDuplicateJsxProps`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Prevents JSX properties to be assigned multiple times.
`noDuplicateObjectKeys`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow two keys with the same name inside objects.
`noDuplicateParameters`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate function parameter name.
`noDuplicateSelectorsKeyframeBlock`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow duplicate selectors within keyframe blocks.
`noDuplicateTestHooks`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	A describe block should not contain duplicate hooks.
`noEmptyBlock`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow CSS empty blocks.
`noEmptyBlockStatements`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow empty block statements and static blocks.
`noEmptyInterface`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow the declaration of empty interfaces.
`noEvolvingTypes`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow variables from evolving into any type through reassignments.
`noExplicitAny`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow the any type usage.
`noExportsInTest`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow using export or module.exports in files containing tests.
`noExtraNonNullAssertion`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prevents the wrong usage of the non-null assertion operator (!) in TypeScript files.
`noFallthroughSwitchClause`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow fallthrough of switch clauses.
`noFocusedTests`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow focused tests.
`noFunctionAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow reassigning function declarations.
`noGlobalAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow assignments to native objects and read-only global variables.
`noGlobalIsFinite`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use Number.isFinite instead of global isFinite.
`noGlobalIsNan`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use Number.isNaN instead of global isNaN.
`noImplicitAnyLet`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow use of implicit any type on variable declarations.
`noImportantInKeyframe`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow invalid !important within keyframe declarations.
`noImportAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow assigning to imported bindings.
`noLabelVar`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow labels that share a name with a variable.
`noMisleadingCharacterClass`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow characters made with multiple code points in character class syntax.
`noMisleadingInstantiator`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce proper usage of new and constructor.
`noMisplacedAssertion`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Checks that the assertion function, for example expect, is placed inside an it() function call.
`noMisrefactoredShorthandAssign`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow shorthand assign when variable appears on both sides.
`noPrototypeBuiltins`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow direct use of Object.prototype builtins.
`noReactSpecificProps`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prevents React-specific JSX properties from being used.
`noRedeclare`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow variable, function, class, and type redeclarations in the same scope.
`noRedundantUseStrict`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Prevents from having redundant "use strict".
`noSelfCompare`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow comparisons where both sides are exactly the same.
`noShadowRestrictedNames`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow identifiers from shadowing restricted names.
`noShorthandPropertyOverrides`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow shorthand properties that override related longhand properties.
`noSkippedTests`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow disabled tests.
`noSparseArray`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow sparse arrays.
`noSuspiciousSemicolonInJsx`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	It detects possible "wrong" semicolons inside JSX elements.
`noThenProperty`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow then property.
`noUnsafeDeclarationMerging`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Disallow unsafe declaration merging between interfaces and classes.
`noUnsafeNegation`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Disallow using unsafe negation.
`recommended`	`boolean`	It enables the recommended rules for this group.
`useAwait`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Ensure async functions utilize await.
`useDefaultSwitchClauseLast`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce default clauses in switch statements to be last.
`useErrorMessage`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce passing a message value when creating a built-in error.
`useGetterReturn`	`string \| projen.javascript.biome.biome_config.IRuleWithNoOptions`	Enforce get methods to always return a value.
`useIsArray`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Use Array.isArray() instead of instanceof Array.
`useNamespaceKeyword`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Require using the namespace keyword over the module keyword to declare TypeScript namespaces.
`useNumberToFixedDigitsArgument`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	Enforce using the digits argument with Number#toFixed().
`useValidTypeof`	`string \| projen.javascript.biome.biome_config.IRuleWithFixNoOptions`	This rule verifies the result of typeof $expr unary expressions is being compared to valid values, either string literals containing valid type names or other typeof expressions.

`all`^Optional

public readonly all: boolean;

Type: boolean

It enables ALL rules for this group.

`noApproximativeNumericConstant`^Optional

public readonly noApproximativeNumericConstant: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use standard constants instead of approximated literals.

`noArrayIndexKey`^Optional

public readonly noArrayIndexKey: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Discourage the usage of Array index in keys.

`noAssignInExpressions`^Optional

public readonly noAssignInExpressions: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow assignments in expressions.

`noAsyncPromiseExecutor`^Optional

public readonly noAsyncPromiseExecutor: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallows using an async function as a Promise executor.

`noCatchAssign`^Optional

public readonly noCatchAssign: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow reassigning exceptions in catch clauses.

`noClassAssign`^Optional

public readonly noClassAssign: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow reassigning class members.

`noCommentText`^Optional

public readonly noCommentText: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prevent comments from being inserted as text nodes.

`noCompareNegZero`^Optional

public readonly noCompareNegZero: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow comparing against -0.

`noConfusingLabels`^Optional

public readonly noConfusingLabels: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow labeled statements that are not loops.

`noConfusingVoidType`^Optional

public readonly noConfusingVoidType: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow void type outside of generic or return types.

`noConsole`^Optional

public readonly noConsole: string | IRuleWithNoConsoleOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoConsoleOptions

Disallow the use of console.

`noConsoleLog`^Optional

public readonly noConsoleLog: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of console.log.

`noConstEnum`^Optional

public readonly noConstEnum: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow TypeScript const enum.

`noControlCharactersInRegex`^Optional

public readonly noControlCharactersInRegex: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevents from having control characters and some escape sequences that match control characters in regular expressions.

`noDebugger`^Optional

public readonly noDebugger: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the use of debugger.

`noDoubleEquals`^Optional

public readonly noDoubleEquals: string | IRuleWithNoDoubleEqualsOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoDoubleEqualsOptions

Require the use of === and !==.

`noDuplicateAtImportRules`^Optional

public readonly noDuplicateAtImportRules: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate.

`noDuplicateCase`^Optional

public readonly noDuplicateCase: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate case labels.

`noDuplicateClassMembers`^Optional

public readonly noDuplicateClassMembers: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate class members.

`noDuplicateFontNames`^Optional

public readonly noDuplicateFontNames: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate names within font families.

`noDuplicateJsxProps`^Optional

public readonly noDuplicateJsxProps: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Prevents JSX properties to be assigned multiple times.

`noDuplicateObjectKeys`^Optional

public readonly noDuplicateObjectKeys: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow two keys with the same name inside objects.

`noDuplicateParameters`^Optional

public readonly noDuplicateParameters: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate function parameter name.

`noDuplicateSelectorsKeyframeBlock`^Optional

public readonly noDuplicateSelectorsKeyframeBlock: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow duplicate selectors within keyframe blocks.

`noDuplicateTestHooks`^Optional

public readonly noDuplicateTestHooks: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

A describe block should not contain duplicate hooks.

`noEmptyBlock`^Optional

public readonly noEmptyBlock: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow CSS empty blocks.

`noEmptyBlockStatements`^Optional

public readonly noEmptyBlockStatements: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow empty block statements and static blocks.

`noEmptyInterface`^Optional

public readonly noEmptyInterface: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow the declaration of empty interfaces.

`noEvolvingTypes`^Optional

public readonly noEvolvingTypes: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow variables from evolving into any type through reassignments.

`noExplicitAny`^Optional

public readonly noExplicitAny: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow the any type usage.

`noExportsInTest`^Optional

public readonly noExportsInTest: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow using export or module.exports in files containing tests.

`noExtraNonNullAssertion`^Optional

public readonly noExtraNonNullAssertion: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prevents the wrong usage of the non-null assertion operator (!) in TypeScript files.

`noFallthroughSwitchClause`^Optional

public readonly noFallthroughSwitchClause: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow fallthrough of switch clauses.

`noFocusedTests`^Optional

public readonly noFocusedTests: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow focused tests.

`noFunctionAssign`^Optional

public readonly noFunctionAssign: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow reassigning function declarations.

`noGlobalAssign`^Optional

public readonly noGlobalAssign: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow assignments to native objects and read-only global variables.

`noGlobalIsFinite`^Optional

public readonly noGlobalIsFinite: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use Number.isFinite instead of global isFinite.

`noGlobalIsNan`^Optional

public readonly noGlobalIsNan: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use Number.isNaN instead of global isNaN.

`noImplicitAnyLet`^Optional

public readonly noImplicitAnyLet: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow use of implicit any type on variable declarations.

`noImportantInKeyframe`^Optional

public readonly noImportantInKeyframe: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow invalid !important within keyframe declarations.

`noImportAssign`^Optional

public readonly noImportAssign: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow assigning to imported bindings.

`noLabelVar`^Optional

public readonly noLabelVar: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow labels that share a name with a variable.

`noMisleadingCharacterClass`^Optional

public readonly noMisleadingCharacterClass: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow characters made with multiple code points in character class syntax.

`noMisleadingInstantiator`^Optional

public readonly noMisleadingInstantiator: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce proper usage of new and constructor.

`noMisplacedAssertion`^Optional

public readonly noMisplacedAssertion: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Checks that the assertion function, for example expect, is placed inside an it() function call.

`noMisrefactoredShorthandAssign`^Optional

public readonly noMisrefactoredShorthandAssign: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow shorthand assign when variable appears on both sides.

`noPrototypeBuiltins`^Optional

public readonly noPrototypeBuiltins: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow direct use of Object.prototype builtins.

`noReactSpecificProps`^Optional

public readonly noReactSpecificProps: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prevents React-specific JSX properties from being used.

`noRedeclare`^Optional

public readonly noRedeclare: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow variable, function, class, and type redeclarations in the same scope.

`noRedundantUseStrict`^Optional

public readonly noRedundantUseStrict: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Prevents from having redundant "use strict".

`noSelfCompare`^Optional

public readonly noSelfCompare: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow comparisons where both sides are exactly the same.

`noShadowRestrictedNames`^Optional

public readonly noShadowRestrictedNames: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow identifiers from shadowing restricted names.

`noShorthandPropertyOverrides`^Optional

public readonly noShorthandPropertyOverrides: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow shorthand properties that override related longhand properties.

`noSkippedTests`^Optional

public readonly noSkippedTests: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow disabled tests.

`noSparseArray`^Optional

public readonly noSparseArray: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow sparse arrays.

`noSuspiciousSemicolonInJsx`^Optional

public readonly noSuspiciousSemicolonInJsx: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

It detects possible "wrong" semicolons inside JSX elements.

`noThenProperty`^Optional

public readonly noThenProperty: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow then property.

`noUnsafeDeclarationMerging`^Optional

public readonly noUnsafeDeclarationMerging: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Disallow unsafe declaration merging between interfaces and classes.

`noUnsafeNegation`^Optional

public readonly noUnsafeNegation: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Disallow using unsafe negation.

`recommended`^Optional

public readonly recommended: boolean;

Type: boolean

It enables the recommended rules for this group.

`useAwait`^Optional

public readonly useAwait: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Ensure async functions utilize await.

`useDefaultSwitchClauseLast`^Optional

public readonly useDefaultSwitchClauseLast: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce default clauses in switch statements to be last.

`useErrorMessage`^Optional

public readonly useErrorMessage: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce passing a message value when creating a built-in error.

`useGetterReturn`^Optional

public readonly useGetterReturn: string | IRuleWithNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithNoOptions

Enforce get methods to always return a value.

`useIsArray`^Optional

public readonly useIsArray: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Use Array.isArray() instead of instanceof Array.

`useNamespaceKeyword`^Optional

public readonly useNamespaceKeyword: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Require using the namespace keyword over the module keyword to declare TypeScript namespaces.

`useNumberToFixedDigitsArgument`^Optional

public readonly useNumberToFixedDigitsArgument: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

Enforce using the digits argument with Number#toFixed().

`useValidTypeof`^Optional

public readonly useValidTypeof: string | IRuleWithFixNoOptions;

Type: string | projen.javascript.biome.biome_config.IRuleWithFixNoOptions

This rule verifies the result of typeof $expr unary expressions is being compared to valid values, either string literals containing valid type names or other typeof expressions.

IUseComponentExportOnlyModulesOptions

Implemented By: projen.javascript.biome.biome_config.IUseComponentExportOnlyModulesOptions

Properties

Name	Type	Description
`allowConstantExport`	`boolean`	Allows the export of constants.
`allowExportNames`	`string[]`	A list of names that can be additionally exported from the module This option is for exports that do not hinder React Fast Refresh, such as `meta` in Remix.

`allowConstantExport`^Optional

public readonly allowConstantExport: boolean;

Type: boolean

Allows the export of constants.

This option is for environments that support it, such as Vite

`allowExportNames`^Optional

public readonly allowExportNames: string[];

Type: string[]

A list of names that can be additionally exported from the module This option is for exports that do not hinder React Fast Refresh, such as meta in Remix.

IUseExhaustiveDependenciesOptions

Implemented By: projen.javascript.biome.biome_config.IUseExhaustiveDependenciesOptions

Options for the rule useExhaustiveDependencies.

Properties

Name	Type	Description
`hooks`	`projen.javascript.biome.biome_config.IHook[]`	List of hooks of which the dependencies should be validated.
`reportMissingDependenciesArray`	`boolean`	Whether to report an error when a hook has no dependencies array.
`reportUnnecessaryDependencies`	`boolean`	Whether to report an error when a dependency is listed in the dependencies array but isn't used.

`hooks`^Optional

public readonly hooks: IHook[];

Type: projen.javascript.biome.biome_config.IHook[]

List of hooks of which the dependencies should be validated.

`reportMissingDependenciesArray`^Optional

public readonly reportMissingDependenciesArray: boolean;

Type: boolean

Whether to report an error when a hook has no dependencies array.

`reportUnnecessaryDependencies`^Optional

public readonly reportUnnecessaryDependencies: boolean;

Type: boolean

Whether to report an error when a dependency is listed in the dependencies array but isn't used.

Defaults to true.

IUseImportExtensionsOptions

Implemented By: projen.javascript.biome.biome_config.IUseImportExtensionsOptions

Properties

Name	Type	Description
`suggestedExtensions`	`{[ key: string ]: projen.javascript.biome.biome_config.ISuggestedExtensionMapping}`	A map of custom import extension mappings, where the key is the inspected file extension, and the value is a pair of `module` extension and `component` import extension.

`suggestedExtensions`^Optional

public readonly suggestedExtensions: {[ key: string ]: ISuggestedExtensionMapping};

Type: {[ key: string ]: projen.javascript.biome.biome_config.ISuggestedExtensionMapping}

A map of custom import extension mappings, where the key is the inspected file extension, and the value is a pair of module extension and component import extension.

IUseValidAutocompleteOptions

Implemented By: projen.javascript.biome.biome_config.IUseValidAutocompleteOptions

Properties

Name	Type	Description
`inputComponents`	`string[]`	`input` like custom components that should be checked.

`inputComponents`^Optional

public readonly inputComponents: string[];

Type: string[]

input like custom components that should be checked.

IUtilityClassSortingOptions

Implemented By: projen.javascript.biome.biome_config.IUtilityClassSortingOptions

Properties

Name	Type	Description
`attributes`	`string[]`	Additional attributes that will be sorted.
`functions`	`string[]`	Names of the functions or tagged templates that will be sorted.

`attributes`^Optional

public readonly attributes: string[];

Type: string[]

Additional attributes that will be sorted.

`functions`^Optional

public readonly functions: string[];

Type: string[]

Names of the functions or tagged templates that will be sorted.

IValidAriaRoleOptions

Implemented By: projen.javascript.biome.biome_config.IValidAriaRoleOptions

Properties

Name	Type	Description
`allowInvalidRoles`	`string[]`	No description.
`ignoreNonDom`	`boolean`	No description.

`allowInvalidRoles`^Optional

public readonly allowInvalidRoles: string[];

Type: string[]

`ignoreNonDom`^Optional

public readonly ignoreNonDom: boolean;

Type: boolean

IVcsConfiguration

Implemented By: projen.javascript.biome.biome_config.IVcsConfiguration

Set of properties to integrate Biome with a VCS software.

Properties

Name	Type	Description
`clientKind`	`string`	The kind of client.
`defaultBranch`	`string`	The main branch of the project.
`enabled`	`boolean`	Whether Biome should integrate itself with the VCS client.
`root`	`string`	The folder where Biome should check for VCS files.
`useIgnoreFile`	`boolean`	Whether Biome should use the VCS ignore file.

`clientKind`^Optional

public readonly clientKind: string;

Type: string

The kind of client.

`defaultBranch`^Optional

public readonly defaultBranch: string;

Type: string

The main branch of the project.

`enabled`^Optional

public readonly enabled: boolean;

Type: boolean

Whether Biome should integrate itself with the VCS client.

`root`^Optional

public readonly root: string;

Type: string

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

`useIgnoreFile`^Optional

public readonly useIgnoreFile: boolean;

Type: boolean

Whether Biome should use the VCS ignore file.

When [true], Biome will ignore the files specified in the ignore file.

javascript.biome.biome_config Submodule

Protocols ​

IA11y ​

Properties ​

allOptional ​

noAccessKeyOptional ​

noAriaHiddenOnFocusableOptional ​

noAriaUnsupportedElementsOptional ​

noAutofocusOptional ​

noBlankTargetOptional ​

noDistractingElementsOptional ​

noHeaderScopeOptional ​

noInteractiveElementToNoninteractiveRoleOptional ​

noLabelWithoutControlOptional ​

noNoninteractiveElementToInteractiveRoleOptional ​

noNoninteractiveTabindexOptional ​

noPositiveTabindexOptional ​

noRedundantAltOptional ​

noRedundantRolesOptional ​

noSvgWithoutTitleOptional ​

recommendedOptional ​

useAltTextOptional ​

useAnchorContentOptional ​

useAriaActivedescendantWithTabindexOptional ​

useAriaPropsForRoleOptional ​

useButtonTypeOptional ​

useFocusableInteractiveOptional ​

useGenericFontNamesOptional ​

useHeadingContentOptional ​

useHtmlLangOptional ​

useIframeTitleOptional ​

useKeyWithClickEventsOptional ​

useKeyWithMouseEventsOptional ​

useMediaCaptionOptional ​

useSemanticElementsOptional ​

useValidAnchorOptional ​

useValidAriaPropsOptional ​

useValidAriaRoleOptional ​

useValidAriaValuesOptional ​

useValidLangOptional ​

IActions ​

Properties ​

sourceOptional ​

IAllowDomainOptions ​

Properties ​

allowDomainsOptional ​

IAssistsConfiguration ​

Properties ​

actionsOptional ​

enabledOptional ​

ignoreOptional ​

includeOptional ​

IComplexity ​

Properties ​

allOptional ​

noBannedTypesOptional ​

noEmptyTypeParametersOptional ​

noExcessiveCognitiveComplexityOptional ​

noExcessiveNestedTestSuitesOptional ​

noExtraBooleanCastOptional ​

noForEachOptional ​

noMultipleSpacesInRegularExpressionLiteralsOptional ​

noStaticOnlyClassOptional ​

noThisInStaticOptional ​

noUselessCatchOptional ​

noUselessConstructorOptional ​

noUselessEmptyExportOptional ​

noUselessFragmentsOptional ​

noUselessLabelOptional ​

noUselessLoneBlockStatementsOptional ​

noUselessRenameOptional ​

noUselessStringConcatOptional ​

noUselessSwitchCaseOptional ​

noUselessTernaryOptional ​

noUselessThisAliasOptional ​

noUselessTypeConstraintOptional ​

noUselessUndefinedInitializationOptional ​

noVoidOptional ​

noWithOptional ​

recommendedOptional ​

`javascript.biome.biome_config` Submodule

Protocols

IA11y

Properties

`all`^Optional

`noAccessKey`^Optional

`noAriaHiddenOnFocusable`^Optional

`noAriaUnsupportedElements`^Optional

`noAutofocus`^Optional

`noBlankTarget`^Optional

`noDistractingElements`^Optional

`noHeaderScope`^Optional

`noInteractiveElementToNoninteractiveRole`^Optional

`noLabelWithoutControl`^Optional

`noNoninteractiveElementToInteractiveRole`^Optional

`noNoninteractiveTabindex`^Optional

`noPositiveTabindex`^Optional

`noRedundantAlt`^Optional

`noRedundantRoles`^Optional

`noSvgWithoutTitle`^Optional

`recommended`^Optional

`useAltText`^Optional

`useAnchorContent`^Optional

`useAriaActivedescendantWithTabindex`^Optional

`useAriaPropsForRole`^Optional

`useButtonType`^Optional

`useFocusableInteractive`^Optional

`useGenericFontNames`^Optional

`useHeadingContent`^Optional

`useHtmlLang`^Optional

`useIframeTitle`^Optional

`useKeyWithClickEvents`^Optional

`useKeyWithMouseEvents`^Optional

`useMediaCaption`^Optional

`useSemanticElements`^Optional

`useValidAnchor`^Optional

`useValidAriaProps`^Optional

`useValidAriaRole`^Optional

`useValidAriaValues`^Optional

`useValidLang`^Optional

IActions

Properties

`source`^Optional

IAllowDomainOptions

Properties

`allowDomains`^Optional

IAssistsConfiguration

Properties

`actions`^Optional

`enabled`^Optional

`ignore`^Optional

`include`^Optional

IComplexity

Properties

`all`^Optional

`noBannedTypes`^Optional

`noEmptyTypeParameters`^Optional

`noExcessiveCognitiveComplexity`^Optional

`noExcessiveNestedTestSuites`^Optional

`noExtraBooleanCast`^Optional

`noForEach`^Optional

`noMultipleSpacesInRegularExpressionLiterals`^Optional

`noStaticOnlyClass`^Optional

`noThisInStatic`^Optional

`noUselessCatch`^Optional

`noUselessConstructor`^Optional

`noUselessEmptyExport`^Optional

`noUselessFragments`^Optional

`noUselessLabel`^Optional

`noUselessLoneBlockStatements`^Optional

`noUselessRename`^Optional

`noUselessStringConcat`^Optional

`noUselessSwitchCase`^Optional

`noUselessTernary`^Optional

`noUselessThisAlias`^Optional

`noUselessTypeConstraint`^Optional

`noUselessUndefinedInitialization`^Optional

`noVoid`^Optional

`noWith`^Optional

`recommended`^Optional