Slush-angular-webpack NPM

angular webpack

npm.io npm.io

An Angular Webpack Scaffold with a focus on deployment within a Salesforce environment. The default template contains a basic hello world example of Angular Formly in a nested directive. Future versions will have a more generic template with forms being a selectable option.

Installation

Install slush-angular-webpack globally (must have slush installed globally):

npm install -g slush-angular-webpack

Usage

The Non-Salesforce path:

From within your new project directory create and navigate to a new source folder:

mkdir src && cd src

Next run:

slush angular-webpack

The generator will then ask you to enter the project ( A VisualForce page will only be created for SF projects ).

*Currently only alphanumeric characters and single underscores after the first character are allowed. Any other characters will cause the build to fail.

What would you like to name your project or VisualForce page?

Followed by:

Is this a Salesforce project? (Y/n) n

That is all it takes. The generator will build the project inside of a new folder with the name you entered.

The Salesforce path:

Using this generator for a Salesforce build makes a few assumptions about the other tools you use in your workflow.

It is recommend that you use Sublime Text 3 with the MavensMate plugin to connect to your Org and pull down the existing project code from the server. See Mavens Mate for more info on this process.

Once this is complete and a local version of the project exists, navigate to the project directory. You will notice that there is an existing src/ directory in the project containing Salesforce's Visualforce pages, Classes, Triggers and more.

To avoid a conflict with this src/ directory create and then navigate to a new pack/ folder on the same level.

mkdir pack && cd pack

From this point you can either use the generator without having your Salesforce credentials pre-configured or you can create a simple config file in the pack/ directory and add your credentials. If you proceed without the config file present the generator will ask additional questions and require the entry of your username, password and token for a one time use.

The recommended path is to simply create your config file and add your credentials.

From the pack/ directory run:

touch jsforce.config.js

In the editor of your choice add you credentials in this pattern:

module.exports = {

    username: 'USERNAME',
    password: 'PASSWORD',
    token: 'TOKEN'

};

Now run:

slush angular-webpack

The generator will then ask you to enter the project ( A VisualForce page will only be created for SF projects ).

What would you like to name your project or VisualForce page?

Followed by:

Is this a Salesforce project? (Y/n) y

The generator will then create your new Visualforce page and the corresponding Static Resource on your remote Salesforce Org. Then it will build the project inside of a new folder with the app name you entered.

Development Build/Deploy

The Non-Salesforce path:

From within your new project directory run:

webpack

Then run:

webpack-dev-server --progress --colors

or you can run the shortcut:

npm start

This will start a server at localhost:8080/app

The Salesforce path:

The simplest way to deploy your changes to your Org is to run the following command one time per dev session.

npm run-script sf-auto-build-deploy

The script will start a watch process within webpack and on successful build the changes will deployed to current Org.

If you prefer more control in your deployment process you will need to manually set up your resource bundle in your MavenMate project.

At this point you should have a new project folder that lives inside of the pack/ directory and newly created remote assets. To bring your local project in sync: (From Sublime Text/Maven's Mate)

right-click on project root > MavensMate >Refresh From Server

This will pull down the new Visualforce page and Static Resource to your local project.

Finally create a resource bundle through MavensMate:

('command/control' + shift + p) to open Sublime's smart search and begin to type: Create Resource Bundle

Select this option and then pick the name of your newly created Static Resource by pressing enter.

This will add a resource-bundles/ folder to your Salesforce project containing the expanded version of your static resource.

From this point on you can the run the command below to auto build on save.

npm run-script sf-auto-build

This will use Webpack to watch for changes and build your bundle.js file and place it within the expanded static resource folder within the resource-bundles/ directory.

To deploy to your Salesforce org for testing open your new static resource. You may notice a placeholder/ folder along with the bundle.js and bundle.js.map. Delete the placeholder/ folder.

Then using Sublime/MavensMate enter:

('command/control' + shift + p) to open Sublime's smart search and begin to type: Deploy Resource Bundle

Select this option and then pick the name of your newly created resource bundle by pressing enter.

MavensMate will then compress the resource bundle and deploy it as your updated static resource.

You can now open your new Visualforce page and see your changes.

Production Build/Deploy

Coming soon with a Salesforce and non-Salesforce Config option...

Structure

pack***/
- jsforce.config.js****
- UserDefinedAppName/
  - karma.conf.js
  - package.json
  - webpack.config.js
  - webpack.config.js
  - webpack.salesforce.js
  - webpack.salesforce.deploy.js
  - node_modules/
  - app/
    - index.html
    - index.js
    - components/
      - form/
        index.js
        previewForm.js
        previewForm.less
        previewForm.html
      - navBar/
        index.js
        navbar.js
        navbar.less
        navbar.html
        navbar.test.js
      - simpleTest/
        index.js
        simpleTest.js
        simpleTest.less
        simpleTest.html
        simpleTest.test.js
    - states/
      - main/
        index.js
        main.js
        main.html
        main.less