# Class: UnusedDependencyDetector
@boll/rules-typescript › Globals › UnusedDependencyDetector
# Class: UnusedDependencyDetector
UnusedDependencyDetector detects packages declared as dependencies or devDependencies that are not imported anywhere in code.
# Hierarchy
- UnusedDependencyDetector
# Implements
- PackageMetaRule
# Index
# Constructors
# Properties
# Accessors
# Methods
- check
- checkPackageImports
- getFilePackageImports
- getPackageNameFromImportPath
- getPathFromNode
- initializeDependencyCounts
- isExcluded
# Constructors
# constructor
+ new UnusedDependencyDetector(options?: Partial‹UnusedDependencyDetectorOptions›): UnusedDependencyDetector
Defined in unused-dependency-detector.ts:31
Parameters:
| Name | Type |
|---|---|
options? | Partial‹UnusedDependencyDetectorOptions› |
Returns: UnusedDependencyDetector
# Properties
# Private _exclude
• _exclude: Set‹string›
Defined in unused-dependency-detector.ts:31
# Private Optional options
• options? : Partial‹UnusedDependencyDetectorOptions›
Defined in unused-dependency-detector.ts:33
# Accessors
# name
• get name(): string
Defined in unused-dependency-detector.ts:37
Returns: string
# Methods
# check
▸ check(files: FileContext[]): Promise‹Result[]›
Defined in unused-dependency-detector.ts:41
Parameters:
| Name | Type |
|---|---|
files | FileContext[] |
Returns: Promise‹Result[]›
# checkPackageImports
▸ checkPackageImports(packageImports: string[][], files: FileContext[]): Result[]
Defined in unused-dependency-detector.ts:61
Parameters:
| Name | Type |
|---|---|
packageImports | string[][] |
files | FileContext[] |
Returns: Result[]
# getFilePackageImports
▸ getFilePackageImports(sourceFile: SourceFile): string[]
Defined in unused-dependency-detector.ts:48
Parameters:
| Name | Type |
|---|---|
sourceFile | SourceFile |
Returns: string[]
# Private getPackageNameFromImportPath
▸ getPackageNameFromImportPath(path: string): string
Defined in unused-dependency-detector.ts:119
Parameters:
| Name | Type |
|---|---|
path | string |
Returns: string
# Private getPathFromNode
▸ getPathFromNode(n: ImportDeclaration): string
Defined in unused-dependency-detector.ts:105
Parameters:
| Name | Type |
|---|---|
n | ImportDeclaration |
Returns: string
# Private initializeDependencyCounts
▸ initializeDependencyCounts(files: FileContext[]): object
Defined in unused-dependency-detector.ts:126
Parameters:
| Name | Type |
|---|---|
files | FileContext[] |
Returns: object
dependencies: DependencyCount
devDependencies: DependencyCount
# Private isExcluded
▸ isExcluded(dep: string): boolean
Defined in unused-dependency-detector.ts:113
Parameters:
| Name | Type |
|---|---|
dep | string |
Returns: boolean