SFDX javascript wrapper.
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
: Runsnpm 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
By default, there are 2 disabled git hooks. They're set up when you run the npm run semantic-release-prepare
script. They make sure:
- You follow a conventional commit message
- Your build is not gonna fail in Travis (or your CI server), since it's runned locally before
git push
This makes more sense in combination with automatic releases
Credits
Made with