Salesforce source-deploy-retrieve

Typescript Library to support the Salesforce extensions for VS Code.

Note: This library is in beta and has been released early so we can collect feedback. It may contain bugs, undergo major changes, or be discontinued.

Development

Clone the project and cd into it. Ensure you have Yarn installed and run the following to build:

yarn build

To test the library in another local module, you can link it to such module so any changes that are built will be automatically present without reinstalling:

yarn local:link /path/to/other/project

to unlink the library:

yarn local:unlink /path/to/other/project

Testing

Running the test suite

yarn test runs the suite and outputs code coverage as a text summary

When running tests, code changes don't need to be built with yarn build first since the test suite uses ts-node as its runtime environment. Otherwise, you should run yarn build before manually testing changes.

Testing with the NPM artifact

The library can also be installed to another local project as a regular NPM module. This is useful for manually testing the package that will be deployed to NPM. Use this instead of the linking process that's described under Development to QA changes before they are published:

yarn local:install /path/to/other/package