Skip to content

louis-bompart/sfdx-js

 
 

Repository files navigation

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 💅

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:

This makes more sense in combination with automatic releases.

Credits

Made with ❤️

About

A typescript compatible javascript wrapper for Salesforce DX cli.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 79.1%
  • HTML 13.2%
  • JavaScript 7.7%