A gulp library for salesforce and force.com development. Designed to help force.com developers to work using the benefits of gulp and a folder structure when developing.

See: (https://github.com/jkentjnr/sfdc-gulp-travisci-boilerplate) for a boilplate solution.

npm install gulp-force-developer --save-dev

Once the plugin has been installed, it may be enabled inside your Gulpfile with this line of JavaScript:

var gulp = require('gulp'),
  gutil = require('gulp-util');

require('./gulp-force-developer').registerForGulp(gulp, gutil);

Using gulp and the gulp-force-developer tasks, developers for salesforce & force.com can:

• Manage their projects / packages in any folder structure they like.
• Integrate the full suite of gulp tasks into their deployment process.
• Ensure only new & modified code is published as part of each deployment / build. This enables a developer to code using any IDE, pushing changes via gulp.

To use gulp-force-developer as quickly as possible, we recommend starting with the gulpfile.js in examples.

Traditionally, when a developer is developing for salesforce / force.com, they are constrained by the mandated package structure. This structure is extremely limiting and, as the size of projects / packages grow, raplidly becomes unwieldy.

package.xml
== classes
    -- PaymentController.cls
    -- PaymentController.cls-meta.xml
    -- UserManagement.cls
    -- UserManagement.cls-meta.xml
== pages
    -- Payment.page
    -- Payment.page-meta.xml
    -- UserManagement.page
    -- UserManagement.page-meta.xml
== objects
    -- Payment__c.object

Using gulp-force-developer, a developer can adopt a fully dynamic file structure that operates independent of the prescribed salesforce package structure. The below example is a snippet from a developer managing their package in structure with little constraints, appropriate for their project.

== .metadata
    -- Payment.page-meta.xml
    -- PaymentController.cls-meta.xml
    -- UserManagement.page-meta.xml
    -- UserManagementController.cls-meta.xml
== Admin
   == Users
      -- UserManagementController.cls
      -- UserManagement.page
== Payments
    -- PaymentController.cls
    -- Payment.page
    -- Payment__c.object

To register the gulp tasks, you must use:

require('gulp-force-developer').registerForGulp(gulp, gutil);

Loads the options from the package.json

Deletes the file used to track changes between force-commit calls

Packages files that have changed since the previous force-commit call

Packages files all files

Generates the output from the force-package and force-package-all calls as a zip, ready for deployment

Updates the track changes file to refect the current state

Mocks resources from the package.json file. This is required when completing checkOnly tests that have Visualforce pages bound to resources.

TODO: Add support for options from the gulpfile.

To change any configuration, you must alter your project's package.json file.

{
  "name": "salesforce project",
  "version": "1.0.0",
  "description": "",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "author": "",
  "license": "MIT",
  "forceDeveloperConfig": {
    "projectBaseDirectory": "src"
  }
}

In your project's gulpfile, register the tasks with gulp and extend as appropriate.

var salesforcePackageFile = './.package/package.zip',
    username = '[email protected]',
    password ='password',
    token = 'Qr1ScFquCn1uT0YO6ywUj5je';

// ----------------------------------------------------------------

var gulp = require('gulp'),
  gutil = require('gulp-util'),
  forceDeploy = require('gulp-jsforce-deploy');

require('gulp-force-developer').registerForGulp(gulp, gutil);

// ----------------------------------------------------------------
// REGISTER GULP TASKS

gulp.task('deploy', function(done) {
  
  return gulp.src(salesforcePackageFile)
      .pipe(forceDeploy({
        username: username,
        password: password + token,
        pollInterval: 5*1000 
        //, loginUrl: 'https://test.salesforce.com' 
        //, pollTimeout: 120*1000 
        //, version: '33.0' 
      }));
      
});

gulp.task('default', gulp.series(
  'force-package-config',
  'force-package',
  'force-zip',
  'deploy',
  'force-commit'
));

To override any defaults, you need to modify your project's package.json.

Type: String Default value: '.force-developer.filehash.json'

Persists the file hashes to determine modified and new files.

Type: String Default value: 'app-metadata'

The folder used to store all '-meta.xml' files for the project. A corresponding file is required for all pages, components, trigger and classes. If the projectBaseDirectory isn't altered, the default location is ./project/app-metadata.

Type: String Default value: 'project'

Used to determine the root of the project folder.

Type: String Default value: '.package'

The folder used when the files are copied from the project folder into a salesforce package-compliant folder structure.

Type: String Default value: './.package/package.zip'

The location where the zipped package is to be stored.

Type: Integer Default value: 34

The api version to be used by the library. Used when creating on-demand meta-xml files.

Type: Array (String) Default value: []

A list of resource names required to be mocked so a test deployment can be completed successfully.

All contributions welcome!

• 0.1.10
  • Added resource mocking support
• 0.1.3
  • Documentation updates.
• 0.1.0
  • Inital release.