# Class: EnforceRationale
@boll/rules-core › Globals › EnforceRationale
# Class: EnforceRationale
EnforceRationale ensures specified fields in package.json require a rationale for any additions.
# Hierarchy
- EnforceRationale
# Implements
- PackageRule
# Index
# Constructors
# Properties
# Accessors
# Methods
# Constructors
# constructor
+ new EnforceRationale(options: EnforceRationaleOptions): EnforceRationale
Defined in enforce-rationale.ts:16
Parameters:
| Name | Type | Default |
|---|---|---|
options | EnforceRationaleOptions | defaultOptions |
Returns: EnforceRationale
# Properties
# Private options
• options: EnforceRationaleOptions
Defined in enforce-rationale.ts:17
# Accessors
# name
• get name(): string
Defined in enforce-rationale.ts:19
Returns: string
# Methods
# check
▸ check(file: FileContext): Promise‹Result[]›
Defined in enforce-rationale.ts:23
Parameters:
| Name | Type |
|---|---|
file | FileContext |
Returns: Promise‹Result[]›
# Private getEntriesForField
▸ getEntriesForField(contents: any, field: string): any
Defined in enforce-rationale.ts:104
Parameters:
| Name | Type |
|---|---|
contents | any |
field | string |
Returns: any