Class: CrossPackageDependencyDetector

@boll/rules-typescript › Globals › CrossPackageDependencyDetector

Class: CrossPackageDependencyDetector

CrossPackageDependencyDetector will detect usages of files stored directly in other packages that happen to be in a known location on disk.

Instead of referencing these files via file path, they should be referenced through their package name. (eg import { Foo } from "@company/package" instead of import Foo from '../../the-package/foo')

Hierarchy

• CrossPackageDependencyDetector

Implements

• PackageRule

Index

Accessors

• name

Methods

• check
• checkImportPaths
• getFileImports
• getPathFromNode

Accessors

name

• get name(): string

Defined in cross-package-dependency-detector.ts:27

Returns: string

Methods

check

▸ check(file: FileContext): Promise‹Result[]›

Defined in cross-package-dependency-detector.ts:31

Parameters:

Returns: Promise‹Result[]›

checkImportPaths

▸ checkImportPaths(packageRoot: BollDirectory, sourceFilePath: BollFile, importPaths: ImportPathAndLineNumber[]): Result[]

Defined in cross-package-dependency-detector.ts:52

Parameters:

Returns: Result[]

getFileImports

▸ getFileImports(sourceFile: SourceFile): ImportPathAndLineNumber[]

Defined in cross-package-dependency-detector.ts:36

Parameters:

Returns: ImportPathAndLineNumber[]

Private getPathFromNode

▸ getPathFromNode(n: ImportDeclaration): string

Defined in cross-package-dependency-detector.ts:76

Parameters:

Returns: string