Class SfProject

Represents an SFDX project directory. This directory contains a SfProjectJson config file as well as a hidden .sfdx folder that contains all the other local project config files.

const project = await SfProject.resolve();
const projectJson = await project.resolveProjectConfig();
console.log(projectJson.sfdcLoginUrl);

Methods

findPackage getActivePackage getAliasesFromPackageId getDefaultPackage getPackage getPackageAliases getPackageDirectories getPackageFromPath getPackageIdFromAlias getPackageNameFromPath getPackagePath getPath getPluginConfiguration getSfProjectJson getUniquePackageDirectories getUniquePackageNames hasMultiplePackages hasPackageAliases hasPackages resolveProjectConfig retrieveSfProjectJson setActivePackage setPluginConfiguration clearInstances getInstance resolve resolveProjectPath resolveProjectPathSync

Methods

findPackage

getActivePackage

  • getActivePackage(): Nullable<NamedPackageDir>

  • Get the currently activated package on the project. This has no implication on sfdx-project.json but is useful for keeping track of package and source specific options in a process.

    Returns Nullable<NamedPackageDir>

getAliasesFromPackageId

  • getAliasesFromPackageId(id): string[]

  • Parameters

    • id: string

    Returns string[]

getDefaultPackage

  • getDefaultPackage(): NamedPackageDir

  • Get the project's default package directory defined in sfdx-project.json using first 'default: true' found. The first entry is returned if no default is specified.

    Returns NamedPackageDir

getPackage

getPackageAliases

  • getPackageAliases(): Nullable<Dictionary<string>>

  • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

    Returns Nullable<Dictionary<string>>

getPackageDirectories

  • getPackageDirectories(): NamedPackageDir[]

  • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

    Returns NamedPackageDir[]

getPackageFromPath

  • getPackageFromPath(path): Optional<NamedPackageDir>

  • Returns the package from a file path.

    Parameters

    • path: string

      A file path. E.g. /Users/jsmith/projects/ebikes-lwc/force-app/apex/my-cls.cls

    Returns Optional<NamedPackageDir>

getPackageIdFromAlias

  • getPackageIdFromAlias(alias): Optional<string>

  • Parameters

    • alias: string

    Returns Optional<string>

getPackageNameFromPath

  • getPackageNameFromPath(path): Optional<string>

  • Returns the package name, E.g. 'force-app', from a file path.

    Parameters

    • path: string

      A file path. E.g. /Users/jsmith/projects/ebikes-lwc/force-app/apex/my-cls.cls

    Returns Optional<string>

getPackagePath

  • getPackagePath(packageName): Optional<string>

  • Returns the absolute path of the package directory ending with the path separator. E.g., /Users/jsmith/projects/ebikes-lwc/force-app/

    Parameters

    • packageName: string

      Name of the package directory. E.g., 'force-app'

    Returns Optional<string>

getPath

getPluginConfiguration

  • getPluginConfiguration<T>(pluginName): Promise<Readonly<T>>

  • retrieve the configuration for a named plugin from sfdx-project.json.plugins.pluginName

    Type Parameters

    • T extends Record<string, unknown>

    Parameters

    • pluginName: string

    Returns Promise<Readonly<T>>

    Example

    const project = await SfProject.resolve();
    const pluginConfig = await project.getPluginConfiguration('myPlugin');

    optionally pass a type parameter for your plugin configuration's schema

getSfProjectJson

  • getSfProjectJson(isGlobal?): SfProjectJson

  • Get the sfdx-project.json config. The global sfdx-project.json is used for user defaults that are not checked in to the project specific file.

    Note: When reading values from SfProjectJson, it is recommended to use SfProject.resolveProjectConfig instead.

    This is the sync method of SfProject.resolveSfProjectJson

    Parameters

    • isGlobal: boolean = false

      True to get the global project file, otherwise the local project config.

    Returns SfProjectJson

getUniquePackageDirectories

  • getUniquePackageDirectories(): NamedPackageDir[]

  • Returns a read-only list of packageDirectories within sfdx-project.json, first reading and validating the file if necessary. i.e. modifying this array will not affect the sfdx-project.json file.

    There can be multiple packages in packageDirectories that point to the same directory. This method only returns one packageDirectory entry per unique directory path. This is useful when doing source operations based on directories but probably not as useful for packaging operations that want to do something for each package entry.

    Returns NamedPackageDir[]

