ps-assessment v0.1.1

ps-assessment

Intended to be used in creating & validating a module's assessment question file for Pluralsight. Specifically you can do the following things with this package:

• create assessment questions pragmatically
• extract questions from a Pluralsight *.meta file format
• extract questions from marker objects within an Adobe XMPTM file generated by Adobe Premiere CC & Adobe Media Encoder CC
• validate the assessment file per Pluralsight's requirements
• create an assessment file (questions.txt / no-questions.txt) based on questions provided

NOTE: Rather than using traditional callbacks, promises are returned for async calls using the popular Q promise library.

Installation

Install using NPM:

$ npm install ps-assessment

Create Assessment Questions Programatically

var Assessment = require('ps-assessment');

var assessment = new Assessment();

assessment.questions.push({
    question: 'Q) Question number 1',
    answers: ['- answer 1', '- answer 2', '* answer 3'],
    clipNumber: 1,
    timeCode: '12:34'
});
assessment.questions.push({
    question: 'Q) Question number 2',
    answers: ['- answer 4', '- answer 5', '* answer 6'],
    clipNumber: 1,
    timeCode: '34:56'
});

Extract Questions from Pluralsight *.meta Format

var Assessment = require('ps-assessment');

var pathToMetaFile = path.join(sourcePath, 'questions.txt');

Assessment.loadQuestionsFromMetaFile(pathToMetaFile)
  .then(function (assessment) {
    assessment.questions.forEach(element){
      Console.log('question: ' + element.question);
      element.answers.forEach(answer){
        Console.log(' answer: ' + answer)
      };
      Console.log('clip #: ' + element.clipNumber);
    };  
  });

Extract Questions from Adobe XMPTM Metadata File

var Assessment = require('ps-assessment'),
    path = require('path');

var xmpFiles = [path.join(sourcePath, 'clip1.xmp'),
                        path.join(sourcePath, 'clip2.xmp')];

Assessment.loadQuestionsFromXmpFiles(xmpFiles)
  .then(function (assessment) {
    assessment.questions.forEach(element){
      Console.log('question: ' + element.question);
      element.answers.forEach(answer){
        Console.log(' answer: ' + answer)
      };
      Console.log('clip #: ' + element.clipNumber);
    };  
  });

Validate Assessment Questions

var Assessment = require('ps-assessment');

var assessment = new Assessment();

// add assessment questions via code or by loading

var results = assessment.validate();

if (results.length == 0){
  Console.log('all questions valid');
} else {
  Console.log('errors in assessment question file:');
  results.forEach(errorMessage){
    Console.log(' > ' + errorMessage);
  }
}

Create Assessment File

var Assessment = require('ps-assessment');

var buildPath = path.join(sourcePath, 'deliveryFolder');
var moduleNumber = 1;
var assessment = new Assessment();

assessment.questions.push({
    question: 'Q) Question number 1',
    answers: ['- answer 1', '- answer 2', '* answer 3'],
    clipNumber: 1,
    timeCode: '12:34'
});
assessment.questions.push({
    question: 'Q) Question number 2',
    answers: ['- answer 4', '- answer 5', '* answer 6'],
    clipNumber: 1,
    timeCode: '34:56'
});
// creates questions.txt or no-questions.txt depending if questions present in assessment
assessment.createAssessmentFile('foo-fundamentals', moduleNumber, buildPath)
  .then(function (filePath) {
    Console.log('assessment questions filepath: ' +filePath);
  });

See the tests for full usage.

Development

The package is written in TypeScript, however only the transpiled JavaScript is included in the NPM package. In TypeScript development, it's common to use a bunch of /// <reference path="" /> blocks and the TypeScript compiler generates a source map file that is included at the bottom of the generated JavaScript files. Prior to uploading this to NPM, I've removed these extra comments using a custom gulp task.

If you want to see the full source prior to the "scrubbing" done to prepare for publication to NPM, just get the entire source and run an included gulp task to compile everything.

The type definitions used in the source of this project were acquired from the DefinitelyTyped project. They are all saved in the tsd.json file and can be downloaded by running the following:

$ tsd reinstall -o