Request: Improvement to README

[sunwukonga]

Request: Improvement to README

[sunwukonga]

Actually, for some reason, I cannot get either of

import { Machine, make } from jssm;

or

var jssm = require('jssm');

to work. Machine, make, and jssm respectively are undefined.

[sunwukonga]

Even with:

import * as jssm from 'jssm';
console.log(jssm);  // { default: {} }

[sunwukonga]

I've used the interactive demo at jssm/src/demo/index.html and manipulated a SM through the console. Yet, I still don't see how to use this library in NodeJS.

[sunwukonga]

I've looked at the tests in src/js/tests and the import in those files is:

const jssm = require('../../../build/jssm.es5.js'),
         sm   = jssm.sm;

and obviously works, but this file is not available in the NPM package, and I've used:

const jssm = require('./node_modules/jssm/dist/jssm.es5.cjs.js'),
         sm   = jssm.sm;

as a substitute, but no cookie.The complaint being that sm is not a function, which it is not, it's a property.

[sunwukonga]

Tried this again this weekend, and managed to get it working in NodeJS. Seems a bit hacky, but I can now turn a DSL into a fsm.

Install for the project:
npm -i jssm --save

Go to the jssm directory in node_modules:
cd node_modules/jssm

Install dependencies of jssm:
npm install

Then run the make script:
npm run-script make

Now we have a build directory with the file jssm.es5.js and we can import the appropriate functions (or at least I can because I'm using babel to translate imports, otherwise you'd use a require):
import { sm, Machine, make } from './node_modules/jssm/build/jssm.es5';

We can then do something like this:

import fs from 'fs';
fs.readFile('./my.fsl', 'utf8', function(err, planString) {
  let myExampleFSM = new Machine( make( planString ) );
  console.log(myExampleFSM.state());  // check initial state
  myExampleFSM.action('proceed');  // assuming your fsl has a 'proceed' transition
  console.log(myExampleFSM.state());  // check the result of the action
}

Note that the shorter way:
let myExampleFSM = sm( planString );
doesn't work for me because there's an error TypeError: template_strings.reduce is not a functionin return new Machine(make(template_strings.reduce(...

[sunwukonga]

The reason why sm( planString ) isn't working for me is because I was trying to pass in a String when it's expecting an array of Strings. Whatever, sm is aiming to achieve with arguments (currently a commented out arg into the sm function), I don't need it. new Machine( make( myDSL_string ) ) works fine.