Many of the packages in the SFDX-Falcon Library are dependent on one another. Understanding the precedence of each is critical to avoid creating circular dependencies between packages at build-time.
Each package folder contains two key files that must be properly crafted and maintained: package.json and tsconfig.build.json.
Maintaining package.json is easy. If you need a dependency, just add it to the dependencies or devDependencies hash. This is typically done by adding dependencies in alphabetical order.
Maintaining tsconfig.build.json is trickier. The array of path values in the references hash must be defined in the proper order with dependent packages always listed after any packages on which they depend.
To help ensure correct precedence, here is a list of SFDX-Falcon packages in order of dependence.
- Independent Siblings
@sfdx-falcon/debug@sfdx-falcon/types
@sfdx-falcon/error@sfdx-falcon/validator@sfdx-falcon/status- Independent Siblings
@sfdx-falcon/builder@sfdx-falcon/command@sfdx-falcon/util@sfdx-falcon/worker
- Independent Siblings
@sfdx-falcon/prompt@sfdx-falcon/task
@sfdx-falcon/environment- Independent Siblings
@sfdx-falcon/interview@sfdx-falcon/task-bundle
@sfdx-falcon/builder-library@sfdx-falcon/generator
Master list of all direct external dependencies used by packages in the SFDX-Falcon library.
| Dependency | License | Package | Code Repository |
|---|---|---|---|
"@oclif/command": "1.7.0" |
MIT | @oclif/command | GitHub |
"@oclif/config": "1.16.0" |
MIT | @oclif/config | GitHub |
"@oclif/dev-cli": "1.22.2" |
MIT | @oclif/dev-cli | GitHub |
"@oclif/errors": "1.3.3" |
MIT | @oclif/errors | GitHub |
"@oclif/parser": "3.8.5" |
MIT | @oclif/parser | GitHub |
"@oclif/plugin-help": "3.1.0" |
MIT | @oclif/plugin-help | GitHub |
"@oclif/test": "1.2.6" |
MIT | @oclif/test | GitHub |
"@salesforce/command": "3.0.1" |
BSD-3-Clause | @salesforce/command | GitHub |
"@salesforce/core": "2.7.0" |
BSD-3-Clause | @salesforce/core | GitHub |
"@salesforce/dev-config": "1.6.0" |
BSD-3-Clause | @salesforce/dev-config | GitHub |
"@salesforce/ts-types": "1.3.0" |
BSD-3-Clause | @salesforce/ts-types | GitHub |
"@types/chai": "4.2.11" |
MIT | @types/chai | GitHub |
"@types/fs-extra": "8.0.1" |
MIT | @types/fs-extra | GitHub |
"@types/inquirer": "6.5.0" |
MIT | @types/inquirer | GitHub |
"@types/jsforce": "1.9.11" |
MIT | @types/jsforce | GitHub |
"@types/json2csv": "4.5.0" |
MIT | @types/json2csv | GitHub |
"@types/listr": "0.14.2" |
MIT | @types/listr | GitHub |
"@types/lodash": "4.14.144" |
MIT | @types/lodash | GitHub |
"@types/mocha": "5.2.7" |
MIT | @types/mocha | GitHub |
"@types/node": "12.12.5" |
MIT | @types/node | GitHub |
"@types/unzipper": "0.10.0" |
MIT | @types/unzipper | GitHub |
"@types/shelljs": "0.8.6" |
MIT | @types/shelljs | GitHub |
"@types/yeoman-environment": "2.3.2" |
MIT | @types/yeoman-environment | GitHub |
"@types/yeoman-generator": "3.1.4" |
MIT | @types/yeoman-generator | GitHub |
"@types/yosay": "0.0.29" |
MIT | @types/yosay | GitHub |
"ansi-regex": "5.0.0" |
MIT | ansi-regex | GitHub |
"ansi-styles": "4.1.0" |
MIT | ansi-styles | GitHub |
"boxen": "4.1.0" |
MIT | boxen | GitHub |
"chai": "4.2.0" |
MIT | chai | GitHub |
"chalk": "2.4.2" |
MIT | chalk | GitHub |
"cli-boxes": "2.2.0" |
MIT | cli-boxes | GitHub |
"cross-spawn": "7.0.1" |
MIT | cross-spawn | GitHub |
"csv-parser": "2.3.1" |
MIT | csv-parser | GitHub |
"debug": "4.1.1" |
MIT | debug | GitHub |
"del": "5.1.0" |
MIT | del | GitHub |
"falcon-listr-update-renderer": "0.4.2" |
MIT | falcon-listr-update-renderer | GitHub |
"fs-extra": "8.1.0" |
MIT | fs-extra | GitHub |
"globby": "10.0.1" |
MIT | globby | GitHub |
"inquirer": "7.0.0" |
MIT | inquirer | GitHub |
"jsforce": "1.9.3" |
MIT | jsforce | GitHub |
"json2csv": "4.5.4" |
MIT | json2csv | GitHub |
"lerna": "3.18.3" |
MIT | lerna | GitHub |
"listr": "0.14.3" |
MIT | listr | GitHub |
"listr-silent-renderer": "1.1.1" |
MIT | listr-silent-renderer | GitHub |
"lodash": "4.17.15" |
MIT | lodash | GitHub |
"mocha": "6.2.2" |
MIT | mocha | GitHub |
"mocha-junit-reporter": "1.23.1" |
MIT | mocha-junit-reporter | GitHub |
"pad": "3.2.0" |
NO-SPDX-ID | pad | GitHub |
"pad-component": "0.0.1" |
NONE | pad-component | GitHub |
"nyc": "14.1.1" |
ISC | nyc | GitHub |
"rxjs": "6.5.3" |
Apache-2.0 | rxjs | GitHub |
"shelljs": "0.8.3" |
BSD-3-Clause | shelljs | GitHub |
"sinon": "7.5.0" |
BSD | sinon | GitHub |
"string-width": "4.1.0" |
MIT | string-width | GitHub |
"strip-ansi": "5.2.0" |
MIT | strip-ansi | GitHub |
"tslib": "1.10.0" |
Apache-2.0 | tslib | GitHub |
"ts-node": "8.4.1" |
MIT | ts-node | GitHub |
"typescript": "3.6.4" |
Apache-2.0 | typescript | GitHub |
"unzipper": "0.10.5" |
MIT | unzipper | GitHub |
"uuid": "3.3.3" |
MIT | uuid | GitHub |
"wrap-ansi": "6.1.0" |
MIT | wrap-ansi | GitHub |
"yeoman-environment": "2.6.0" |
BSD-2-Clause | yeoman-environment | GitHub |
"yeoman-generator": "4.2.0" |
BSD-2-Clause | yeoman-generator | GitHub |
"yosay": "2.0.2" |
BSD-2-Clause | yosay | GitHub |