# Class: PackageConsistency
@boll/rules-core › Globals › PackageConsistency
# Class: PackageConsistency
PackageConsistency ensures
- Package name should match package directory name.
- Packages must specify version
- Packages should be private by default
# Hierarchy
- PackageConsistency
# Implements
- PackageRule
# Index
# Constructors
# Properties
# Accessors
# Methods
# Constructors
# constructor
+ new PackageConsistency(options: Partial‹PackageConsistencyOptions›): PackageConsistency
Defined in package-consistency.ts:24
Parameters:
| Name | Type | Default |
|---|---|---|
options | Partial‹PackageConsistencyOptions› | defaultOptions |
Returns: PackageConsistency
# Properties
# options
• options: PackageConsistencyOptions
Defined in package-consistency.ts:24
# Accessors
# name
• get name(): string
Defined in package-consistency.ts:30
Returns: string
# Methods
# check
▸ check(file: FileContext): Promise‹Result[]›
Defined in package-consistency.ts:34
Parameters:
| Name | Type |
|---|---|
file | FileContext |
Returns: Promise‹Result[]›
# doNamesAlign
▸ doNamesAlign(name: string, packageRoot: BollDirectory): boolean
Defined in package-consistency.ts:59
Parameters:
| Name | Type |
|---|---|
name | string |
packageRoot | BollDirectory |
Returns: boolean