Class RequiredWhenValidator

Abstract base class for semantic validators

All semantic validators must extend this class and implement the validate() method.

Hierarchy (View Summary)

SemanticValidator
- RequiredWhenValidator

Index

Constructors

constructor

new RequiredWhenValidator(): RequiredWhenValidator
Returns RequiredWhenValidator
Inherited from SemanticValidator.constructor

Accessors

EvaluatesAbsentProp

get EvaluatesAbsentProp(): boolean
Whether this validator also runs when the parent does not pass the property at all.

By default a constraint is checked only against a prop the element actually passes, because most constraints describe a value ("these are field names on the entity") and have nothing to say about a missing one. A validator whose rule is about absence — "this prop must be set", "this prop must be set when another one is" — overrides this to return true. It is then also called for a missing prop, with context.PropertyPresent === false and context.propertyValue === undefined, and must handle that case.

It is still not called for a missing prop when the element spreads props (<Grid {...props} />), since the spread may supply it.

Returns boolean
Inherited from SemanticValidator.EvaluatesAbsentProp
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:94

Methods

`Protected`applyErrorTemplate

applyErrorTemplate(
    constraint: PropertyConstraint,
    context: ValidationContext,
    defaultMessage: string,
    templateVars?: Record<string, any>,
): string
Apply custom error template

If the constraint has an errorTemplate, applies it by replacing template variables with actual values.

Template variables:
- {property} - Property name from context
- {value} - Property value from context
- {constraint} - Constraint type
- Custom variables from templateVars parameter
Parameters
- constraint: PropertyConstraint
  Constraint definition
- context: ValidationContext
  Validation context
- defaultMessage: string
  Default message to use if no template
- templateVars: Record<string, any> = {}
  Additional template variables
Returns string
Formatted message
Example
```
// Constraint: { errorTemplate: "Field '{field}' not found on {entityName}" }
const message = this.applyErrorTemplate(
  constraint,
  context,
  `Field '${field}' does not exist`,
  { field: 'FullName', entityName: 'Members' }
);
// => "Field 'FullName' not found on Members"
```
Inherited from SemanticValidator.applyErrorTemplate
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:303

`Protected`createViolation

createViolation(
    type: string,
    message: string,
    severity?: "critical" | "high" | "medium" | "low",
    suggestion?: string,
    metadata?: Record<string, any>,
): ConstraintViolation
Create a violation with consistent formatting

Helper method to create ConstraintViolation objects with common fields populated.
Parameters
- type: string
  Violation type (e.g., 'invalid-field', 'type-mismatch')
- message: string
  Error message
- severity: "critical" | "high" | "medium" | "low" = 'high'
  Severity level (default: 'high')
- Optionalsuggestion: string
  Optional fix suggestion
- Optionalmetadata: Record<string, any>
  Optional additional metadata
Returns ConstraintViolation
ConstraintViolation object
Example
```
return [
  this.createViolation(
    'invalid-field',
    `Field '${field}' does not exist on entity '${entityName}'`,
    'critical',
    `Use one of: ${validFields.join(', ')}`,
    { field, entityName, validFields }
  )
];
```
Inherited from SemanticValidator.createViolation
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:181

`Protected`equalsCaseInsensitive

equalsCaseInsensitive(a: string, b: string): boolean
Case-insensitive string comparison
Parameters
- a: string
  First string
- b: string
  Second string
Returns boolean
True if strings are equal (case-insensitive)
Inherited from SemanticValidator.equalsCaseInsensitive
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:417

`Protected`findSimilar

findSimilar(
    target: string,
    candidates: string[],
    maxResults?: number,
    maxDistance?: number,
): string[]
Find similar strings using Levenshtein distance

Returns strings sorted by similarity (most similar first).
Parameters
- target: string
  The target string to find matches for
- candidates: string[]
  Array of candidate strings
- maxResults: number = 3
  Maximum number of results (default: 3)
- maxDistance: number = 3
  Maximum edit distance to consider (default: 3)
Returns string[]
Array of similar strings, sorted by distance
Example
```
const fields = ['FirstName', 'LastName', 'Email', 'Status'];
const similar = this.findSimilar('FristName', fields, 2);
// => ['FirstName'] (edit distance 1)
```
Inherited from SemanticValidator.findSimilar
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:393

`Protected`formatValueList

formatValueList(values: any[], maxItems?: number): string
Format a list of values for error messages

Truncates long lists with "..." and formats values nicely.
Parameters
- values: any[]
  Array of values
- maxItems: number = 10
  Maximum items to show (default: 10)
Returns string
Formatted string
Example
```
const fields = ['FirstName', 'LastName', 'Email', ...]; // 50 fields
const formatted = this.formatValueList(fields, 5);
// => "FirstName, LastName, Email, Status, JoinDate... (45 more)"
```
Inherited from SemanticValidator.formatValueList
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:259

