Skip to content

DEVELOPING.md

Latest commit

 

History

History
119 lines (82 loc) · 5.07 KB

DEVELOPING.md

File metadata and controls

119 lines (82 loc) · 5.07 KB

Developing

Table of Contents

Environment Setup
Development Cycle
Testing
• Unit Tests
• NUTs (Non-Unit Tests)
Debugging
Running Commands
Useful Yarn Commands

Environment Setup

  1. Install NodeJS. If you need to work with multiple versions of Node, consider using nvm.
  2. Install yarn v1 to manage node dependencies.
    • Suggestion: install yarn globally using npm install --global yarn
  3. Clone this repository from Github.
    • External contributors must fork the main branch of the repo
    • Internal committers can clone the main branch directly.
  4. Configure git commit signing.

Development Cycle

  1. cd into the plugin-bre-to-cml directory
  2. Checkout the main branch: git checkout main
  3. Get all latest changes: git pull
  4. Install NPM dependencies: yarn install.
    • If it's been a while since you last did this you may want to run yarn clean-all before this step.
  5. Build and lint the code: yarn build
  6. Create a branch off main for new work: git checkout -b <branch_name>
    • Suggestion: Use branch name format of <initials>/<work-title>.
      • Example: mb/refactor-tests
  7. Make code changes and build: yarn build
  8. Run changed commands: e.g., ./bin/run.js my-topic my-command
  9. Write tests and run: yarn test (unit) and/or yarn test:nuts (NUTS)
  10. Show all changed files: git status
  11. Add all files to staging: git add .
  12. Commit staged files with helpful commit message: git commit
    • Important: We use conventional commits to drive semver versioning. Examples:
      • chore: my chore message --> No release
      • fix: my fix message --> Patch release
      • feat: my feat message --> Minor release
  13. Push commit(s) to remote: git push -u origin <branch_name>
  14. Create a pull request (PR) using the GitHub UI here.

Testing

All changes must have associated tests. This library uses a combination of unit testing and NUTs (non-unit tests).

Unit tests

Unit tests are run with yarn test and use the mocha test framework. Tests are located in the test directory and are named with the pattern, test/commands/my-topic/my-command/<test-file>.test.ts. Notice that the directory structure is similar to the commands in the src directory. Use existing unit tests as a guide when writing and testing code changes.

NUTs (non-unit tests)

Non-unit tests are run with yarn test:nuts and use the cli-plugin-testkit framework. These tests run using the default devhub in your environment. NUTs are a way to test the library code in a real environment versus a unit test environment where many things are stubbed.

Debugging

If you need to debug plugin code or tests you should refer to the excellent documentation on this topic in the Plugin Developer Guide.

Running Commands

To run your modified plugin commands locally, use ./bin/run.js or ./bin/run.cmd (Windows). Note that you must compile any code changes (yarn build) before seeing those changes with ./bin/run.js. You can also use yarn build --watch to auto-build files when saved.

# Run using local script.
./bin/run.js my-topic my-command

There should be no differences when running via the Salesforce CLI or using the local bin scripts. However, it can be useful to link the plugin to the CLI to do some additional testing or run your commands from anywhere on your machine.

# Link your plugin to the sf cli
sf plugins link .
# To verify
sf plugins
# To run
sf my-topic my-command

Useful yarn commands

yarn install

This downloads all NPM dependencies into the node_modules directory.

yarn compile

This compiles the typescript to javascript.

yarn compile --watch

This watches for file changes and compiles the typescript to javascript.

yarn lint

This lints all the typescript using eslint.

yarn build

This compiles and lints all the typescript (e.g., yarn compile && yarn lint).

yarn clean

This cleans all generated files and directories. Run yarn clean-all to also clean up the node_modules directories.

yarn test

This runs unit tests (mocha) for the project using ts-node.

yarn test:nuts

This runs NUTs (non-unit tests) for the project using ts-node.