Project

Index

Constructors

• constructor

Properties

• root

Methods

• createWorkspaceMetadata
• getPackage
• getWorkspaceGlobs
• getWorkspacePackagePaths
• getWorkspacePackages
• normalizeGlob

Constructors

constructor

• new Project(root?: PortablePath): Project

Properties

readonlyroot

root: Path

Methods

createWorkspaceMetadata

• createWorkspaceMetadata(jsonPath: PortablePath): WorkspaceMetadata

• Create a workspace metadata object composed of absolute file paths.

getPackage

• getPackage<T>(): T

• Return the contents of the root package.json.

  ---

  Type parameters

  • T: PackageStructure

getWorkspaceGlobs

• getWorkspaceGlobs(options?: ProjectSearchOptions): string[]

• Return a list of all workspace globs as they are configured in package.json or lerna.json. Glob patterns will always use forward slashes, regardless of OS.

getWorkspacePackagePaths

• getWorkspacePackagePaths(options?: ProjectSearchOptions): Path[]

• Return a list of all workspace package paths, resolved against the file system. Absolute file paths are returned unless the relative option is true.

getWorkspacePackages

• getWorkspacePackages<T>(): WorkspacePackage<T>[]

• Return all package.jsons across all workspaces and their packages. Once loaded, append workspace path metadata.

  ---

  Type parameters

  • T: PackageStructure

staticnormalizeGlob

• normalizeGlob(pattern: string): string

• Normalize a glob pattern or path for use on POSIX and Windows machines.

  @link

  https://github.com/mrmlnc/fast-glob#how-to-write-patterns-on-windows