`Protected`getDependentPropValue

getDependentPropValue(
context: ValidationContext,
constraint: PropertyConstraint,
): any
Get the dependent prop value

If the constraint has a dependsOn field, this method retrieves the value of that dependent prop from sibling props.

Returns null if:
- No dependency is specified
- The dependent prop is not found
- The dependent prop has a dynamic value
Parameters
- context: ValidationContext
  Validation context
- constraint: PropertyConstraint
  Constraint definition
Returns any
The dependent prop value, or null if not available
Example
```
// Constraint: { type: 'subset-of-entity-fields', dependsOn: 'entityName' }
const entityName = this.getDependentPropValue(context, constraint);
if (!entityName) {
  // Can't validate - entityName not provided or is dynamic
  return [];
}
```
Inherited from SemanticValidator.getDependentPropValue
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:222

getDescription

getDescription(): string
Get description of this validator

Returns string
Overrides SemanticValidator.getDescription
- Defined in React/linter/src/schema-validation/semantic-validators/required-when-validator.ts:34

getName

getName(): string
Returns string
Deprecated
Use GetName.
Inherited from SemanticValidator.getName
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:111

GetName

GetName(): string
Get the name of this validator

Used for debugging and error messages. Defaults to the class name, but can be overridden.

Returns string
Validator name
Inherited from SemanticValidator.GetName
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:106

`Protected`includesCaseInsensitive

includesCaseInsensitive(arr: string[], value: string): boolean
Check if array contains value (case-insensitive for strings)
Parameters
- arr: string[]
  Array to search
- value: string
  Value to find
Returns boolean
True if array contains the value
Inherited from SemanticValidator.includesCaseInsensitive
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:428

`Protected`isDynamicValue

isDynamicValue(value: any): value is DynamicValue
Check if a value is dynamic (can't be validated statically)

Dynamic values include identifiers (variables) and expressions (function calls, etc.) that can't be resolved at lint-time.
Parameters
- value: any
  The extracted value to check
Returns value is DynamicValue
True if the value is dynamic
Example
```
if (this.isDynamicValue(context.propertyValue)) {
  return []; // Skip validation
}
```
Inherited from SemanticValidator.isDynamicValue
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:152

`Protected`levenshteinDistance

levenshteinDistance(a: string, b: string): number
Calculate Levenshtein distance between two strings

Used for finding similar field names for "Did you mean?" suggestions.
Parameters
- a: string
  First string
- b: string
  Second string
Returns number
Edit distance
Inherited from SemanticValidator.levenshteinDistance
- Defined in React/linter/src/schema-validation/semantic-validators/semantic-validator.ts:344

validate

validate(
context: ValidationContext,
constraint: PropertyConstraint,
): ConstraintViolation[]
Validate that a property is present when a condition is met

Evaluates a JavaScript condition expression with the dependent property value, and checks if the current property has a value when the condition is true.
Parameters
- context: ValidationContext
  Validation context containing property info and sibling props
- constraint: PropertyConstraint
  The constraint definition from the spec
Returns ConstraintViolation[]
Array of violations (empty if valid)
Overrides SemanticValidator.validate
- Defined in React/linter/src/schema-validation/semantic-validators/required-when-validator.ts:48

Class RequiredWhenValidator

Hierarchy (View Summary)

Index

Constructors

Accessors

Methods

Constructors

constructor

Returns RequiredWhenValidator

Accessors

EvaluatesAbsentProp

Returns boolean

Methods

ProtectedapplyErrorTemplate

Parameters

Returns string

Example

ProtectedcreateViolation

Parameters

Returns ConstraintViolation

Example

ProtectedequalsCaseInsensitive

Parameters

Returns boolean

ProtectedfindSimilar

Parameters

Returns string[]

Example

ProtectedformatValueList

Parameters

Returns string

Example

ProtectedgetDependentPropValue

Parameters

Returns any

Example

getDescription

Returns string

getName

Returns string

Deprecated

GetName

Returns string

ProtectedincludesCaseInsensitive

Parameters

Returns boolean

ProtectedisDynamicValue

Parameters

Returns value is DynamicValue

Example

ProtectedlevenshteinDistance

Parameters

Returns number

validate

Parameters

Returns ConstraintViolation[]

Settings

On This Page

`Protected`applyErrorTemplate

`Protected`createViolation

`Protected`equalsCaseInsensitive

`Protected`findSimilar

`Protected`formatValueList

`Protected`getDependentPropValue

`Protected`includesCaseInsensitive

`Protected`isDynamicValue

`Protected`levenshteinDistance