getUniquePackageNames

hasMultiplePackages

  • hasMultiplePackages(): boolean

  • Has multiple package directories (MPD) defined in the project.

    Returns boolean

hasPackageAliases

hasPackages

  • hasPackages(): boolean

  • Has package directories defined in the project.

    Returns boolean

resolveProjectConfig

  • resolveProjectConfig(): Promise<JsonMap>

  • The project config is resolved from local and global SfProjectJson, ConfigAggregator, and a set of defaults. It is recommended to use this when reading values from SfProjectJson.

    The global SfProjectJson is used to allow the user to provide default values they may not want checked into their project's source.

    Returns Promise<JsonMap>

    A resolved config object that contains a bunch of different properties, including some 3rd party custom properties.

retrieveSfProjectJson

  • retrieveSfProjectJson(isGlobal?): Promise<SfProjectJson>

  • Get the sfdx-project.json config. The global sfdx-project.json is used for user defaults that are not checked in to the project specific file.

    Note: When reading values from SfProjectJson, it is recommended to use SfProject.resolveProjectConfig instead.

    Parameters

    • isGlobal: boolean = false

      True to get the global project file, otherwise the local project config.

    Returns Promise<SfProjectJson>

setActivePackage

  • setActivePackage(packageName): void

  • Set the currently activated package on the project. This has no implication on sfdx-project.json but is useful for keeping track of package and source specific options in a process.

    Parameters

    • packageName: Nullable<string>

      The package name to activate. E.g. 'force-app'

    Returns void

setPluginConfiguration

  • setPluginConfiguration<T>(pluginName, config): Promise<void>

  • set the configuration for a named plugin from sfdx-project.json.plugins.pluginName, overwriting existing configuration

    Type Parameters

    • T extends Record<string, unknown>

    Parameters

    • pluginName: string
    • config: T

    Returns Promise<void>

    Example

    const project = await SfProject.resolve();
    const pluginConfig = await project.setPluginConfiguration('myPlugin', {foo: 'bar', myLimit: 25});

    optionally pass a type parameter for your plugin configuration's schema

Static clearInstances

  • clearInstances(): void

  • Clear the cache to force reading from disk.

    NOTE: Only call this method if you must and you know what you are doing.

    Returns void

Static getInstance

  • getInstance(path?): SfProject

  • Get a Project from a given path or from the working directory.

    Parameters

    • Optional path: string

      The path of the project.

      Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

    Returns SfProject

Static resolve

  • resolve(path?): Promise<SfProject>

  • Get a Project from a given path or from the working directory.

    Parameters

    • Optional path: string

      The path of the project.

      Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

    Returns Promise<SfProject>

Static resolveProjectPath

  • resolveProjectPath(dir?): Promise<string>

  • Performs an upward directory search for an sfdx project file. Returns the absolute path to the project.

    Parameters

    • Optional dir: string

      The directory path to start traversing from.

      Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

      See traverseForFile

      See process.cwd()

    Returns Promise<string>

Static resolveProjectPathSync

  • resolveProjectPathSync(dir?): string

  • Performs a synchronous upward directory search for an sfdx project file. Returns the absolute path to the project.

    Parameters

    • Optional dir: string

      The directory path to start traversing from.

      Throws SfError{ name: 'InvalidProjectWorkspaceError' } If the current folder is not located in a workspace.

      See traverseForFileSync

      See process.cwd()

    Returns string

Settings

Member Visibility

Theme

On This Page

findPackagegetActivePackagegetAliasesFromPackageIdgetDefaultPackagegetPackagegetPackageAliasesgetPackageDirectoriesgetPackageFromPathgetPackageIdFromAliasgetPackageNameFromPathgetPackagePathgetPathgetPluginConfigurationgetSfProjectJsongetUniquePackageDirectoriesgetUniquePackageNameshasMultiplePackageshasPackageAliaseshasPackagesresolveProjectConfigretrieveSfProjectJsonsetActivePackagesetPluginConfigurationclearInstancesgetInstanceresolveresolveProjectPathresolveProjectPathSync