readSfdxProject
readSfdxProject(
projectDir?):Promise<SfdxProject>
Defined in: packages/simply-core/src/project/sfdxProject.ts:80
Read and parse a Salesforce DX project manifest.
Validates only that packageDirectories is present and an array — the one invariant every
caller depends on. Anything beyond that is left to the caller, since each reads a different
subset and treats a missing value differently (some default, some throw).
Parameters
Section titled “Parameters”projectDir?
Section titled “projectDir?”string = ...
Directory containing sfdx-project.json. Defaults to the current
working directory, matching how these commands run inside a CI job’s checkout.
Returns
Section titled “Returns”Promise<SfdxProject>
The parsed project manifest.
Throws
Section titled “Throws”If the file can’t be read — code is 'ENOENT' when it’s
simply absent, which callers treating a missing project as non-fatal can check for.
Throws
Section titled “Throws”If the file isn’t valid JSON.
Throws
Section titled “Throws”If packageDirectories is missing or isn’t an array.