Class StandardGuideline<T, C>`Abstract`

Represents a standard guideline that detects and corrects violations in the code according to a particular coding standard.

Need to implement/define:

initialValue()
match($jp, logErrors)
apply($jp)

Type Parameters

T
C extends Context<T> = Context<T>

Hierarchy (View Summary)

VisitWithContext<T, C>
- StandardGuideline
  - MISRARule

Index

Constructors

Properties

Accessors

dependencies name

Methods

apply initialValue match

Constructors

constructor

new StandardGuideline<T, C extends Context<T> = Context<T>>(
context: C,
): StandardGuideline<T, C>
Type Parameters
- T
- C extends Context<T> = Context<T>
Parameters
- context: C
  Shared context object
Returns StandardGuideline<T, C>
Inherited from VisitWithContext.constructor
- Defined in ast-visitor/VisitWithContext.ts:18

Properties

`Protected`context

context: C

Accessors

dependencies

get dependencies(): Visit[]
Returns Visit[]
List of dependent visits, which is empty by default
Inherited from VisitWithContext.dependencies
- Defined in ast-visitor/Visit.ts:23

name

get name(): string
Returns string
Visit name, defaults to class name
Inherited from VisitWithContext.name
- Defined in ast-visitor/VisitWithContext.ts:27

Methods

`Abstract`apply

apply($jp: LaraJoinPoint): unknown
Applies the transformation to the given node
Parameters
- $jp: LaraJoinPoint
  The node to transform
Returns unknown
Transformation result
Inherited from VisitWithContext.apply
- Defined in ast-visitor/VisitWithContext.ts:41

`Abstract`initialValue

initialValue(): T
Returns T
Initial value stored in the shared context
Inherited from VisitWithContext.initialValue
- Defined in ast-visitor/VisitWithContext.ts:34

`Abstract`match

match($jp: Joinpoint, logErrors: boolean): boolean
Checks if the joinpoint violates the guideline
Parameters
- $jp: Joinpoint
  Joinpoint to analyze
- logErrors: boolean
  [logErrors=false] - Whether to log errors if a violation is detected
Returns boolean
Returns true if the joinpoint violates the guideline, false otherwise
- Defined in StandardGuideline.ts:22