A TypeScript compatible JavaScript wrapper for Salesforce DX CLI.
Clone or download
louis-bompart Merge pull request #29 from coveo/greenkeeper/typedoc-0.13.0
Update typedoc to the latest version 🚀
Latest commit 29c478f Oct 16, 2018

README.md

SFDX javascript wrapper.

styled with prettier Greenkeeper badge Travis Coveralls Dev Dependencies

A TypeScript compatible JavaScript wrapper for Salesforce DX CLI.

Usage

   const sfdx = require('sfdx-js').Client.createUsingPath('sfdx')
   sfdx.auth.webLogin().then(function() {
     console.log('done!');
   })

Documentation

Read our doc here: https://coveo.github.io/sfdx-js/

dev scripts

  • npm t: Run test suite.
  • npm start: Runs npm run build in watch mode.
  • npm run test:watch: Run test suite in interactive watch mode.
  • npm run test:prod: Run linting and generate coverage.
  • npm run build: Generage bundles and typings, create docs.
  • npm run lint: Lints code.
  • npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't 😉).
  • npm run generate: Generate wrapper classes using the SFDX executable in path.

Git Hooks

There is already set a precommit hook for formatting your code with Prettier 💅

There are 2 Git hooks, they make sure that:

This makes more sense in combination with automatic releases.

Credits

Made with ❤️