sfdx-generator
v5.0.0
Published
A node wrapper for Salesforce DX
Downloads
5
Readme
SFDX javascript wrapper.
A typescript tool that generates SFDX wrappers
Usage
const sfdxGenerator = require('../compiled/sfdx-generator.js');
const path = require('path');
const root = path.resolve(__dirname, './..');
// Using sfdx from dev dependencies instead of global;
const sfdxPath = path.resolve(root, './node_modules/.bin/sfdx.cmd');
const generator = new sfdxGenerator.Generator({
SFDXPath: 'sfdx',
outputDirectory: path.resolve(root, './generated'),
templateDirectory: path.resolve(root, './templatesExample'),
fileExtension: '.ts'
});
// Generate files using sfdx output.
generator.generate().then(() => {
console.log('Generating done');
});
Documentation
Read our doc here: https://coveo.github.io/sfdx-generator/
dev scripts
npm start
: Runsnpm run build
in watch mode.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 :wink:).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 :nail_care:
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 :heart: